@nictool/dns-resource-record 1.2.3 → 1.2.4

package/CHANGELOG.md

@@ -4,6 +4,15 @@ Notable changes to this project are documented in this file.
 
 #### Unreleased
 
+### [1.2.4] - 2025-10-06
+
+- rr: rename ucfirst -> ucFirst
+- rr: setTTL was checking this.owner (copy/paste error)
+- rr: improved throwHelp message formatting
+- aaaa: compress & expand returns lower case
+- caa, dnskey, ds, ipseckey, key, naptr, rrsig, smimea, sshfp, tlsa: refactored opts as JS maps
+- deps: bump to latest versions
+
 ### [1.2.3] - 2025-04-14
 
 - test(\*): fully qualify node modules
@@ -310,6 +319,7 @@ Notable changes to this project are documented in this file.
 [1.1.8]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.8
 [1.1.7]: https://github.com/NicTool/dns-resource-record/releases/tag/1.1.7
 [1.2.0]: https://github.com/NicTool/dns-resource-record/releases/tag/1.2.0
-[1.2.1]: https://github.com/NicTool/dns-resource-record/releases/tag/v1.2.1
+[1.2.1]: https://github.com/NicTool/dns-resource-record/releases/tag/1.2.1
 [1.2.2]: https://github.com/NicTool/dns-resource-record/releases/tag/1.2.2
-[1.2.3]: https://github.com/NicTool/dns-resource-record/releases/tag/v1.2.3
+[1.2.3]: https://github.com/NicTool/dns-resource-record/releases/tag/1.2.3
+[1.2.4]: https://github.com/NicTool/dns-resource-record/releases/tag/v1.2.4

package/README.md

@@ -3,7 +3,7 @@
 
 # dns-resource-record
 
-DNS resource record parser, validator, importer, and exporter.
+DNS resource record parser, validator, importer, and exporter for node.js & browsers.
 
 ## SYNOPSIS
 
@@ -181,7 +181,7 @@ Consider this a "running with scissors" mode.
 
 ## Supported Records
 
-This module intends to include support for all current (ie, not officially deprecated) DNS RRs **and** all RRs that are in active use on the internet.
+This module intends to support all current (ie, not officially deprecated) DNS RRs **and** all RRs that are in active use on the internet.
 
 PRs are welcome, especially PRs with tests.
 
@@ -244,17 +244,6 @@ PRs are welcome, especially PRs with tests.
 
 ## TODO
 
-- [x] Change all IPs to use [RFC example/doc](https://en.wikipedia.org/wiki/Reserved_IP_addresses) address space
-- [x] change all domains to use reserved doc names
-- [x] import tests from nictool/server/t/12_records.t
-- [x] add defaults for empty values like TTL
-- [x] DNSSEC RRs: DS, NSEC, NSEC3, NSEC3PARAM, RRSIG
-- [x] CERT RRs: CERT, KEY, SIG, OPENPGPKEY
-- [x] RFC 4034: if the type of RR is NS, MD, MF, CNAME, SOA, MB,
-      MG, MR, PTR, HINFO, MINFO, MX, RP, AFSDB, RT, SIG, PX, NXT,
-      NAPTR, KX, SRV, DNAME, A6, RRSIG, or NSEC, all uppercase
-      letters in the DNS names contained within the RDATA are replaced by the lowercase letters;
-- [x] LOC record ingest/out isn't consistent with API
 - [ ] export a web page for each RR type
 
 ## DEVELOP

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nictool/dns-resource-record",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "DNS Resource Records",
   "main": "index.js",
   "files": [
@@ -19,7 +19,8 @@
     "prettier:fix": "npx prettier --ignore-path .gitignore --write .",
     "test": "npx mocha",
     "versions": "npx dependency-version-checker check",
-    "watch": "npm run test -- --watch"
+    "watch": "npm run test -- --watch",
+    "versions:fix": "npx dependency-version-checker update"
   },
   "repository": {
     "type": "git",
@@ -46,13 +47,13 @@
   "homepage": "https://github.com/NicTool/dns-resource-record#readme",
   "devDependencies": {
     "@eslint/js": "^10.0.0",
-    "eslint": "^9.15.0",
-    "globals": "^16.0.0",
-    "mocha": "^11.2.2"
+    "eslint": "^9.37.0",
+    "globals": "^16.4.0",
+    "mocha": "^11.7.4"
   },
   "prettier": {
     "semi": false,
     "singleQuote": true,
     "trailingComma": "all"
   }
-}
+}

