DNSControl v5 Release

.github/workflows/codeql.yml

@@ -0,0 +1,59 @@
+name: "CodeQL"
+
+# Advanced CodeQL setup.
+#
+# This replaces GitHub's "default setup" for CodeQL. The default setup runs the
+# Go extractor's autobuild with whatever Go is pre-installed on the runner and
+# with GOTOOLCHAIN=local, which forbids downloading a newer toolchain. When
+# go.mod requires a Go version newer than the runner's (e.g. `go 1.27` while the
+# runner only has 1.26.x), extraction fails with:
+#
+#   go: go.mod requires go >= 1.27 (running go 1.26.x; GOTOOLCHAIN=local)
+#
+# Installing Go from go.mod before the extractor runs makes the required
+# toolchain the "local" one, so autobuild succeeds.
+#
+# NOTE: An advanced workflow and the repository's "default setup" cannot both be
+# active. Disable default setup under
+# Settings -> Code security -> CodeQL analysis (switch Default -> Advanced).
+
+on:
+  push:
+    branches: [main, master, release_candidate_v5]
+  pull_request:
+    branches: [main, master, release_candidate_v5]
+  schedule:
+    - cron: "0 0 * * 1"
+
+concurrency:
+  group: codeql-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  analyze:
+    name: Analyze (go)
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      actions: read
+      contents: read
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v7
+
+      - name: Set up Go
+        uses: actions/setup-go@v7
+        with:
+          go-version-file: go.mod
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v4
+        with:
+          languages: go
+          build-mode: autobuild
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v4
+        with:
+          category: "/language:go"

.github/workflows/pr_integration_tests.yml

@@ -95,7 +95,7 @@ jobs:
   warm-gomod-cache:
     runs-on: ubuntu-latest
     container:
-      image: golang:1.26
+      image: golang:1.27
     needs:
       - integration-test-providers
     outputs:
@@ -144,7 +144,7 @@ jobs:
     if: ${{ inputs.full || (github.ref != 'refs/heads/master' && github.ref != 'refs/heads/main') }}
     runs-on: ubuntu-latest
     container:
-      image: golang:1.26
+      image: golang:1.27
     needs:
       - integration-test-providers
       - warm-gomod-cache

.linkspector.yml

@@ -10,7 +10,6 @@ ignorePatterns:
   - pattern: '.*.md#$'
   - pattern: '^https://cloud.digitalocean.com/account/api/tokens'
   - pattern: '^https://cloud.digitalocean.com/settings/applications'
-  - pattern: '^https://dns.hetzner.com/settings/api-token'
   - pattern: '^https://github.com/DNSControl/dnscontrol/settings/.*$'
   - pattern: '^https://gitlab.com/cafferata/dnscontrol/-/pipelines/new.*$'
   - pattern: '^https://my.easyname.com/en/account/api'

REFACTORING_PROJECTS.md

