Fix v2 with go.mod (zmap#398)

zmap#398

Adopt the **Major Subdirectory** approach from
https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher

### Effects:

* Moves all code into a `v2` subdirectory. Consumers of ZLint v2 will need to change their imports in go to `github.com/zmap/zlint/v2` and update `go.mod` accordingly.
* Old versions of ZLint are still fetchable via `go.mod` and version pinning, e.g. `require github.com/zmap/[email protected]`
* People using `go get` without modules are going to have all their code break. However, this was going to happen regardless of what we do with our directories because we made breaking changes to our code.

### Patching old versions

To patch an old version (pre-2.0), we would need to branch off of one of the old tags. To avoid this, we could attempt to maintain support for 1.1.0 by implementing another point release at the top-level directory on top of `v2`, and then exposing the old API's above the v2 directory (see https://github.com/rsc/quote/blob/master/quote.go as an example). However, I don't believe we plan on supporting old versions at all, so there's no reason to do this. On the off chance we do need to cut a point release for 1.1.0, we can use Git.

### Why not use the Major Branch approach

When not maintaining support for v1 side-by-side with v2, the major branch approach is identical to the Major Subdirectory approach from a Git standpoint---point release for v1 would need to be done on branches. However, it does then have the side effect that the import path for your code no longer matches the directory structure of your code. Effectively, we could `mv` all of the `v2` directory back up to the top-level, claim the name `...v2/`, and use `v2` in all of our import paths. While this might look cleaner from a Git repo standpoint, my gut sense is that we may as well match the directories to the import path, since that's slightly easier to grok.

.gitignore

@@ -114,13 +114,13 @@ _testmain.go
 0
 
 ### Build Targets ###
-/zlint
-cmd/zlint/zlint
-/zlint-gtld-update
-cmd/zlint-gtld-update/zlint-gtld-update
+v2/zlint
+v2/cmd/zlint/zlint
+v2/zlint-gtld-update
+v2/cmd/zlint-gtld-update/zlint-gtld-update
 
 ### Integration test data ###
-data
+v2/data
 
 ### Goreleaser builds ###
 dist

.goreleaser.yml

@@ -4,6 +4,7 @@ before:
  - go mod tidy
 builds:
  -
+ dir: v2
  main: ./cmd/zlint/main.go
  binary: zlint
  env:

.travis.yml

@@ -12,6 +12,7 @@ install:
 script:
  # Fast-fail on non-zero exit codes
  - set -e
+ - cd v2
  # Build commands
  - make
  # Verify that all files pass the golangci-lint code lints

README.md

@@ -75,7 +75,7 @@ command-line certificate parser that links against ZLint.
 
 Example ZLint CLI usage:
 
- go get github.com/zmap/zlint/cmd/zlint
+ go get github.com/zmap/zlint/v2/cmd/zlint
  echo "Lint mycert.pem with all applicable lints"
  zlint mycert.pem
 
@@ -100,7 +100,7 @@ lints is as simple as using `zlint.LintCertificate` with a parsed certificate:
 ```go
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint"
+ "github.com/zmap/zlint/v2"
 )
 
 var certDER []byte = ...
@@ -114,8 +114,8 @@ name) filter the global lint registry and use it with `zlint.LintCertificateEx`:
 ```go
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint"
- "github.com/zmap/zlint/lint"
+ "github.com/zmap/zlint/v2"
+ "github.com/zmap/zlint/v2/lint"
 )
 
 var certDER []byte = ...
@@ -129,7 +129,7 @@ zlintResultSet := zlint.LintCertificateEx(parsed, registry)
 
 See [the `zlint` command][zlint cmd]'s source code for an example.
 
-[zlint cmd]: https://github.com/zmap/zlint/blob/master/cmd/zlint/main.go
+[zlint cmd]: https://github.com/zmap/zlint/blob/master/v2/cmd/zlint/main.go
 
 
 Extending ZLint

benchmarks_test.go → v2/benchmarks_test.go

