@nictool/dns-resource-record 1.4.0 → 1.6.0

package/rr/txt.js

@@ -16,25 +16,39 @@ export default class TXT extends RR {
     return 'Text'
   }
 
+  getTags() {
+    return ['common']
+  }
+
   getRdataFields(arg) {
     return ['data']
   }
 
   getRFCs() {
-    return [1035]
+    return [1035, 4408, 7208, 6376]
   }
 
   getTypeId() {
     return 16
   }
 
+  getCanonical() {
+    return {
+      owner: 'example.com.',
+      ttl: 3600,
+      class: 'IN',
+      type: 'TXT',
+      data: 'v=spf1 mx -all',
+    }
+  }
+
   /******  IMPORTERS   *******/
-  fromTinydns(opts) {
-    const str = opts.tinyline
+  fromTinydns({ tinyline }) {
+    const str = tinyline
     let fqdn, rdata, s, ttl, ts, loc
     // 'fqdn:s:ttl:timestamp:lo
     if (str[0] === "'") {
-      ;[fqdn, s, ttl, ts, loc] = str.substring(1).split(':')
+      ;[fqdn, s, ttl, ts, loc] = str.slice(1).split(':')
       rdata = TINYDNS.octalToChar(s)
     } else {
       ;[fqdn, rdata, ttl, ts, loc] = this.fromTinydnsGeneric(str)
@@ -46,14 +60,14 @@ export default class TXT extends RR {
       type: 'TXT',
       data: rdata,
       timestamp: ts,
-      location: loc !== '' && loc !== '\n' ? loc : '',
+      location: loc?.trim() || '',
     })
   }
 
   fromTinydnsGeneric(str) {
     // generic: :fqdn:n:rdata:ttl:timestamp:location
     // eslint-disable-next-line prefer-const
-    let [fqdn, n, rdata, ttl, ts, loc] = str.substring(1).split(':')
+    let [fqdn, n, rdata, ttl, ts, loc] = str.slice(1).split(':')
     if (n != 16) this.throwHelp('TXT fromTinydns, invalid n')
 
     rdata = TINYDNS.octalToChar(rdata)
@@ -61,19 +75,18 @@ export default class TXT extends RR {
     let len = rdata[0].charCodeAt(0)
     let pos = 1
     while (pos < rdata.length) {
-      s += rdata.substring(pos, +(len + pos))
+      s += rdata.slice(pos, +(len + pos))
       pos = len + pos
       len = rdata.charCodeAt(pos + 1)
     }
     return [fqdn, s, ttl, ts, loc]
   }
 
-  fromBind(opts) {
+  fromBind({ bindline }) {
     // test.example.com  3600  IN  TXT  "..."
-    const regex =
-      /^(?<owner>[\S]{1,255})\s+(?<ttl>\d{1,10})\s+(?<cls>IN)\s+(?<type>\w{3})\s+?\s*(?<rdata>.+?)$/i
-    const match = opts.bindline.trim().match(regex)
-    if (!match) this.throwHelp(`unable to parse TXT: ${opts.bindline}`)
+    const regex = /^(?<owner>\S{1,255})\s+(?<ttl>\d{1,10})\s+(?<cls>IN)\s+(?<type>\w{3})\s+(?<rdata>\S.*)$/i
+    const match = bindline.trim().match(regex)
+    if (!match) this.throwHelp(`unable to parse TXT: ${bindline}`)
 
     const { owner, ttl, cls, type, rdata } = match.groups
 
@@ -99,6 +112,12 @@ export default class TXT extends RR {
     return `${this.get('owner')}\t+${this.get('ttl')}\t${this.get('type')}\t'${data}' ~\n`
   }
 
+  getWireRdata() {
+    let data = this.get('data')
+    if (Array.isArray(data)) data = data.join('')
+    return packStringWire(data)
+  }
+
   toTinydns() {
     let data = this.get('data')
     if (Array.isArray(data)) data = data.join('')
@@ -128,3 +147,18 @@ function asQuotedStrings(data) {
 
   return data
 }
+
+function packStringWire(str) {
+  const parts = str.match(/(.{1,255})/g)
+  let len = 0
+  for (const part of parts) len += part.length + 1
+
+  const buf = Buffer.allocUnsafe(len)
+  let offset = 0
+  for (const part of parts) {
+    buf.writeUInt8(part.length, offset++)
+    buf.write(part, offset, 'ascii')
+    offset += part.length
+  }
+  return buf
+}

package/rr/uri.js

@@ -27,26 +27,26 @@ export default class URI extends RR {
   }
 
   /******  IMPORTERS   *******/
-  fromTinydns(opts) {
+  fromTinydns({ tinyline }) {
     // URI via generic, :fqdn:n:rdata:ttl:timestamp:lo
-    const [fqdn, n, rdata, ttl, ts, loc] = opts.tinyline.substring(1).split(':')
+    const [fqdn, n, rdata, ttl, ts, loc] = tinyline.slice(1).split(':')
     if (n != 256) this.throwHelp('URI fromTinydns, invalid n')
 
     return new URI({
       type: 'URI',
       owner: this.fullyQualify(fqdn),
-      priority: TINYDNS.octalToUInt16(rdata.substring(0, 8)),
-      weight: TINYDNS.octalToUInt16(rdata.substring(8, 16)),
-      target: TINYDNS.octalToChar(rdata.substring(16)),
+      priority: TINYDNS.octalToUInt16(rdata.slice(0, 8)),
+      weight: TINYDNS.octalToUInt16(rdata.slice(8, 16)),
+      target: TINYDNS.octalToChar(rdata.slice(16)),
       ttl: parseInt(ttl, 10),
       timestamp: ts,
-      location: loc.trim() || '',
+      location: loc?.trim() ?? '',
     })
   }
 
-  fromBind(opts) {
+  fromBind({ bindline }) {
     // test.example.com  3600  IN  URI  priority, weight, target
-    const [owner, ttl, c, type, priority, weight, target] = opts.bindline.split(/\s+/)
+    const [owner, ttl, c, type, priority, weight, target] = bindline.split(/\s+/)
     return new URI({
       class: c,
       type: type,
@@ -75,6 +75,18 @@ export default class URI extends RR {
     return 256
   }
 
+  getCanonical() {
+    return {
+      owner: 'www.example.com.',
+      ttl: 3600,
+      class: 'IN',
+      type: 'URI',
+      priority: 10,
+      weight: 10,
+      target: 'http://www.example.com/',
+    }
+  }
+
   getQuotedFields() {
     return ['target']
   }

package/rr/wks.js

@@ -29,6 +29,10 @@ export default class WKS extends RR {
     return 'Well Known Service'
   }
 
+  getTags() {
+    return ['obsolete']
+  }
+
   getRdataFields(arg) {
     return ['address', 'protocol', 'bit map']
   }
@@ -41,11 +45,23 @@ export default class WKS extends RR {
     return 11
   }
 
+  getCanonical() {
+    return {
+      owner: 'host.example.com.',
+      ttl: 3600,
+      class: 'IN',
+      type: 'WKS',
+      address: '192.0.2.1',
+      protocol: 'TCP',
+      'bit map': 'ftp smtp',
+    }
+  }
+
   /******  IMPORTERS   *******/
 
-  fromBind(opts) {
+  fromBind({ bindline }) {
     // test.example.com  3600  IN  WKS 192.168.1.1 TCP ftp smtp
-    const parts = opts.bindline.split(/\s+/)
+    const parts = bindline.split(/\s+/)
     const [owner, ttl, c, type, address, protocol] = parts
     return new WKS({
       owner,
@@ -58,6 +74,30 @@ export default class WKS extends RR {
     })
   }
 
+  fromTinydns({ tinyline }) {
+    const [owner, _typeId, rdata, ttl, ts, loc] = tinyline.slice(1).split(':')
+
+    const binary = Buffer.from(TINYDNS.octalToChar(rdata), 'binary')
+    const address = [binary.readUInt8(0), binary.readUInt8(1), binary.readUInt8(2), binary.readUInt8(3)].join(
+      '.',
+    )
+    const protoNum = binary.readUInt8(4)
+    const protoMap = { 6: 'TCP', 17: 'UDP' }
+    const protocol = protoMap[protoNum] ?? protoNum
+    const bitmap = binary.slice(5).toString()
+
+    return new WKS({
+      owner: this.fullyQualify(owner),
+      ttl: parseInt(ttl, 10),
+      type: 'WKS',
+      address,
+      protocol,
+      'bit map': bitmap,
+      timestamp: ts,
+      location: loc?.trim() ?? '',
+    })
+  }
+
   /******  EXPORTERS   *******/
 
   toTinydns() {

package/rr.js

@@ -1,13 +1,15 @@
+import * as TINYDNS from './lib/tinydns.js'
+
 export default class RR extends Map {
   constructor(opts) {
     super()
 
     if (opts === null) return
 
-    if (opts.default) this.default = opts.default
+    if (opts?.default) this.default = opts.default
 
-    if (opts.bindline) return this.fromBind(opts)
-    if (opts.tinyline) return this.fromTinydns(opts)
+    if (opts?.bindline) return this.fromBind(opts)
+    if (opts?.tinyline) return this.fromTinydns(opts)
 
     // tinydns specific
     this.setLocation(opts?.location)
@@ -21,10 +23,10 @@ export default class RR extends Map {
     for (const f of this.getFields('rdata')) {
       const fnName = `set${this.ucFirst(f)}`
       if (this[fnName] === undefined) this.throwHelp(`Missing ${fnName} in class ${this.get('type')}`)
-      this[fnName](opts[f])
+      this[fnName](opts?.[f])
     }
 
-    if (opts.comment) this.set('comment', opts.comment)
+    if (opts?.comment) this.set('comment', opts.comment)
   }
 
   ucFirst(str) {
@@ -91,7 +93,7 @@ export default class RR extends Map {
   }
 
   setTtl(t) {
-    if (t === undefined) t = this?.default?.ttl
+    t = t ?? this.default?.ttl
     if (t === undefined) {
       if (['SOA', 'SSHPF'].includes(this.get('type'))) return
       this.throwHelp('TTL is required, no default available')
@@ -157,7 +159,7 @@ export default class RR extends Map {
   }
 
   getEmpty(prop) {
-    return this.get(prop) === undefined ? '' : this.get(prop)
+    return this.get(prop) ?? ''
   }
 
   getComment(prop) {
@@ -184,6 +186,10 @@ export default class RR extends Map {
     return []
   }
 
+  getTags() {
+    return []
+  }
+
   getFields(arg) {
     const commonFields = ['owner', 'ttl', 'class', 'type']
     Object.freeze(commonFields)
@@ -307,6 +313,80 @@ export default class RR extends Map {
     )
   }
 
+  compressIPv6(val) {
+    //  * RFC 5952
+    //  * 4.1. Leading zeros MUST be suppressed...A single 16-bit 0000 field MUST be represented as 0.
+    //  * 4.2.1 The use of the symbol "::" MUST be used to its maximum capability.
+    //  * 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.
+
+    // 4.3 Lowercase and 4.1 remove leading zeros per segment
+    const segments = val
+      .toLowerCase()
+      .split(':')
+      .map((s) => s.replace(/^0+/, '') || '0')
+
+    let bestStart = -1
+    let bestLen = 0
+    let curStart = -1
+    let curLen = 0
+
+    // 4.2.1 & 4.2.3 Find the longest consecutive run of '0'
+    for (let i = 0; i < segments.length; i++) {
+      if (segments[i] === '0') {
+        if (curStart === -1) curStart = i
+        curLen++
+        if (curLen > bestLen) {
+          bestLen = curLen
+          bestStart = curStart
+        }
+      } else {
+        curStart = -1
+        curLen = 0
+      }
+    }
+
+    // 4.2.2 Don't shorten a single 16-bit 0 field
+    if (bestLen < 2) {
+      return segments.join(':')
+    }
+
+    const head = segments.slice(0, bestStart).join(':')
+    const tail = segments.slice(bestStart + bestLen).join(':')
+
+    return `${head}::${tail}`
+  }
+
+  octalToBuffer(octalStr) {
+    return Buffer.from(TINYDNS.octalToChar(octalStr), 'binary')
+  }
+
+  wirePackDomain(fqdn) {
+    return packDomainNameWire(fqdn)
+  }
+
+  getWireRdata() {
+    const line = this.toTinydns()
+    if (!line.startsWith(':'))
+      throw new Error(`${this.get('type')}: override getWireRdata() — non-generic tinydns format`)
+    // line: :fqdn:typeId:rdata:ttl:ts:loc\n
+    const rdata = line.split(':')[3]
+    return this.octalToBuffer(rdata ?? '')
+  }
+
+  toWire() {
+    const rdata = this.getWireRdata()
+    const owner = this.wirePackDomain(this.get('owner'))
+    const classMap = { IN: 1, CS: 2, CH: 3, HS: 4, NONE: 254, ANY: 255 }
+    const meta = Buffer.alloc(10)
+    meta.writeUInt16BE(this.getTypeId(), 0)
+    meta.writeUInt16BE(classMap[this.get('class')] ?? 1, 2)
+    meta.writeUInt32BE(this.get('ttl'), 4)
+    meta.writeUInt16BE(rdata.length, 8)
+    return Buffer.concat([owner, meta, rdata])
+  }
+
   toBind(zone_opts) {
     return `${this.getPrefix(zone_opts)}\t${this.getRdataFields()
       .map((f) => this.getQuoted(f))
@@ -331,3 +411,25 @@ export default class RR extends Map {
       .join(' ')}' ~\n`
   }
 }
+
+function packDomainNameWire(fqdn) {
+  if (fqdn === '.') return Buffer.from([0])
+  const parts = fqdn.split('.')
+  let len = 0
+  for (const part of parts) {
+    if (part.length > 0) len += part.length + 1
+  }
+  len += 1 // for the final \0
+
+  const buf = Buffer.allocUnsafe(len)
+  let offset = 0
+  for (const part of parts) {
+    if (part.length > 0) {
+      buf.writeUInt8(part.length, offset++)
+      buf.write(part, offset, 'ascii')
+      offset += part.length
+    }
+  }
+  buf.writeUInt8(0, offset)
+  return buf
+}