NEW PROVIDER: Netnod primary DNS #4191
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| ## Configuration | ||
|
|
||
| To use this provider, add an entry to `creds.json` with `TYPE` set to `NETNOD` along with your API URL and API Key. The API URL can be omitted to use the default value `https://primarydnsapi.netnod.se`. | ||
|
|
||
| Example: | ||
|
|
||
| {% code title="creds.json" %} | ||
|
|
||
| ```json | ||
| { | ||
| "netnod": { | ||
| "TYPE": "NETNOD", | ||
| "apiKey": "your-key", | ||
| "apiUrl": "https://primarydnsapi.netnod.se" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| {% endcode %} | ||
|
|
||
| ## Metadata | ||
|
|
||
| The following provider metadata is available: | ||
|
|
||
| {% code title="dnsconfig.js" %} | ||
|
|
||
| ```javascript | ||
| var DSP_NETNOD = NewDnsProvider('netnod', { | ||
| default_ns: ['a.example.com.', 'b.example.com.'], | ||
| also_notify: ['192.36.148.17', '2001:7fe::53'], | ||
| allow_transfer_keys: ['netnod-key1.'], | ||
| }); | ||
| ``` | ||
|
|
||
| {% endcode %} | ||
|
|
||
| - `default_ns` sets the nameservers used when creating zones. | ||
| - `also_notify` sets a list of IP addresses that will receive DNS NOTIFY messages when a zone is created. This is the provider-level default and applies to all zones unless overridden per zone. | ||
| - `allow_transfer_keys` sets the TSIG key IDs permitted to perform zone transfers from the distribution servers when a zone is created. | ||
| This should include all keys used for DNS secondary replication, including those used by the Netnod secondary DNS service. This is the provider-level default and applies to all zones unless overridden per zone. | ||
|
|
||
| ## Usage | ||
|
|
||
| An example configuration: | ||
|
|
||
| {% code title="dnsconfig.js" %} | ||
|
|
||
| ```javascript | ||
| var REG_NONE = NewRegistrar('none'); | ||
| var DSP_NETNOD = NewDnsProvider('netnod'); | ||
|
|
||
| D('example.com', REG_NONE, DnsProvider(DSP_NETNOD), A('test', '1.2.3.4')); | ||
| ``` | ||
|
|
||
| {% endcode %} | ||
|
|
||
| ## Activation | ||
|
|
||
| See the [Netnod DNS](https://www.netnod.se/dns/dns-enterprise-services). | ||
|
Member
There was a problem hiding this comment. This is a sentence fragment. Consider expanding it to explain how users obtain API credentials, similar to how other provider docs handle this section.
Author
There was a problem hiding this comment. The API credentials are obtained by contacting Netnod using the details on the linked page. Is there any specific detail you think should be added? |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| package netnod | ||
|
|
||
| import ( | ||
| "github.com/DNSControl/dnscontrol/v4/models" | ||
| "github.com/DNSControl/dnscontrol/v4/pkg/rejectif" | ||
| ) | ||
|
|
||
| // AuditRecords returns a list of errors corresponding to the records | ||
| // that aren't supported by this provider. If all records are | ||
| // supported, an empty list is returned. | ||
| func AuditRecords(records []*models.RecordConfig) []error { | ||
| a := rejectif.Auditor{} | ||
|
|
||
| a.Add("TXT", rejectif.TxtHasDoubleQuotes) // Last verified 2026-05-19 | ||
| a.Add("TXT", rejectif.TxtHasBackslash) // Last verified 2026-05-19 | ||
|
|
||
| return a.Audit(records) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| package netnod | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "github.com/DNSControl/dnscontrol/v4/models" | ||
| netnodPrimaryDNS "github.com/netnod/netnod-primary-dns-client" | ||
| ) | ||
|
|
||
| // toRecordConfig converts a Netnod DNS Record to a RecordConfig. #rtype_variations | ||
| func toRecordConfig(domain string, r netnodPrimaryDNS.Record, ttl int, name string, rtype string) (*models.RecordConfig, error) { | ||
| // trimming trailing dot and domain from name | ||
| name = strings.TrimSuffix(name, domain+".") | ||
| name = strings.TrimSuffix(name, ".") | ||
|
|
||
| rc := &models.RecordConfig{ | ||
| TTL: uint32(ttl), | ||
| Original: r, | ||
| Type: rtype, | ||
| } | ||
| rc.SetLabel(name, domain) | ||
|
|
||
| switch rtype { | ||
| case "TXT": | ||
| // API accepts long TXTs without requiring to split them. | ||
| // The API then returns them as they initially came in, e.g. "averylooooooo[...]oooooongstring" or "string" "string" | ||
| // So we need to strip away " and split into multiple string | ||
| // We can't use SetTargetRFC1035Quoted, it would split the long strings into multiple parts | ||
| return rc, rc.SetTargetTXTs(parseTxt(r.Content)) | ||
| default: | ||
| return rc, rc.PopulateFromString(rtype, r.Content, domain) | ||
| } | ||
| } | ||
|
|
||
| func parseTxt(content string) (result []string) { | ||
| for r := range strings.SplitSeq(content, "\" ") { | ||
| result = append(result, strings.Trim(r, "\"")) | ||
| } | ||
| return | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| package netnod | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| netnodPrimaryDNS "github.com/netnod/netnod-primary-dns-client" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestToRecordConfig(t *testing.T) { | ||
| record := netnodPrimaryDNS.Record{ | ||
| Content: "simple", | ||
| } | ||
| recordConfig, err := toRecordConfig("example.com", record, 120, "test", "TXT") | ||
|
|
||
| assert.NoError(t, err) | ||
| assert.Equal(t, "test.example.com", recordConfig.NameFQDN) | ||
| assert.Equal(t, "\"simple\"", recordConfig.String()) | ||
| assert.Equal(t, uint32(120), recordConfig.TTL) | ||
| assert.Equal(t, "TXT", recordConfig.Type) | ||
|
|
||
| largeContent := fmt.Sprintf("\"%s\" \"%s\"", strings.Repeat("A", 300), strings.Repeat("B", 300)) | ||
| largeRecord := netnodPrimaryDNS.Record{ | ||
| Content: largeContent, | ||
| } | ||
| recordConfig, err = toRecordConfig("example.com", largeRecord, 5, "large", "TXT") | ||
|
|
||
| assert.NoError(t, err) | ||
| assert.Equal(t, "large.example.com", recordConfig.NameFQDN) | ||
| assert.Equal(t, `"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB" "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"`, | ||
| recordConfig.String()) | ||
| assert.Equal(t, uint32(5), recordConfig.TTL) | ||
| assert.Equal(t, "TXT", recordConfig.Type) | ||
|
|
||
| luaRecord := netnodPrimaryDNS.Record{ | ||
| Content: "TXT \"return 'Hello, world!'\"", | ||
| } | ||
| recordConfig, err = toRecordConfig("example.com", luaRecord, 3600, "script", "LUA") | ||
|
|
||
| assert.NoError(t, err) | ||
| assert.Equal(t, "script.example.com", recordConfig.NameFQDN) | ||
| assert.Equal(t, "LUA", recordConfig.Type) | ||
| assert.Equal(t, "TXT", recordConfig.LuaRType) | ||
| assert.Equal(t, "return 'Hello, world!'", recordConfig.GetTargetTXTJoined()) | ||
| assert.Equal(t, "TXT \"return 'Hello, world!'\"", recordConfig.GetTargetCombined()) | ||
| assert.Equal(t, uint32(3600), recordConfig.TTL) | ||
| } | ||
|
|
||
| func TestParseText(t *testing.T) { | ||
| // short TXT record | ||
| short := parseTxt("\"simple\"") | ||
| assert.Equal(t, []string{"simple"}, short) | ||
|
|
||
| // TXT record with multiple parts | ||
| multiple := parseTxt("\"simple\" \"simple2\"") | ||
| assert.Equal(t, []string{"simple", "simple2"}, multiple) | ||
|
|
||
| // long TXT record | ||
| long := parseTxt(fmt.Sprintf("\"%s\"", strings.Repeat("A", 300))) | ||
| assert.Equal(t, []string{strings.Repeat("A", 300)}, long) | ||
|
|
||
| // multiple long TXT record | ||
| multipleLong := parseTxt(fmt.Sprintf("\"%s\" \"%s\"", strings.Repeat("A", 300), strings.Repeat("B", 300))) | ||
| assert.Equal(t, []string{strings.Repeat("A", 300), strings.Repeat("B", 300)}, multipleLong) | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.