@@ -19,7 +19,7 @@ import (
  "testing"
 
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
+ "github.com/zmap/zlint/v2/lint"
 )
 
 var (

cmd/zlint-gtld-update/main.go → v2/cmd/zlint-gtld-update/main.go

@@ -30,7 +30,7 @@ import (
  "time"
 
  log "github.com/sirupsen/logrus"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/util"
 )
 
 const (

cmd/zlint/main.go → v2/cmd/zlint/main.go

@@ -29,8 +29,8 @@ import (
 
  log "github.com/sirupsen/logrus"
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint"
- "github.com/zmap/zlint/lint"
+ "github.com/zmap/zlint/v2"
+ "github.com/zmap/zlint/v2/lint"
 )
 
 var ( // flags

go.mod → v2/go.mod

@@ -1,4 +1,4 @@
-module github.com/zmap/zlint
+module github.com/zmap/zlint/v2
 
 require (
  github.com/sirupsen/logrus v1.3.0

integration/corpus_test.go → v2/integration/corpus_test.go

@@ -10,8 +10,8 @@ import (
  "sync"
  "testing"
 
- "github.com/zmap/zlint"
- "github.com/zmap/zlint/lint"
+ "github.com/zmap/zlint/v2"
+ "github.com/zmap/zlint/v2/lint"
 )
 
 // lintCertificate lints the provided work item's certificate to produce

integration/integration_test.go → v2/integration/integration_test.go

@@ -9,7 +9,7 @@ import (
  "regexp"
  "testing"
 
- "github.com/zmap/zlint/lint"
+ "github.com/zmap/zlint/v2/lint"
 )
 
 var (

integration/result.go → v2/integration/result.go

@@ -5,7 +5,7 @@ package integration
 import (
  "fmt"
 
- "github.com/zmap/zlint/lint"
+ "github.com/zmap/zlint/v2/lint"
 )
 
 type resultCount struct {

lint/base.go → v2/lint/base.go

@@ -18,7 +18,7 @@ import (
  "time"
 
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/util"
 )
 
 // LintInterface is implemented by each Lint.

lints/apple/lint_ct_sct_policy_count_unsatisfied.go → v2/lints/apple/lint_ct_sct_policy_count_unsatisfied.go

@@ -20,8 +20,8 @@ import (
 
  "github.com/zmap/zcrypto/x509"
  "github.com/zmap/zcrypto/x509/ct"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type sctPolicyCount struct{}

lints/apple/lint_ct_sct_policy_count_unsatisfied_test.go → v2/lints/apple/lint_ct_sct_policy_count_unsatisfied_test.go

@@ -17,8 +17,8 @@ package apple
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestSCTCountPolicyUnsatisified(t *testing.T) {

lints/cabf_br/lint_ca_common_name_missing.go → v2/lints/cabf_br/lint_ca_common_name_missing.go

@@ -16,8 +16,8 @@ package cabf_br
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type caCommonNameMissing struct{}

lints/cabf_br/lint_ca_common_name_missing_test.go → v2/lints/cabf_br/lint_ca_common_name_missing_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCaCommonNameMissing(t *testing.T) {

lints/cabf_br/lint_ca_country_name_invalid.go → v2/lints/cabf_br/lint_ca_country_name_invalid.go

@@ -16,8 +16,8 @@ package cabf_br
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 /************************************************

lints/cabf_br/lint_ca_country_name_invalid_test.go → v2/lints/cabf_br/lint_ca_country_name_invalid_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCaCountryNameInvalid(t *testing.T) {

lints/cabf_br/lint_ca_country_name_missing.go → v2/lints/cabf_br/lint_ca_country_name_missing.go

@@ -16,8 +16,8 @@ package cabf_br
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 /************************************************

lints/cabf_br/lint_ca_country_name_missing_test.go → v2/lints/cabf_br/lint_ca_country_name_missing_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 /************************************************

lints/cabf_br/lint_ca_crl_sign_not_set.go → v2/lints/cabf_br/lint_ca_crl_sign_not_set.go

@@ -16,8 +16,8 @@ package cabf_br
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 /************************************************

lints/cabf_br/lint_ca_crl_sign_not_set_test.go → v2/lints/cabf_br/lint_ca_crl_sign_not_set_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCaKeyUsageNoCRLSign(t *testing.T) {

lints/cabf_br/lint_ca_digital_signature_not_set.go → v2/lints/cabf_br/lint_ca_digital_signature_not_set.go

@@ -22,8 +22,8 @@ If the Root CA Private Key is used for signing OCSP responses, then the digitalS
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type caDigSignNotSet struct{}

lints/cabf_br/lint_ca_digital_signature_not_set_test.go → v2/lints/cabf_br/lint_ca_digital_signature_not_set_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCaKeyUsageNoDigSign(t *testing.T) {

lints/cabf_br/lint_ca_is_ca.go → v2/lints/cabf_br/lint_ca_is_ca.go

@@ -18,8 +18,8 @@ import (
  "encoding/asn1"
 
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type caIsCA struct{}

lints/cabf_br/lint_ca_is_ca_test.go → v2/lints/cabf_br/lint_ca_is_ca_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestKeyCertSignNotCA(t *testing.T) {

lints/cabf_br/lint_ca_key_cert_sign_not_set.go → v2/lints/cabf_br/lint_ca_key_cert_sign_not_set.go

@@ -22,8 +22,8 @@ If the Root CA Private Key is used for signing OCSP responses, then the digitalS
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type caKeyCertSignNotSet struct{}

lints/cabf_br/lint_ca_key_cert_sign_not_set_test.go → v2/lints/cabf_br/lint_ca_key_cert_sign_not_set_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCaKeyUsageNoCertSign(t *testing.T) {

lints/cabf_br/lint_ca_key_usage_missing.go → v2/lints/cabf_br/lint_ca_key_usage_missing.go

@@ -24,8 +24,8 @@ Conforming CAs MUST include this extension in certificates that
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type caKeyUsageMissing struct{}

lints/cabf_br/lint_ca_key_usage_missing_test.go → v2/lints/cabf_br/lint_ca_key_usage_missing_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCaKeyUsageMissing(t *testing.T) {

lints/cabf_br/lint_ca_key_usage_not_critical.go → v2/lints/cabf_br/lint_ca_key_usage_not_critical.go

@@ -22,8 +22,8 @@ If the Root CA Private Key is used for signing OCSP responses, then the digitalS
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type caKeyUsageNotCrit struct{}

lints/cabf_br/lint_ca_key_usage_not_critical_test.go → v2/lints/cabf_br/lint_ca_key_usage_not_critical_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCaKeyUsageNotCrit(t *testing.T) {

lints/cabf_br/lint_ca_organization_name_missing.go → v2/lints/cabf_br/lint_ca_organization_name_missing.go

@@ -21,8 +21,8 @@ The Certificate Subject MUST contain the following: organizationName (OID 2.5.4.
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type caOrganizationNameMissing struct{}

lints/cabf_br/lint_ca_organization_name_missing_test.go → v2/lints/cabf_br/lint_ca_organization_name_missing_test.go

@@ -17,8 +17,8 @@ package cabf_br
 import (
  "testing"
 
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/test"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/test"
 )
 
 func TestCAOrgNameBlank(t *testing.T) {

lints/cabf_br/lint_cab_dv_conflicts_with_locality.go → v2/lints/cabf_br/lint_cab_dv_conflicts_with_locality.go

@@ -19,8 +19,8 @@ package cabf_br
 
 import (
  "github.com/zmap/zcrypto/x509"
- "github.com/zmap/zlint/lint"
- "github.com/zmap/zlint/util"
+ "github.com/zmap/zlint/v2/lint"
+ "github.com/zmap/zlint/v2/util"
 )
 
 type certPolicyConflictsWithLocality struct{}