@nictool/dns-resource-record 1.1.7 → 1.2.1

package/lib/tinydns.js

@@ -1,83 +1,88 @@
-
-export const SPECIALCHARS = {
-  '+': [ 'A' ],
-  '-': [ undefined ],  // disabled RR
-  '%': [ 'location' ],
-  '.': [ 'SOA', 'NS', 'A' ],
-  '&': [ 'NS', 'A' ],
-  '=': [ 'A', 'PTR' ],
-  '@': [ 'MX', 'A' ],
-  '#': [ 'comment' ],
-  "'": [ 'TXT' ],
-  '^': [ 'PTR' ],
-  'C': [ 'CNAME' ],
-  'Z': [ 'SOA' ],
-  ':': [ 'generic' ],
-  '3': [ 'AAAA' ],
-  '6': [ 'AAAA', 'PTR' ],
-  'S': [ 'SRV' ],
+export const SPECIAL_CHARS = {
+  '+': ['A'],
+  '-': [undefined], // disabled RR
+  '%': ['location'],
+  '.': ['SOA', 'NS', 'A'],
+  '&': ['NS', 'A'],
+  '=': ['A', 'PTR'],
+  '@': ['MX', 'A'],
+  '#': ['comment'],
+  "'": ['TXT'],
+  '^': ['PTR'],
+  C: ['CNAME'],
+  Z: ['SOA'],
+  ':': ['generic'],
+  3: ['AAAA'],
+  6: ['AAAA', 'PTR'],
+  S: ['SRV'],
 }
 
 const octalRe = new RegExp(/\\(?:[1-7][0-7]{0,2}|[0-7]{2,3})/, 'g')
 
-export function escapeOctal (re, str) {
+export function escapeOctal(re, str) {
   let escaped = ''
-  str.split(/(.{1})/g).map(c => {
+  str.split(/(.{1})/g).map((c) => {
     escaped += re.test(c) ? charToOctal(c) : c
   })
   return escaped
 }
 
-export function octalToChar (str) {
+export function octalToChar(str) {
   // relace instances of \NNN with ASCII
-  return str.replace(octalRe, o => String.fromCharCode(parseInt(o.substring(1), 8)))
+  return str.replace(octalRe, (o) =>
+    String.fromCharCode(parseInt(o.substring(1), 8)),
+  )
 }
 
-export function octalToHex (str) {
+export function octalToHex(str) {
   // relace instances of \NNN with Hex
-  return str.replace(octalRe, o => {
+  return str.replace(octalRe, (o) => {
     // parseInt(n, 8) -> from octal to decimal
     //  .toString(16) -> decimal to hex
     return parseInt(o.substring(1), 8).toString(16).padStart(2, 0)
   })
 }
 
-export function octalToUInt8 (str) {
+export function octalToUInt8(str) {
   const b = Buffer.alloc(1)
-  b.writeUInt8(parseInt(str.substring(1,4), 8), 0)
+  b.writeUInt8(parseInt(str.substring(1, 4), 8), 0)
   return b.readUInt8()
 }
 
-export function octalToUInt16 (str) {
+export function octalToUInt16(str) {
   const b = Buffer.alloc(2)
-  b.writeUInt8(parseInt(str.substring(1,4), 8), 0)
-  b.writeUInt8(parseInt(str.substring(5,8), 8), 1)
+  b.writeUInt8(parseInt(str.substring(1, 4), 8), 0)
+  b.writeUInt8(parseInt(str.substring(5, 8), 8), 1)
   return b.readUInt16BE()
 }
 
-export function octalToUInt32 (str) {
+export function octalToUInt32(str) {
   const b = Buffer.alloc(4)
-  b.writeUInt8(parseInt(str.substring(1,4), 8), 0)
-  b.writeUInt8(parseInt(str.substring(5,8), 8), 1)
-  b.writeUInt8(parseInt(str.substring(9,12), 8), 2)
-  b.writeUInt8(parseInt(str.substring(13,16), 8), 3)
+  b.writeUInt8(parseInt(str.substring(1, 4), 8), 0)
+  b.writeUInt8(parseInt(str.substring(5, 8), 8), 1)
+  b.writeUInt8(parseInt(str.substring(9, 12), 8), 2)
+  b.writeUInt8(parseInt(str.substring(13, 16), 8), 3)
   return b.readUInt32BE()
 }
 
-export function packString (str) {
-  return str.match(/(.{1,255})/g).map(s => {
-    const len = Buffer.alloc(1)
-    len.writeUInt8(s.length)
-    return `${UInt8toOctal(len.readUInt8(0))}${s}`
-  }).join('')
+export function packString(str) {
+  return str
+    .match(/(.{1,255})/g)
+    .map((s) => {
+      const len = Buffer.alloc(1)
+      len.writeUInt8(s.length)
+      return `${UInt8toOctal(len.readUInt8(0))}${s}`
+    })
+    .join('')
 }
 
-export function unpackString (str) {
+export function unpackString(str) {
   const asBuf = Buffer.from(octalToChar(str.toString()))
   const res = []
   let pos = 0
   let len
-  while ((len = asBuf.readUInt8(pos))) {  // encoded length byte
+  while ((len = asBuf.readUInt8(pos))) {
+    // encoded length byte
     pos++
     res.push(asBuf.slice(pos, pos + len).toString())
     pos = +(pos + len)
@@ -86,13 +91,13 @@ export function unpackString (str) {
   return res
 }
 
-export function packDomainName (fqdn) {
+export function packDomainName(fqdn) {
   const labelRegEx = new RegExp(/[^A-Za-z0-9-.]/, 'g')
 
   // RFC 1035, 3.3 Standard RRs
   // The standard wire format for DNS names. (1 octet length + octets)
   let packed = ''
-  fqdn.split('.').map(label => {
+  fqdn.split('.').map((label) => {
     if (label === undefined || !label.length) return
 
     const len = Buffer.alloc(1)
@@ -105,14 +110,14 @@ export function packDomainName (fqdn) {
   return packed
 }
 
-export function unpackDomainName (fqdn) {
-
+export function unpackDomainName(fqdn) {
   fqdn = Buffer.from(octalToChar(fqdn.toString()))
 
   const labels = []
   let pos = 0
   let len
-  while ((len = fqdn.readUInt8(pos))) {  // encoded length byte
+  while ((len = fqdn.readUInt8(pos))) {
+    // encoded length byte
     pos++
     labels.push(fqdn.slice(pos, pos + len).toString())
     pos = +(pos + len)
@@ -120,31 +125,31 @@ export function unpackDomainName (fqdn) {
   const r = `${labels.join('.')}.`
   // char position + length of last label + label length chars + null byte
   const strLen = pos + len + labels.length * 4 + 1
-  return [ r, strLen ]
+  return [r, strLen]
 }
 
-export function packHex (str) {
+export function packHex(str) {
   let r = ''
-  for (let i = 0; i < str.length; i = i+2) {
+  for (let i = 0; i < str.length; i = i + 2) {
     // nibble off 2 hex bytes, encode to octal
-    r += UInt8toOctal(parseInt(str.slice(i, i+2), 16))
+    r += UInt8toOctal(parseInt(str.slice(i, i + 2), 16))
   }
   return r
 }
 
-export function charToOctal (c) {
+export function charToOctal(c) {
   if (typeof c === 'number') return UInt8toOctal(c)
 
   return UInt8toOctal(c.charCodeAt(0))
 }
 
-export function UInt8toOctal (n) {
+export function UInt8toOctal(n) {
   if (n > 255) throw new Error('UInt8toOctal does not work on numbers > 255')
 
   return `\\${parseInt(n, 10).toString(8).padStart(3, 0)}`
 }
 
-export function UInt16toOctal (n) {
+export function UInt16toOctal(n) {
   let r = ''
   const pri = Buffer.alloc(2)
   pri.writeUInt16BE(n)
@@ -153,7 +158,7 @@ export function UInt16toOctal (n) {
   return r
 }
 
-export function UInt32toOctal (n) {
+export function UInt32toOctal(n) {
   let r = ''
   const pri = Buffer.alloc(4)
   pri.writeUInt32BE(n)
@@ -163,24 +168,26 @@ export function UInt32toOctal (n) {
   return r
 }
 
-export function ipv4toOctal (ip) {
+export function ipv4toOctal(ip) {
   return UInt32toOctal(ip.split`.`.reduce((int, value) => int * 256 + +value))
 }
 
-export function octalToIPv4 (str) {
+export function octalToIPv4(str) {
   const asInt = octalToUInt32(str)
-  return [ 24,16,8,0 ].map(n => (asInt >> n) & 0xff).join('.')
+  return [24, 16, 8, 0].map((n) => (asInt >> n) & 0xff).join('.')
 }
 
-export function base64toOctal (str) {
+export function base64toOctal(str) {
   const bytes = Buffer.from(str, 'base64')
   let escaped = ''
   for (const b of bytes) {
-    escaped += /[A-Za-z0-9\-.]/.test(String.fromCharCode(b)) ? String.fromCharCode(b) : UInt8toOctal(b)
+    escaped += /[A-Za-z0-9\-.]/.test(String.fromCharCode(b))
+      ? String.fromCharCode(b)
+      : UInt8toOctal(b)
   }
   return escaped
 }
 
-export function octalToBase64 (str) {
+export function octalToBase64(str) {
   return Buffer.from(octalToChar(str), 'binary').toString('base64')
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nictool/dns-resource-record",
-  "version": "1.1.7",
+  "version": "1.2.1",
   "description": "DNS Resource Records",
   "main": "index.js",
   "type": "module",
@@ -39,7 +39,6 @@
   },
   "homepage": "https://github.com/NicTool/dns-resource-record#readme",
   "devDependencies": {
-    "eslint": "^8.56.0",
     "mocha": "^10.3.0"
   }
 }

package/rr/a.js

@@ -1,57 +1,66 @@
-
-import net from 'net'
+import net from 'node:net'
 
 import RR from '../rr.js'
 
 export default class A extends RR {
-  constructor (opts) {
+  constructor(opts) {
     super(opts)
   }
 
   /****** Resource record specific setters   *******/
-  setAddress (val) {
-    if (!val) throw new Error('A: address is required')
-    if (!net.isIPv4(val)) throw new Error('A address must be IPv4')
+  setAddress(val) {
+    if (!val) this.throwHelp('A: address is required')
+    if (!net.isIPv4(val)) this.throwHelp('A address must be IPv4')
     this.set('address', val)
   }
 
-  getDescription () {
+  getDescription() {
     return 'Address'
   }
 
-  getRdataFields (arg) {
-    return [ 'address' ]
+  getRdataFields(arg) {
+    return ['address']
   }
 
-  getRFCs () {
-    return [ 1035 ]
+  getRFCs() {
+    return [1035]
   }
 
-  getTypeId () {
+  getTypeId() {
     return 1
   }
 
+  getCanonical() {
+    return {
+      owner: 'host.example.com.',
+      class: 'IN',
+      ttl: 3600,
+      type: 'A',
+      address: '192.0.2.127',
+    }
+  }
+
   /******  IMPORTERS   *******/
-  fromTinydns (opts) {
+  fromTinydns(opts) {
     // +fqdn:ip:ttl:timestamp:lo
-    const [ owner, ip, ttl, ts, loc ] = opts.tinyline.substring(1).split(':')
+    const [owner, ip, ttl, ts, loc] = opts.tinyline.substring(1).split(':')
 
     return new A({
-      owner    : this.fullyQualify(owner),
-      type     : 'A',
-      address  : ip,
-      ttl      : parseInt(ttl, 10),
+      owner: this.fullyQualify(owner),
+      type: 'A',
+      address: ip,
+      ttl: parseInt(ttl, 10),
       timestamp: ts,
-      location : loc !== '' && loc !== '\n' ? loc : '',
+      location: loc !== '' && loc !== '\n' ? loc : '',
     })
   }
 
-  fromBind (opts) {
+  fromBind(opts) {
     // test.example.com  3600  IN  A  192.0.2.127
-    const [ owner, ttl, c, type, address ] = opts.bindline.split(/\s+/)
+    const [owner, ttl, c, type, address] = opts.bindline.split(/\s+/)
     return new A({
       owner,
-      ttl  : parseInt(ttl, 10),
+      ttl: parseInt(ttl, 10),
       class: c,
       type,
       address,
@@ -59,7 +68,7 @@ export default class A extends RR {
   }
 
   /******  EXPORTERS   *******/
-  toTinydns () {
+  toTinydns() {
     return `+${this.getTinyFQDN('owner')}:${this.get('address')}:${this.getTinydnsPostamble()}\n`
   }
 }

package/rr/aaaa.js

@@ -1,86 +1,97 @@
-
-import net from 'net'
+import net from 'node:net'
 
 import RR from '../rr.js'
 import * as TINYDNS from '../lib/tinydns.js'
 
 export default class AAAA extends RR {
-  constructor (opts) {
+  constructor(opts) {
     super(opts)
   }
 
   /****** Resource record specific setters   *******/
-  setAddress (val) {
-    if (!val) throw new Error('AAAA: address is required')
-    if (!net.isIPv6(val)) throw new Error(`AAAA: address must be IPv6 (${val})`)
+  setAddress(val) {
+    if (!val) this.throwHelp('AAAA: address is required')
+    if (!net.isIPv6(val)) this.throwHelp(`AAAA: address must be IPv6 (${val})`)
 
     this.set('address', this.expand(val.toLowerCase())) // lower case: RFC 5952
   }
 
-  getCompressed (val) {
+  getCompressed(val) {
     this.compress(val || this.get('address'))
   }
 
-  getDescription () {
+  getDescription() {
     return 'Address IPv6'
   }
 
-  getRdataFields (arg) {
-    return [ 'address' ]
+  getRdataFields(arg) {
+    return ['address']
   }
 
-  getRFCs () {
-    return [ 3596 ]
+  getRFCs() {
+    return [3596]
   }
 
-  getTypeId () {
+  getTypeId() {
     return 28
   }
 
+  getCanonical() {
+    return {
+      owner: 'host.example.com.',
+      address: '2001:0db8:0020:000a:0000:0000:0000:0004',
+      class: 'IN',
+      ttl: 3600,
+      type: 'A',
+    }
+  }
+
   /******  IMPORTERS   *******/
-  fromTinydns (opts) {
+  fromTinydns(opts) {
     const str = opts.tinyline
     let fqdn, ip, n, rdata, ttl, ts, loc
 
     switch (str[0]) {
       case ':':
         // GENERIC  =>  :fqdn:28:rdata:ttl:timestamp:lo
-        [ fqdn, n, rdata, ttl, ts, loc ] = str.substring(1).split(':')
-        if (n != 28) throw new Error('AAAA fromTinydns, invalid n')
-        ip = TINYDNS.octalToHex(rdata).match(/([0-9a-fA-F]{4})/g).join(':')
+        ;[fqdn, n, rdata, ttl, ts, loc] = str.substring(1).split(':')
+        if (n != 28) this.throwHelp('AAAA fromTinydns, invalid n')
+        ip = TINYDNS.octalToHex(rdata)
+          .match(/([0-9a-fA-F]{4})/g)
+          .join(':')
         break
       case '3':
       case '6':
         // AAAA     =>  3fqdn:ip:x:ttl:timestamp:lo
         // AAAA,PTR =>  6fqdn:ip:x:ttl:timestamp:lo
-        [ fqdn, rdata, ttl, ts, loc ] = str.substring(1).split(':')
+        ;[fqdn, rdata, ttl, ts, loc] = str.substring(1).split(':')
         ip = rdata.match(/(.{4})/g).join(':')
         break
     }
 
     return new AAAA({
-      owner    : this.fullyQualify(fqdn),
-      ttl      : parseInt(ttl, 10),
-      type     : 'AAAA',
-      address  : ip,
+      owner: this.fullyQualify(fqdn),
+      ttl: parseInt(ttl, 10),
+      type: 'AAAA',
+      address: ip,
       timestamp: ts,
-      location : loc !== '' && loc !== '\n' ? loc : '',
+      location: loc !== '' && loc !== '\n' ? loc : '',
     })
   }
 
-  fromBind (opts) {
+  fromBind(opts) {
     // test.example.com  3600  IN  AAAA  ...
-    const [ owner, ttl, c, type, ip ] = opts.bindline.split(/\s+/)
+    const [owner, ttl, c, type, ip] = opts.bindline.split(/\s+/)
     return new AAAA({
       owner,
-      ttl    : parseInt(ttl, 10),
-      class  : c,
+      ttl: parseInt(ttl, 10),
+      class: c,
       type,
       address: this.expand(ip),
     })
   }
 
-  compress (val) {
+  compress(val) {
     /*
      * RFC 5952
      * 4.1. Leading zeros MUST be suppressed...A single 16-bit 0000 field MUST be represented as 0.
@@ -88,10 +99,10 @@ export default class AAAA extends RR {
      * 4.2.2 The symbol "::" MUST NOT be used to shorten just one 16-bit 0 field.
      * 4.2.3 When choosing placement of a "::", the longest run...MUST be shortened
      * 4.3 The characters a-f in an IPv6 address MUST be represented in lowercase.
-    */
+     */
     let r = val
-      .replace(/0000/g, '0')             // 4.1 0000 -> 0
-      .replace(/:0+([1-9a-fA-F])/g, ':$1')  // 4.1 remove leading zeros
+      .replace(/0000/g, '0') // 4.1 0000 -> 0
+      .replace(/:0+([1-9a-fA-F])/g, ':$1') // 4.1 remove leading zeros
 
     const mostConsecutiveZeros = [
       new RegExp(/0?(?::0){6,}:0?/),
@@ -111,7 +122,7 @@ export default class AAAA extends RR {
     return r
   }
 
-  expand (val, delimiter) {
+  expand(val, delimiter) {
     if (delimiter === undefined) delimiter = ':'
 
     const colons = val.match(/:/g)
@@ -121,15 +132,18 @@ export default class AAAA extends RR {
     }
 
     // restore compressed leading zeros
-    return val.split(':').map(s => s.padStart(4, 0)).join(delimiter)
+    return val
+      .split(':')
+      .map((s) => s.padStart(4, 0))
+      .join(delimiter)
   }
 
   /******  EXPORTERS   *******/
-  toBind (zone_opts) {
+  toBind(zone_opts) {
     return `${this.getPrefix(zone_opts)}\t${this.compress(this.get('address'))}\n`
   }
 
-  toTinydns () {
+  toTinydns() {
     // from AAAA notation (8 groups of 4 hex digits) to 16 escaped octals
     const rdata = TINYDNS.packHex(this.expand(this.get('address'), ''))
     return this.getTinydnsGeneric(rdata)