Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions integrationTest/helpers_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,12 @@ func cfSingleRedirectEnabled() bool {
}

func cfSingleRedirect(name string, code any, when, then string) *models.RecordConfig {
rec, err := rtypecontrol.NewRecordConfigFromRaw("CLOUDFLAREAPI_SINGLE_REDIRECT", 1, []any{name, code, when, then}, globalDCN, "")
rec, err := rtypecontrol.NewRecordConfigFromRaw(rtypecontrol.FromRawOpts{
Type: "CLOUDFLAREAPI_SINGLE_REDIRECT",
TTL: 1,
Args: []any{name, code, when, then},
DCN: globalDCN,
})
panicOnErr(err)
return rec
}
Expand All @@ -355,13 +360,23 @@ func cfWorkerRoute(pattern, target string) *models.RecordConfig {
}

func cfRedir(pattern, target string) *models.RecordConfig {
rec, err := rtypecontrol.NewRecordConfigFromRaw("CF_REDIRECT", 1, []any{pattern, target}, globalDCN, "")
rec, err := rtypecontrol.NewRecordConfigFromRaw(rtypecontrol.FromRawOpts{
Type: "CF_REDIRECT",
TTL: 1,
Args: []any{pattern, target},
DCN: globalDCN,
})
panicOnErr(err)
return rec
}

func cfRedirTemp(pattern, target string) *models.RecordConfig {
rec, err := rtypecontrol.NewRecordConfigFromRaw("CF_TEMP_REDIRECT", 1, []any{pattern, target}, globalDCN, "")
rec, err := rtypecontrol.NewRecordConfigFromRaw(rtypecontrol.FromRawOpts{
Type: "CF_TEMP_REDIRECT",
TTL: 1,
Args: []any{pattern, target},
DCN: globalDCN,
})
panicOnErr(err)
return rec
}
Expand Down Expand Up @@ -487,7 +502,12 @@ func r53alias(name, aliasType, target, evalTargetHealth string) *models.RecordCo
}

func rp(name string, m, t string) *models.RecordConfig {
rec, err := rtypecontrol.NewRecordConfigFromRaw("RP", 300, []any{name, m, t}, globalDCN, "")
rec, err := rtypecontrol.NewRecordConfigFromRaw(rtypecontrol.FromRawOpts{
Type: "RP",
TTL: 300,
Args: []any{name, m, t},
DCN: globalDCN,
})
panicOnErr(err)
return rec
}
Expand Down
4 changes: 4 additions & 0 deletions pkg/js/parse_tests/050-cfSingleRedirect.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@
"sr_when": "whenmeta"
},
"filepos": "[line:9:5]",
"meta": {
"metanum": "22",
"metastr": "stringy"
},
"name": "@",
"name_raw": "@",
"name_unicode": "@",
Expand Down
6 changes: 6 additions & 0 deletions pkg/js/parse_tests/060-rawmetas.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// This tests whether or not metadata gets passed to RecordConfig v2.