@@ -0,0 +1,46 @@
+# Refactoring
+
+Useful refactoring projects. Please feel free to pick up any of these.
+
+
+## Code that can probably be deleted
+
+* RegisterCustomRecordType()/GetCustomRecordType() is no longer needed. Remove.
+
+* I don't think the metadata "orig_custom_type" is used any more. We store to it but don't use it.
+
+## Rewrites needed
+
+* PTR() "magic" should be reworked as a builder called PTR(). It will be much more
+cleaner and more testable. Plus it will consolidate the code into one place instead
+of being some in LabelFromDnsconfigjs() and other places.
+
+* PopulateNamesFromRaw() and MakeDomainNameVarieties() seem like a silly design.  Maybe move them to pkg/nameutil, or maybe models (since that's where makeLabelNameUnicode() is)
+
+* All the LOC() builders should be in Go, not helpers.js.
+
+* There are multiple ways that code strips the trailing dot from a domain name.  Benchmark a few and standardize on the fastest. In pkg/nameutil. Possibly have one that is extra fast but panics if there is no "." at the end.
+
+* pkg/normalize/validate.go has half of the Transform code, the other half is in pkg/transform.  An easy thing would be to move the part of pkg/normalize/validate.go and validate_test.go into pkg/normalize/transform{,_test}.go.  The more difficult thing would be to move all or most of the code to pkg/transform.
+
+* models/record.go FixPostion has an easy TODO.
+
+* models/t_txt.go has an some easy FIXMEs.
+
+## Bad decisions to reverse
+
+* Providers, not Registrars + DNS Service Providers.  It should be possible to make a PROVIDER() function that returns
+something that is both a Reg and a DSP.
+
+* mustbe.TargetHost() accepts "." as a special flag. This can probably be replaced by nrc.Flags{}
+
+* models.SetLabel() should be removed (it's only used in a few places) or enhanced to also create the .NameUnicode/.NameFQDNUnicode fields. Then de-duplicate the code that does this for NewRecordConfig().
+
+* deSEC: BUG: It mutates RecordConfigs, which will create problems if the same zone is sent to multiple providers.
+
+
+## Actual new features:
+
+* Handle "unknown types". dnsv2 has a way to managing unknown types. Investigate it and replace the half-written version (see rc.UnknownTypeName)
+
+* pkg/diff2/analyze.go: Smarter diffs. Diffs could just show which fields changed. For example, if just the preference of an MX record changes, show "old -> new" just for the priority.

build/astypegen/astype_generate.go

@@ -0,0 +1,65 @@
+package main
+
+// Command astype_generate generates models/record_astype.go.
+//
+// Generates an As$TYPE() method for every rtype.
+//
+// Run by `go generate ./models/` (see the //go:generate directive in rdata.go)
+// and by bin/generate-all.sh.
+
+import (
+	"bytes"
+	"fmt"
+	"log"
+
+	dnsv2 "codeberg.org/miekg/dns"
+	"github.com/DNSControl/dnscontrol/v5/pkg/privatetypes"
+)
+
+const outputFile = "record_astype.go"
+
+func main() {
+	var buf bytes.Buffer
+
+	buf.WriteString("// Code generated by astype_generate.go; DO NOT EDIT.\n\n")
+	buf.WriteString("package models\n\n")
+	buf.WriteString("import (\n")
+	buf.WriteString("\tdnsrdatav2 \"codeberg.org/miekg/dns/rdata\"\n")
+	buf.WriteString("\tprivatetypesrdata \"github.com/DNSControl/dnscontrol/v5/pkg/privatetypes/rdata\"\n")
+	buf.WriteString(")\n\n")
+
+	seen := map[string]bool{}
+	for _, name := range privatetypes.GetAllTypeNames() {
+		codepoint := dnsv2.StringToType[name]
+
+		// Skip irrelevant rtypes. Make a struct of that type.
+		newFn, ok := dnsv2.TypeToRR[codepoint]
+		if !ok {
+			continue
+		}
+		rd := newFn().Data()
+
+		// is this a dnsrdatav2. or privatetypes. namespace?
+		structName, pkgPath := StructName(rd)
+		pkg, ok := Namespace(pkgPath)
+		if structName == "" || !ok {
+			continue
+		}
+
+		method := "As" + goIdent(name)
+		// Have we seen this before?
+		if seen[method] {
+			continue
+		}
+		seen[method] = true
+
+		fmt.Fprintf(&buf,
+			"func (rc *RecordConfig) %s() %s.%s {\n\treturn rc.GetRDATA().(%s.%s)\n}\n\n",
+			method, pkg, structName, pkg, structName)
+	}
+
+	if err := writeGoFile(outputFile, buf.Bytes()); err != nil {
+		log.Fatal(err)
+	}
+	fmt.Printf("astype_generate.go: wrote %s\n", outputFile)
+}

build/astypegen/astypeutil.go

@@ -0,0 +1,61 @@
+package main
+
+import (
+	"fmt"
+	"go/format"
+	"os"
+	"reflect"
+	"strings"
+)
+
+// goIdent turns a DNS type name into a valid Go identifier by dropping any
+// character that is not a letter or digit (e.g. "NSAP-PTR" -> "NSAPPTR",
+// "CLOUDFLAREAPI_SINGLE_REDIRECT" -> "CLOUDFLAREAPISINGLEREDIRECT").
+func goIdent(name string) string {
+	return strings.Map(func(r rune) rune {
+		switch {
+		case r >= 'A' && r <= 'Z', r >= 'a' && r <= 'z', r >= '0' && r <= '9':
+			return r
+		default:
+			return -1
+		}
+	}, name)
+}
+
+// writeGoFile runs the generated source through gofmt (go/format) and writes it
+// to path.
+// Copied from pkg/privatetypes/types_generate.go.
+func writeGoFile(path string, src []byte) error {
+	formatted, err := format.Source(src)
+	if err != nil {
+		_ = os.WriteFile(path, src, 0o644)
+		return fmt.Errorf("gofmt %s: %w", path, err)
+	}
+	return os.WriteFile(path, formatted, 0o644)
+}
+
+// StructName returns the Go struct name and package import path of an RDATA value.
+// It returns ("", "") for nil or a type with no name.
+func StructName(rd any) (name, pkgPath string) {
+	rt := reflect.TypeOf(rd)
+	if rt == nil {
+		return "", ""
+	}
+	if rt.Kind() == reflect.Pointer {
+		rt = rt.Elem()
+	}
+	return rt.Name(), rt.PkgPath()
+}
+
+// Namespace maps an RDATA struct's package import path.
+// Possible return values are ("privatetypesrdata", true), ("dnsrdatav2", true), or ("", false).
+func Namespace(pkgPath string) (alias string, ok bool) {
+	switch {
+	case strings.HasSuffix(pkgPath, "/pkg/privatetypes/rdata"):
+		return "privatetypesrdata", true
+	case pkgPath == "codeberg.org/miekg/dns/rdata":
+		return "dnsrdatav2", true
+	default:
+		return "", false
+	}
+}

build/astypegen/astypeutil_test.go

@@ -0,0 +1,54 @@
+package main_test
+
+import (
+	"testing"
+
+	gen "github.com/DNSControl/dnscontrol/v5/build/astypegen"
+)
+
+type sampleRD struct{}
+
+func TestStructName(t *testing.T) {
+	// Value: name + this test package's path.
+	name, pkgPath := gen.StructName(sampleRD{})
+	if name != "sampleRD" {
+		t.Errorf("StructName(value): name=%q, want %q", name, "sampleRD")
+	}
+	if pkgPath == "" {
+		t.Errorf("StructName(value): pkgPath is empty, want a non-empty package path")
+	}
+
+	// Pointer is dereferenced to the same name/path.
+	pName, pPkg := gen.StructName(&sampleRD{})
+	if pName != name || pPkg != pkgPath {
+		t.Errorf("StructName(pointer) = (%q,%q), want (%q,%q)", pName, pPkg, name, pkgPath)
+	}
+
+	// nil yields empties (generator skips these).
+	if n, p := gen.StructName(nil); n != "" || p != "" {
+		t.Errorf("StructName(nil) = (%q,%q), want empty", n, p)
+	}
+}
+
+func TestNamespace(t *testing.T) {
+	cases := []struct {
+		pkgPath   string
+		wantAlias string
+		wantOK    bool
+	}{
+		{"codeberg.org/miekg/dns/rdata", "dnsrdatav2", true},
+		{"github.com/DNSControl/dnscontrol/v5/pkg/privatetypes/rdata", "privatetypesrdata", true},
+		// Version-independent: a future major version must still map correctly.
+		{"github.com/DNSControl/dnscontrol/v6/pkg/privatetypes/rdata", "privatetypesrdata", true},
+		// Anything else is skipped.
+		{"codeberg.org/miekg/dns", "", false},
+		{"some/other/package", "", false},
+		{"", "", false},
+	}
+	for _, c := range cases {
+		alias, ok := gen.Namespace(c.pkgPath)
+		if alias != c.wantAlias || ok != c.wantOK {
+			t.Errorf("Namespace(%q) = (%q, %v), want (%q, %v)", c.pkgPath, alias, ok, c.wantAlias, c.wantOK)
+		}
+	}
+}

build/build.go

@@ -7,15 +7,15 @@ import (
 	"os"
 	"os/exec"
 
-	"github.com/DNSControl/dnscontrol/v4/pkg/version"
+	"github.com/DNSControl/dnscontrol/v5/pkg/version"
 )
 
 var goos = flag.String("os", "", "OS to build (linux, windows, or darwin) Defaults to all.")
 
 func main() {
 	flag.Parse()
-	flags := fmt.Sprintf(`-s -w -X "github.com/DNSControl/dnscontrol/v4/pkg/version.version=%s"`, version.Version())
-	pkg := "github.com/DNSControl/dnscontrol/v4"
+	flags := fmt.Sprintf(`-s -w -X "github.com/DNSControl/dnscontrol/v5/pkg/version.version=%s"`, version.Version())
+	pkg := "github.com/DNSControl/dnscontrol/v5"
 
 	build := func(out, goos string) {
 		log.Printf("Building %s", out)

build/generate/featureMatrix.go

@@ -7,9 +7,8 @@ import (
 	"sort"
 	"strings"
 
-	"github.com/DNSControl/dnscontrol/v4/pkg/providers"
-	_ "github.com/DNSControl/dnscontrol/v4/pkg/providers/_all"
-	_ "github.com/DNSControl/dnscontrol/v4/pkg/rtype"
+	"github.com/DNSControl/dnscontrol/v5/pkg/providers"
+	_ "github.com/DNSControl/dnscontrol/v5/pkg/providers/_all"
 	"github.com/fbiville/markdown-table-formatter/pkg/markdown"
 )
 
@@ -178,39 +177,39 @@ func matrixData() *FeatureMatrix {
 			"DNSSEC",
 		},
 		FeatureTables: [][]string{
-			[]string{ // provider type
+			{ // provider type
 				OfficialSupport,
 				ProviderDNSProvider,
 				ProviderRegistrar,
 			},
-			[]string{ // provider API
+			{ // provider API
 				ProviderThreadSafe,
 				DualHost,
 				CreateDomains,
 				// NoPurge,
 				GetZones,
 			},
-			[]string{ // DNS extensions
+			{ // DNS extensions
 				DomainModifierAlias,
 				DomainModifierDname,
 				DomainModifierLoc,
 				DomainModifierPtr,
 				DomainModifierSoa,
 			},
-			[]string{ // service discovery
+			{ // service discovery
 				DomainModifierDhcid,
 				DomainModifierNaptr,
 				DomainModifierSrv,
 				DomainModifierSvcb,
 			},
-			[]string{ // security
+			{ // security
 				DomainModifierCaa,
 				DomainModifierHTTPS,
 				DomainModifierSMIMEA,
 				DomainModifierSshfp,
 				DomainModifierTlsa,
 			},
-			[]string{ // dnssec
+			{ // dnssec
 				DomainModifierDnssec,
 				DomainModifierDnskey,
 				DomainModifierDs,