package/rr/aaaa.js

@@ -15,7 +15,7 @@ export default class AAAA extends RR {
   }
 
   getCompressed(val) {
-    this.compress(val || this.get('address'))
+    return this.compress(val || this.get('address'))
   }
 
   getDescription() {
@@ -112,12 +112,12 @@ export default class AAAA extends RR {
 
     for (const re of mostConsecutiveZeros) {
       if (re.test(r)) {
-        r = r.replace(re, '::')
+        r = r.replace(re, '::') // 4.2
         break
       }
     }
 
-    return r
+    return r.toLowerCase() // 4.3
   }
 
   expand(val, delimiter) {
@@ -134,11 +134,12 @@ export default class AAAA extends RR {
       .split(':')
       .map((s) => s.padStart(4, 0))
       .join(delimiter)
+      .toLowerCase()
   }
 
   /******  EXPORTERS   *******/
   toBind(zone_opts) {
-    return `${this.getPrefix(zone_opts)}\t${this.compress(this.get('address'))}\n`
+    return `${this.getPrefix(zone_opts)}\t${this.getCompressed()}\n`
   }
 
   toTinydns() {

package/rr/caa.js

@@ -10,25 +10,36 @@ export default class CAA extends RR {
   setFlags(val) {
     this.is8bitInt('CAA', 'flags', val)
 
-    if (![0, 128].includes(val)) {
+    if (!this.getFlagsOptions().has(val)) {
       this.throwHelp(`CAA flags ${val} not recognized`)
     }
 
     this.set('flags', val)
   }
 
+  getFlagsOptions() {
+    return new Map([
+      [0, 'Non Critical'],
+      [128, 'Critical'],
+    ])
+  }
+
   setTag(val) {
     if (typeof val !== 'string' || val.length < 1 || /[^a-z0-9]/.test(val))
       this.throwHelp(
         `CAA tag must be a sequence of ASCII letters and numbers in lowercase`,
       )
 
-    if (!['issue', 'issuewild', 'iodef'].includes(val)) {
+    if (!this.getTagOptions().has(val)) {
       this.throwHelp(`CAA tag ${val} not recognized`)
     }
     this.set('tag', val)
   }
 
+  getTagOptions() {
+    return new Map([['issue'], ['issuewild'], ['iodef']])
+  }
+
   setValue(val) {
     // either (2) a quoted string or
     // (1) a contiguous set of characters without interior spaces

package/rr/dnskey.js

@@ -12,34 +12,67 @@ export default class DNSKEY extends RR {
     // a 2 octet Flags Field
     this.is16bitInt('DNSKEY', 'flags', val)
 
-    // the possible values are: 0, 256, and 257; RFC 4034
-    if (![0, 256, 257].includes(val)) this.throwHelp(`DNSKEY: flags invalid`)
+    if (!this.getFlagsOptions().has(val)) {
+      this.throwHelp(
+        `DNSKEY: flags must be in the set: ${this.getFlagsOptions()}`,
+      )
+    }
 
     this.set('flags', val)
   }
 
+  // possible values are: 0, 256, and 257; RFC 4034
+  getFlagsOptions() {
+    return new Map([[0], [256], [257]])
+  }
+
   setProtocol(val) {
     // 1 octet
     this.is8bitInt('DNSKEY', 'protocol', val)
 
     // The Protocol Field MUST be represented as an unsigned decimal integer with a value of 3.
-    if (![3].includes(val)) this.throwHelp(`DNSKEY: protocol invalid`)
+    if (!this.getProtocolOptions().has(val))
+      this.throwHelp(`DNSKEY: protocol invalid`)
 
     this.set('protocol', val)
   }
 
+  getProtocolOptions() {
+    return new Map([[3]])
+  }
+
   setAlgorithm(val) {
     // 1 octet
     this.is8bitInt('DNSKEY', 'algorithm', val)
 
     // https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml
-    // 1=RSA/MD5, 2=DH, 3=DSA/SHA-1, 4=EC, 5=RSA/SHA-1
-    if (![...Array(16).keys(), 253, 254].includes(val))
+    if (!this.getAlgorithmOptions().has(val))
       console.error(`DNSKEY: algorithm (${val}) not recognized`)
 
     this.set('algorithm', val)
   }
 
+  getAlgorithmOptions() {
+    return new Map([
+      [1, 'RSA/MD5 (DEPRECATED)'],
+      [2, 'DH'],
+      [3, 'DSA/SHA-1'],
+      [4, 'EC'],
+      [5, 'RSA/SHA-1'],
+      [6, 'DSA-NSEC3-SHA1'],
+      [7, 'RSASHA1-NSEC3-SHA1'],
+      [8, 'RSA/SHA-256'],
+      [9, ''],
+      [10, 'RSA/SHA-512'],
+      [13, 'ECDSA Curve P-256 with SHA-256'],
+      [14, 'ECDSA Curve P-384 with SHA-384'],
+      [15, 'Ed25519'],
+      [16, 'Ed448'],
+      [253],
+      [254],
+    ])
+  }
+
   setPublickey(val) {
     if (!val) this.throwHelp(`DNSKEY: publickey is required`)
 

package/rr/ds.js

@@ -17,13 +17,24 @@ export default class DS extends RR {
   }
 
   setAlgorithm(val) {
-    // 1=RSA/MD5, 2=DH, 3=DSA/SHA-1, 4=EC, 5=RSA/SHA-1
-    if (![1, 2, 3, 4, 5, 253, 254].includes(val))
+    if (!this.getAlgorithmOptions().has(val))
       this.throwHelp(`DS: algorithm invalid`)
 
     this.set('algorithm', val)
   }
 
+  getAlgorithmOptions() {
+    return new Map([
+      [1, 'RSA/MD5'],
+      [2, 'DH'],
+      [3, 'DSA/SHA-1'],
+      [4, 'EC'],
+      [5, 'RSA/SHA-1'],
+      [253, ''],
+      [254, ''],
+    ])
+  }
+
   setDigestType(val) {
     if (![1, 2].includes(val)) this.throwHelp(`DS: digest type invalid`)
 

package/rr/ipseckey.js

@@ -16,23 +16,41 @@ export default class IPSECKEY extends RR {
   }
 
   setGatewayType(val) {
-    // 0 (none), 1 (4-byte IPv4), 2 (16-byte IPv6), 3 (wire encoded domain name)
-    if (![0, 1, 2, 3].includes(val))
+    if (!this.getGatewayTypeOptions().has(val))
       this.throwHelp(`IPSECKEY: Gateway Type is invalid`)
 
     this.set('gateway type', val)
   }
 
+  getGatewayTypeOptions() {
+    return new Map([
+      [0, 'none'],
+      [1, '4-byte IPv4'],
+      [2, '16-byte IPv6'],
+      [3, 'wire encoded domain name'],
+    ])
+  }
+
   setAlgorithm(val) {
-    // unsigned int, 1 octet, values: 1=DSA, 2=RSA
-    if (![1, 2].includes(val)) this.throwHelp(`IPSECKEY: Algorithm invalid`)
+    if (!this.getAlgorithmOptions().has(val))
+      this.throwHelp(`IPSECKEY: Algorithm invalid`)
 
     this.set('algorithm', val)
   }
 
+  getAlgorithmOptions() {
+    return new Map([
+      [1, 'DSA'],
+      [2, 'RSA'],
+    ])
+  }
+
   setGateway(val) {
-    const gwErr = new Error(`IPSECKEY: gateway invalid (${val})`)
-    switch (this.get('gateway type')) {
+    const type = this.get('gateway type')
+    const gwErr = new Error(
+      `IPSECKEY: gateway invalid (${val}) for type ${type}`,
+    )
+    switch (type) {
       case 0:
         if (val !== '.') throw gwErr
         break

package/rr/key.js

@@ -22,13 +22,25 @@ export default class KEY extends RR {
 
   setAlgorithm(val) {
     // 1 octet
-    // 1=RSA/MD5, 2=DH, 3=DSA/SHA-1, 4=EC, 5=RSA/SHA-1
-    if (![1, 2, 3, 4, 5, 253, 254].includes(val))
+
+    if (!this.getAlgorithmOptions().has(val))
       this.throwHelp(`KEY: algorithm invalid`)
 
     this.set('algorithm', val)
   }
 
+  getAlgorithmOptions() {
+    return new Map([
+      [1, 'RSA/MD5'],
+      [2, 'DH'],
+      [3, 'DSA/SHA-1'],
+      [4, 'EC'],
+      [5, 'RSA/SHA-1'],
+      [253, ''],
+      [254, ''],
+    ])
+  }
+
   setPublickey(val) {
     if (!val) this.throwHelp(`KEY: publickey is required`)
 

package/rr/naptr.js

@@ -40,12 +40,16 @@ export default class NAPTR extends RR {
   }
 
   setFlags(val) {
-    if (!['', 'S', 'A', 'U', 'P'].includes(val.toUpperCase()))
+    if (!this.getFlagsOptions().has(val.toUpperCase()))
       this.throwHelp(`NAPTR flags are invalid`)
 
     this.set('flags', val.toUpperCase())
   }
 
+  getFlagsOptions() {
+    return new Map([[''], ['S'], ['A'], ['U'], ['P']])
+  }
+
   setService(val) {
     this.set('service', val)
   }

package/rr/rrsig.js

@@ -16,13 +16,24 @@ export default class RRSIG extends RR {
 
   setAlgorithm(val) {
     // a 1 octet Algorithm field
-    // 1=RSA/MD5, 2=DH, 3=RRSIGA/SHA-1, 4=EC, 5=RSA/SHA-1
-    if (![1, 2, 3, 4, 5, 253, 254].includes(val))
+    if (!this.getAlgorithmOptions().has(val))
       this.throwHelp(`RRSIG: algorithm invalid`)
 
     this.set('algorithm', val)
   }
 
+  getAlgorithmOptions() {
+    return new Map([
+      [1, 'RSA/MD5'],
+      [2, 'DH'],
+      [3, 'RRSIGA/SHA-1'],
+      [4, 'EC'],
+      [5, 'RSA/SHA-1'],
+      [253],
+      [254],
+    ])
+  }
+
   setLabels(val) {
     // a 1 octet Labels field
     this.is8bitInt('RRSIG', 'labels', val)

package/rr/smimea.js

@@ -7,24 +7,50 @@ export default class SMIMEA extends RR {
 
   /****** Resource record specific setters   *******/
   setCertificateUsage(val) {
-    if (![0, 1, 2, 3].includes(val))
+    if (!this.getCertificateUsageOptions().has(val))
       this.throwHelp(`SMIMEA: certificate usage invalid`)
 
     this.set('certificate usage', val)
   }
 
+  getCertificateUsageOptions() {
+    return new Map([
+      [0, 'CA certificate'],
+      [1, 'an end entity certificate'],
+      [2, 'the trust anchor'],
+      [3, 'domain-issued certificate'],
+    ])
+  }
+
   setSelector(val) {
-    if (![0, 1].includes(val)) this.throwHelp(`SMIMEA: selector invalid`)
+    if (!this.getSelectorOptions().has(val))
+      this.throwHelp(`SMIMEA: selector invalid`)
 
     this.set('selector', val)
   }
 
+  getSelectorOptions() {
+    return new Map([
+      [0, 'Full certificate'],
+      [1, 'SubjectPublicKeyInfo'],
+    ])
+  }
+
   setMatchingType(val) {
-    if (![0, 1, 2].includes(val)) this.throwHelp(`SMIMEA: matching type`)
+    if (!this.getMatchingTypeOptions().has(val))
+      this.throwHelp(`SMIMEA: matching type`)
 
     this.set('matching type', val)
   }
 
+  getMatchingTypeOptions() {
+    return new Map([
+      [0, 'Exact match'],
+      [1, 'SHA-256 hash'],
+      [2, 'SHA-512 hash'],
+    ])
+  }
+
   setCertificateAssociationData(val) {
     this.set('certificate association data', val)
   }

package/rr/sshfp.js

@@ -8,19 +8,36 @@ export default class SSHFP extends RR {
 
   /****** Resource record specific setters   *******/
   setAlgorithm(val) {
-    // 0: reserved  1: RSA  2: DSA  3: ECDSA  4: Ed25519  6: Ed448
     this.is8bitInt('SSHFP', 'algorithm', val)
 
     this.set('algorithm', val)
   }
 
+  getAlgorithmOptions() {
+    return new Map([
+      [0, 'reserved'],
+      [1, 'RSA'],
+      [2, 'DSA'],
+      [3, 'ECDSA'],
+      [4, 'Ed25519'],
+      [6, 'Ed448'],
+    ])
+  }
+
   setFptype(val) {
-    // 0: reserved, 1: SHA-1, 2: SHA-256
-    this.is8bitInt('SSHFP', 'type', val)
+    this.is8bitInt('SSHFP', 'fptype', val)
 
     this.set('fptype', val)
   }
 
+  getFptypeOptions() {
+    return new Map([
+      [0, 'reserved'],
+      [1, 'SHA-1'],
+      [2, 'SHA-256'],
+    ])
+  }
+
   setFingerprint(val) {
     this.set('fingerprint', val)
   }

package/rr/tlsa.js

@@ -9,24 +9,50 @@ export default class TLSA extends RR {
 
   /****** Resource record specific setters   *******/
   setCertificateUsage(val) {
-    if (![0, 1, 2, 3].includes(val))
+    if (!this.getCertificateUsageOptions().has(val))
       this.throwHelp(`TLSA: certificate usage invalid`)
 
     this.set('certificate usage', val)
   }
 
+  getCertificateUsageOptions() {
+    return new Map([
+      [0, 'CA certificate'],
+      [1, 'an end entity certificate'],
+      [2, 'the trust anchor'],
+      [3, 'domain-issued certificate'],
+    ])
+  }
+
   setSelector(val) {
-    if (![0, 1].includes(val)) this.throwHelp(`TLSA: selector invalid`)
+    if (!this.getSelectorOptions().has(val))
+      this.throwHelp(`TLSA: selector invalid`)
 
     this.set('selector', val)
   }
 
+  getSelectorOptions() {
+    return new Map([
+      [0, 'Full certificate'],
+      [1, 'SubjectPublicKeyInfo'],
+    ])
+  }
+
   setMatchingType(val) {
-    if (![0, 1, 2].includes(val)) this.throwHelp(`TLSA: matching type`)
+    if (!this.getMatchingTypeOptions().has(val))
+      this.throwHelp(`TLSA: matching type`)
 
     this.set('matching type', val)
   }
 
+  getMatchingTypeOptions() {
+    return new Map([
+      [0, 'Exact match'],
+      [1, 'SHA-256 hash'],
+      [2, 'SHA-512 hash'],
+    ])
+  }
+
   setCertificateAssociationData(val) {
     this.set('certificate association data', val)
   }

package/rr.js

@@ -19,7 +19,7 @@ export default class RR extends Map {
     this.setClass(opts?.class)
 
     for (const f of this.getFields('rdata')) {
-      const fnName = `set${this.ucfirst(f)}`
+      const fnName = `set${this.ucFirst(f)}`
       if (this[fnName] === undefined)
         this.throwHelp(`Missing ${fnName} in class ${this.get('type')}`)
       this[fnName](opts[f])
@@ -28,7 +28,7 @@ export default class RR extends Map {
     if (opts.comment) this.set('comment', opts.comment)
   }
 
-  ucfirst(str) {
+  ucFirst(str) {
     return str
       .split(/\s/)
       .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
@@ -104,7 +104,7 @@ export default class RR extends Map {
       this.throwHelp(`TTL must be numeric (${typeof t})`)
 
     // RFC 1035, 2181
-    this.is32bitInt(this.owner, 'TTL', t)
+    this.is32bitInt(this.get('type'), 'TTL', t)
 
     this.set('ttl', t)
   }
@@ -126,7 +126,7 @@ export default class RR extends Map {
     if (this.constructor.name === 'RR') throw new Error(e)
 
     const example = this.getCanonical
-      ? `Example ${this.constructor.name}:\n${this.getCanonical()}\n\n`
+      ? `Example ${this.constructor.name}:\n${JSON.stringify(this.getCanonical(), null, '\t')}\n\n`
       : `${this.constructor.name} records have the fields: ${this.getFields().join(', ')}\n\n`
 
     throw new Error(`${e}\n\n${example}${this.citeRFC()}\n`)