D("bar.com", "none",
RP("foo.bar.com", "user2.example.com.", "mytxt.example.com.", DISABLE_REPEATED_DOMAIN_CHECK),
RP("bar.com", "user2.example.com.", "mytxt.example.com.", DISABLE_REPEATED_DOMAIN_CHECK),
)
69 changes: 69 additions & 0 deletions pkg/js/parse_tests/060-rawmetas.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
{
"dns_providers": [],
"domains": [
{
"dnsProviders": {},
"meta": {
"dnscontrol_nameraw": "bar.com",
"dnscontrol_nameunicode": "bar.com",
"dnscontrol_uniquename": "bar.com"
},
"name": "bar.com",
"records": [
{
"comparable": "user2.example.com. mytxt.example.com.",
"fields": {
"Hdr": {
"Class": 0,
"Name": "",
"Rdlength": 0,
"Rrtype": 0,
"Ttl": 0
},
"Mbox": "user2.example.com.",
"Txt": "mytxt.example.com."
},
"filepos": "[line:5:5]",
"meta": {
"skip_fqdn_check": "true"
},
"name": "bar.com",
"name_raw": "bar.com",
"name_unicode": "bar.com",
"target": "",
"ttl": 300,
"type": "RP",
"zonfefilepartial": "user2.example.com. mytxt.example.com."
},
{
"comparable": "user2.example.com. mytxt.example.com.",
"fields": {
"Hdr": {
"Class": 0,
"Name": "",
"Rdlength": 0,
"Rrtype": 0,
"Ttl": 0
},
"Mbox": "user2.example.com.",
"Txt": "mytxt.example.com."
},
"filepos": "[line:4:5]",
"meta": {
"skip_fqdn_check": "true"
},
"name": "foo.bar.com",
"name_raw": "foo.bar.com",
"name_unicode": "foo.bar.com",
"target": "",
"ttl": 300,
"type": "RP",
"zonfefilepartial": "user2.example.com. mytxt.example.com."
}
],
"registrar": "none",
"uniquename": "bar.com"
}
],
"registrars": []
}
60 changes: 56 additions & 4 deletions pkg/rtypecontrol/import.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,21 @@ import (
func ImportRawRecords(domains []*models.DomainConfig) error {
for _, dc := range domains {
for _, rawRec := range dc.RawRecords {

rec, err := NewRecordConfigFromRaw(rawRec.Type, rawRec.TTL, rawRec.Args, dc.DomainNameVarieties(), models.FixPosition(rawRec.FilePos))
filePos := models.FixPosition(rawRec.FilePos)

rec, err := NewRecordConfigFromRaw(FromRawOpts{
Type: rawRec.Type,
TTL: rawRec.TTL,
Args: rawRec.Args,
Metas: rawRec.Metas,
DCN: dc.DomainNameVarieties(),
FilePos: filePos,
})
if err != nil {
return err
return fmt.Errorf("error processing record at %s [%s(%s)]: %v",
filePos,
rawRec.Type, StringifyQuoted(rawRec.Args),
err)
}
if rec.Metadata["skip_fqdn_check"] != "true" && stutters(rec.Name, dc.Name) {
var shortname string
Expand Down Expand Up @@ -55,10 +66,27 @@ func stutters(name, domain string) bool {
return false
}

// FromRawOpts contains the options for creating a RecordConfig from raw data.
// Except Type and Args, all fields are optional.
type FromRawOpts struct {
Type string // (required) Record type (e.g., "A", "CNAME")
TTL uint32 // Time to live
Args []any // (required) Arguments for the record
Metas []map[string]any // Metadata for the record
DCN *domaintags.DomainNameVarieties // Domain name varieties
FilePos string // Position in the file where this record was defined
}

// NewRecordConfigFromRaw creates a new RecordConfig from the raw ([]any) args,
// usually from the parsed dnsconfig.js file, but also useful when a provider
// returns the fields of a record as individual values.
func NewRecordConfigFromRaw(t string, ttl uint32, args []any, dcn *domaintags.DomainNameVarieties, FilePos string) (*models.RecordConfig, error) {
func NewRecordConfigFromRaw(opts FromRawOpts) (*models.RecordConfig, error) {
t := opts.Type
ttl := opts.TTL
args := opts.Args
dcn := opts.DCN
FilePos := opts.FilePos

if _, ok := Func[t]; !ok {
return nil, fmt.Errorf("record type %q is not supported", t)
}
Expand All @@ -73,13 +101,31 @@ func NewRecordConfigFromRaw(t string, ttl uint32, args []any, dcn *domaintags.Do
Metadata: map[string]string{},
FilePos: FilePos,
}

// Set the label names:
if err := setRecordNames(rec, dcn, args[0].(string)); err != nil {
return rec, err
}
// If setRecordNames notices that a FQDN was used but it is outside the
// D()/D_EXTEND() domain, it will leave the name as a FQDN ending in a dot.
// We catch that here:
if strings.HasSuffix(rec.Name, ".") {
return nil, fmt.Errorf("label %q is not in zone %s", args[0].(string), dcn.DisplayName)
}

// Fill in the metadata fields.
for _, meta := range opts.Metas {
for k, v := range meta {
vStr := fmt.Sprintf("%v", v)
v, exists := rec.Metadata[k]
//fmt.Printf("DEBUG: meta key=%q value=%q v,e=%q,%q\n", k, vStr, v, exists)
if exists && v == vStr {
return nil, fmt.Errorf("duplicate metadata key %q (%q -- %q)", k, rec.Metadata[k], vStr)
}
rec.Metadata[k] = vStr
}
}

// Fill in the .F/.Fields* fields.
err := Func[t].FromArgs(dcn, rec, args)
if err != nil {
Expand Down Expand Up @@ -131,6 +177,12 @@ func NewRecordConfigFromStruct(name string, ttl uint32, t string, fields any, dc
if strings.HasSuffix(rec.Name, ".") {
return nil, fmt.Errorf("label %q is not in zone %q", name, dcn.NameASCII+".")
}
if err := setRecordNames(rec, dcn, name); err != nil {
return rec, err
}
if strings.HasSuffix(rec.Name, ".") {
return nil, fmt.Errorf("label %q is not in zone %q", name, dcn.NameASCII+".")
}

err := Func[t].FromStruct(dcn, rec, name, fields)
if err != nil {
Expand Down
41 changes: 21 additions & 20 deletions pkg/rtypecontrol/setrecordnames_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -181,11 +181,11 @@ func TestSetRecordNames(t *testing.T) {
dc: dc,
n: "example.com.",
expectedRec: &models.RecordConfig{
NameRaw: "@",
Name: "@",
NameRaw: "@",
NameUnicode: "@",
NameFQDNRaw: "example.com",
NameFQDN: "example.com",
NameFQDNRaw: "example.com",
NameFQDNUnicode: "example.com",
},
},
Expand All @@ -195,11 +195,11 @@ func TestSetRecordNames(t *testing.T) {
dc: dc,
n: "www.example.com.",
expectedRec: &models.RecordConfig{
NameRaw: "www",
Name: "www",
NameRaw: "www",
NameUnicode: "www",
NameFQDNRaw: "www.example.com",
NameFQDN: "www.example.com",
NameFQDNRaw: "www.example.com",
NameFQDNUnicode: "www.example.com",
},
},
Expand All @@ -209,11 +209,11 @@ func TestSetRecordNames(t *testing.T) {
dc: dc,
n: "bücher.example.com.",
expectedRec: &models.RecordConfig{
NameRaw: "bücher",
Name: "xn--bcher-kva",
NameRaw: "bücher",
NameUnicode: "bücher",
NameFQDNRaw: "bücher.example.com",
NameFQDN: "xn--bcher-kva.example.com",
NameFQDNRaw: "bücher.example.com",
NameFQDNUnicode: "bücher.example.com",
},
},
Expand All @@ -223,11 +223,11 @@ func TestSetRecordNames(t *testing.T) {
dc: dcIDN,
n: "www.bücher.com.",
expectedRec: &models.RecordConfig{
NameRaw: "www",
Name: "www",
NameRaw: "www",
NameUnicode: "www",
NameFQDNRaw: "www.bücher.com",
NameFQDN: "www.xn--bcher-kva.com",
NameFQDNRaw: "www.bücher.com",
NameFQDNUnicode: "www.bücher.com",
},
},
Expand All @@ -251,12 +251,13 @@ func TestSetRecordNames(t *testing.T) {
dc: dc,
n: "www.bücher.example.com.",
expectedRec: &models.RecordConfig{
SubDomain: "bücher",
Name: "www.xn--bcher-kva",
SubDomain: "bücher",

NameRaw: "www.bücher",
Name: "www.xn--bcher-kva",
NameUnicode: "www.bücher",
NameFQDN: "www.xn--bcher-kva.example.com",
NameFQDNRaw: "www.bücher.example.com",
NameFQDN: "www.xn--bcher-kva.example.com",
NameFQDNUnicode: "www.bücher.example.com",
},
},
Expand All @@ -267,11 +268,11 @@ func TestSetRecordNames(t *testing.T) {
n: "bücher.sub.example.com.",
expectedRec: &models.RecordConfig{
SubDomain: "sub",
NameRaw: "bücher.sub",
Name: "xn--bcher-kva.sub",
NameRaw: "bücher.sub",
NameUnicode: "bücher.sub",
NameFQDNRaw: "bücher.sub.example.com",
NameFQDN: "xn--bcher-kva.sub.example.com",
NameFQDNRaw: "bücher.sub.example.com",
NameFQDNUnicode: "bücher.sub.example.com",
},
},
Expand All @@ -282,11 +283,11 @@ func TestSetRecordNames(t *testing.T) {
n: "könig.bücher.example.com.",
expectedRec: &models.RecordConfig{
SubDomain: "bücher",
NameRaw: "könig.bücher",
Name: "xn--knig-5qa.xn--bcher-kva",
NameRaw: "könig.bücher",
NameUnicode: "könig.bücher",
NameFQDNRaw: "könig.bücher.example.com",
NameFQDN: "xn--knig-5qa.xn--bcher-kva.example.com",
NameFQDNRaw: "könig.bücher.example.com",
NameFQDNUnicode: "könig.bücher.example.com",
},
},
Expand All @@ -297,11 +298,11 @@ func TestSetRecordNames(t *testing.T) {
n: "www.bücher.bücher.com.",
expectedRec: &models.RecordConfig{
SubDomain: "bücher",
NameRaw: "www.bücher",
Name: "www.xn--bcher-kva",
NameRaw: "www.bücher",
NameUnicode: "www.bücher",
NameFQDNRaw: "www.bücher.bücher.com",
NameFQDN: "www.xn--bcher-kva.xn--bcher-kva.com",
NameFQDNRaw: "www.bücher.bücher.com",
NameFQDNUnicode: "www.bücher.bücher.com",
},
},
Expand All @@ -324,12 +325,12 @@ func TestSetRecordNames(t *testing.T) {
if tt.rec.NameUnicode != tt.expectedRec.NameUnicode {
t.Errorf("NameUnicode: got %q, want %q", tt.rec.NameUnicode, tt.expectedRec.NameUnicode)
}
if tt.rec.NameFQDN != tt.expectedRec.NameFQDN {
t.Errorf("NameFQDN: got %q, want %q", tt.rec.NameFQDN, tt.expectedRec.NameFQDN)
}
if tt.rec.NameFQDNRaw != tt.expectedRec.NameFQDNRaw {
t.Errorf("NameFQDNRaw: got %q, want %q", tt.rec.NameFQDNRaw, tt.expectedRec.NameFQDNRaw)
}
if tt.rec.NameFQDN != tt.expectedRec.NameFQDN {
t.Errorf("NameFQDN: got %q, want %q", tt.rec.NameFQDN, tt.expectedRec.NameFQDN)
}
if tt.rec.NameFQDNUnicode != tt.expectedRec.NameFQDNUnicode {
t.Errorf("NameFQDNUnicode: got %q, want %q", tt.rec.NameFQDNUnicode, tt.expectedRec.NameFQDNUnicode)
}
Expand Down
12 changes: 6 additions & 6 deletions providers/cloudflare/rest.go
Original file line number Diff line number Diff line change
Expand Up @@ -322,12 +322,12 @@ func (c *cloudflareProvider) getSingleRedirects(id string, domain string) ([]*mo
srThen := pr.ActionParameters.FromValue.TargetURL.Expression
code := uint16(pr.ActionParameters.FromValue.StatusCode)

rec, err := rtypecontrol.NewRecordConfigFromRaw(
"CLOUDFLAREAPI_SINGLE_REDIRECT",
1,
[]any{srName, code, srWhen, srThen},
domaintags.MakeDomainNameVarieties(domain),
"")
rec, err := rtypecontrol.NewRecordConfigFromRaw(rtypecontrol.FromRawOpts{
Type: "CLOUDFLAREAPI_SINGLE_REDIRECT",
TTL: 1,
Args: []any{srName, code, srWhen, srThen},
DCN: domaintags.MakeDomainNameVarieties(domain),
})
if err != nil {
return nil, err
}
Expand Down
Loading