@nictool/dns-resource-record 1.1.3

package/.codeclimate.yml

@@ -0,0 +1,25 @@
+checks:
+  return-statements:
+    enabled: false
+  similar-code:
+    enabled: false
+  file-lines:
+    config:
+      threshold: 500
+  method-lines:
+    config:
+      threshold: 50
+  method-complexity:
+    config:
+      threshold: 10
+
+plugins:
+  eslint:
+    enabled: true
+    channel: "eslint-8"
+    config:
+      config: ".eslintrc.yaml"
+
+ratings:
+   paths:
+   - "**.js"

package/CHANGELOG.md

@@ -0,0 +1,253 @@
+
+#### N.N.N - YYYY-MM-DD
+
+
+#### 1.1.3 - 2022-05-29
+
+- chore: publish npm package in @nictool namespace
+
+
+#### 1.1.2 - 2022-05-28
+
+- chore(ci): replace .release with submodule
+- chore(ci): use GHA with shared workflows
+
+
+#### 1.1.1 - 2022-04-28
+
+- feat(DNSKEY): expanded algo from 1-5 to 1-16 (RFC 8624)
+    - warn if outside that range, not error
+- feat(HINFO): added to/from tinydns
+- test(dnskey): update fail test
+
+
+#### 1.1.0 - 2022-04-22
+
+- feat(tinydns): add ipv4toOctal, octalToIPv4, base64toOctal, octalToBase64
+- feat(DNSKEY,DS,IPSECKEY,TLSA): added to/fromTinydns support
+- feat(NAPTR): finished fromTinydns
+- feat(bindline & tinyline): pass in opts (was only line), so defaults (serial, ttl, etc) can be passed in.
+- fix(SSHFP): algo & fptype are 1 byte, not 2
+- fix:(cname): fully qualify the target
+- test: add tinydns.unpackDomainName, ipv4toOctal, octalToIPv4
+- test(SRV): add another test case (found a bug in NicTool 2)
+- test(IPSECKEY): expand test coverage
+- tinydns.unpackdomain: return fqdn + length, for RRs where the FQDN is part of the byte stream
+
+
+#### 1.0.1 - 2022-04-19
+
+- feat(IPSECKEY): added basic support
+- doc(README): update for ES module usage
+- fix: call is[8|16]BitInt() correctly
+- style: replace this.constructor with class name
+- test: show more results in test output
+- test(CERT): added two test cases
+- test(KEY): added valid test
+
+
+#### 1.0.0 - 2022-04-18
+
+- style: move rr/index to ./rr
+- test: add base.getRdataFields
+- style(esm): convert from CJS to ESM (ES6 module)
+- test: add base.getRdataFields
+
+
+#### 0.9.9 - 2022-04-14
+
+- feat: parser improvements (DNSKEY, HINFO, NAPTR, SOA, TLSA, TXT)
+- CAA: more robust fromBind parser
+- SOA: leave $TTL and $ORIGIN to dns-zone
+- test/base: improve invalid tests, check error message against expected
+- test/rr: update tests with expected error messages
+- README: move some content to web links
+
+
+#### 0.9.8 - 2022-04-07
+
+- url updates
+- fix: txt records
+- feat: add index.citeRFC
+- docs: updates
+
+
+#### 0.9.7 - 2022-03-29
+
+- index
+    - previousName -> previousOwner
+    - export a TYPE_MAP (id => name)
+- isValidHostname: allow \ char
+- add the word 'RFC' in error messages citing RFCs
+- when rejecting hostname, show the rejected character
+- maradns: add export support
+- add index.citeRFC
+
+
+#### 0.9.6 - 2022-03-27
+
+- rr\*: rename name -> owner (not overloaded)
+- RFC 4034: letters in DNS names are lower cased
+- README: added definitions
+- repo: move from msimerson -> NicTool org
+- add macos testing
+- add CERT, KEY, NSEC, NSEC3, NSEC3PARAM, OPENPGPKEY, SIG
+
+
+#### 0.9.5 - 2022-03-26
+
+- README: add docs for getRFCs()
+- dnskey: fix copy/paste errors
+- HINFO: add fromBind
+- RR.owner: if owner is same as previous, suppress (when sameOwner option is set)
+- master: NODE_ENV=cov when running coverage
+- TXT: pass along zone_opts
+
+
+#### 0.9.4 - 2022-03-24
+
+- add: getComment
+- zone_opts, for influencing output of toBind
+- normalize hostnames to lower case
+- add tests: fullyQualify, getFQDN
+- AAAA
+    - compress: rewrote per RFC 5952, added tests
+    - internally store address in expanded notation
+- fromTinydns: apply correct semantics for 'x' handling
+- fullyQualify
+    - special handling for @
+    - consider $ORIGIN
+- add uc hex chars to ip6 compress
+
+
+#### 0.9.3 - 2022-03-22
+
+- hasValidLabels: remove trailing dot, else split returns empty string
+- rename fullyQualified -> isFullyQualified
+- rename validHostname -> isValidHostname
+- set('type') no longer falls back on constructor.name (didn't reliably inherit)
+- new fns: getTinyFQDN, fullyQualify, getPrefix, getFQDN
+- when loading RR classes, ignore files that don't end with .js
+- rr/txt: support data as array (improves idempotency)
+- fromTinydns: fully qualify hostnames
+- toTinydns: strip trailing . upon export
+- rename getCommonFields -> getPrefixFields
+- TXT: import BIND format w/o mangling WS
+- SPF inherits from TXT
+
+
+#### 0.9.2 - 2022-03-18
+
+- mx: weight -> preference
+- ds: keytag -> key tag (consistent naming)
+- mx: add null MX test
+- more use of this.getRFCs in error messages
+- added getTinydnsGeneric
+- on `index.is*` functions which throw, use declaratively
+- class: add NONE and ANY
+- validHostname: allow / char
+- use \_\_dirname to find RR mods
+
+
+#### 0.9.1 - 2022-03-14
+
+- TLSA, SMIMEA: add BIND support #13
+
+
+#### 0.9.0 - 2022-03-10
+
+- added null object instantiation
+- added `getTypeId`, `getDescription`, `getRdataFields`, `getQuotedFields`
+- tinydns: refactored fromTinydnsGeneric
+- add `RR.toBind()` for most
+- spf: corrected RFC IDs
+- rr/\*: refactor init into RR.constructor
+- ds,dnskey: add to/from BIND support
+- README: significant expansion
+- tests: more signal, less noise
+- tests: import tests from nictool 2
+
+
+#### 0.8.1 - 2022-03-08
+
+- use RFC example IPs and zone names
+
+
+#### 0.8.0 - 2022-02-01
+
+- fromBind for: A, AAAA, CNAME, TXT, CNAME, TXT, LOC, MX, NS, SOA, PTR, SPF, SSHFP, URI, CAA, DNAME, NAPTR
+- add fromTinydns: LOC
+- rr/\*: add getFields
+
+
+#### 0.7.0 - 2021-10-26
+
+- tinydns: added octalToHex, octalToUInt16, unpackDomainName, octalToInt8
+- AAAA: added fromTinydns, compress, expand
+- CAA, CNAME, DNAME, SPF, SSHFP, SRV, URI: added fromTinydns
+- add tests for getRFCs
+
+
+#### 0.6.0 - 2021-10-25
+
+- tinydns: added octalToChar
+- A, MX, NS, PTR, SOA, TXT: added fromTinydns
+
+
+#### 0.5.1 - 2021-10-25
+
+- LOC: added toTinydns
+- tinydns: add UInt32toOctal
+- SRV: added support
+
+
+#### 0.5.0 - 2021-10-24
+
+- NAPTR: add toTinydns
+- tinydns: remove sprintf-js dependency
+
+
+#### 0.4.0 - 2021-10-22
+
+- CAA, DNAME, SSHFP, URI: add toTinydns
+- lib/tinydns: added packHex and UInt16AsOctal
+
+
+#### 0.3.1 - 2021-10-21
+
+- update index.js to also export RR sub classes
+- update README examples
+
+
+#### 0.3.0 - 2021-10-21
+
+- add getRFCs to all RR types
+- populate this.id with IANA type ID
+- toBind: use tabs for exported WS
+- CAA, DNAME, NAPTR, SSHFP, URI: add toBind, tests
+
+
+#### 0.2.3 - 2021-10-21
+
+- refactored classes into separate files
+- TXT, SOA, MX, CNAME, PTR, SRV: add toBind and toTinydns
+- SOA: add setMinimum
+- lib/tinydns: added escapeOct & packDomainName
+- PTR, SRV: added tests
+
+
+#### 0.2.2 - 2021-10-20
+
+- add tests/*
+- A, AAAA, add toBind and toTinydns()
+- add .release
+
+
+#### 0.2.1 - 2021-10-16
+
+- additional RR formats started, weakly validated
+
+
+#### 0.2.0 - 2021-10-16
+
+- initial release & name grab

package/DEVELOP.md

@@ -0,0 +1,23 @@
+
+# Release process
+
+In your local repo:
+
+- make your changes
+- git add .
+- `.release/do.sh` {major|minor|patch}
+- fill in the blanks in CHANGELOG.md
+- `.release/push.sh`
+
+Upon merge to `master`:
+
+- the new version will be published to NPM.
+- a GitHub release will be published.
+- a release tag will be committed to the repo.
+
+## Clean
+
+`.release/cleanup.sh`
+
+- will switch to the master branch
+- delete the release branch

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2021, Matt Simerson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,267 @@
+[![Module Tests](https://github.com/NicTool/dns-resource-record/actions/workflows/ci.yml/badge.svg)](https://github.com/NicTool/dns-resource-record/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/NicTool/dns-resource-record/badge.svg?branch=master)](https://coveralls.io/github/NicTool/dns-resource-record?branch=master)
+
+# dns-resource-record
+
+DNS resource record parser, validator, importer, and exporter.
+
+
+## SYNOPSIS
+
+This module is used to:
+
+- validate well formedness and RFC compliance of DNS resource records
+- import RRs from:
+    - JS object
+    - JSON
+    - [BIND](https://www.isc.org/bind/) zone [file format](https://bind9.readthedocs.io/en/latest/reference.html#zone-file)
+    - tinydns [data format](https://cr.yp.to/djbdns/tinydns-data.html)
+- export RRs to:
+    - BIND zone files
+    - tinydns data
+    - maradns
+    - JS object
+    - JSON
+
+This package intends to import and export RFC compliant DNS resource records. Please [raise an issue](https://github.com/NicTool/dns-resource-record/issues) if you cannot pass a valid resource record or you can pass an invalid resource record.
+
+This package is for working with _individual_ Resource Records. For working with zones of RRs, use [dns-zone](https://github.com/NicTool/dns-zone).
+
+
+## USAGE
+
+Load the index for access to all RR types:
+
+```js
+import * as RR from 'dns-resource-record'
+```
+
+### EXAMPLES
+
+```js
+const exampleRRs = {
+    A: {
+        owner  : 'test.example.com.',
+        type   : 'A',
+        address: '192.0.2.127',
+        ttl    : 3600,
+    },
+    AAAA: {
+        owner  : 'test.example.com.',
+        type   : 'AAAA',
+        address: '2605:7900:20:a::4',
+        ttl    : 3600,
+    },
+    SOA: {
+        owner  : 'example.com.',
+        type   : 'SOA',
+        mname  : 'matt.example.com.',
+        rname  : 'ns1.example.com.',
+        serial : 1,
+        refresh: 7200,
+        retry  : 3600,
+        expire : 1209600,
+        minimum: 3600,
+        ttl    : 3600,
+    }
+}
+try {
+    console.log(new RR.SOA(exampleRRs.SOA))
+    SOA(11) [Map] {
+        'owner' => 'example.com.',
+        'ttl' => 3600,
+        'class' => 'IN',
+        'type' => 'SOA',
+        'mname' => 'matt.example.com.',
+        'rname' => 'ns1.example.com.',
+        'serial' => 1,
+        'refresh' => 7200,
+        'retry' => 3600,
+        'expire' => 1209600,
+        'minimum' => 3600
+    }
+}
+catch (e) {
+    console.error(e.message) // invalid RRs throw
+}
+```
+
+Validate records by passing a properly formatted JS object to the record-specific class. To validate an A record:
+
+```js
+const validatedA = new RR.A(exampleRRs.A)
+```
+
+Manipulate the validated record using pattern named setters:
+
+```js
+console.log(validatedA.toBind())
+test.example.com.    3600    IN  A   192.0.2.127
+
+validatedA.setAddress('192.0.2.128')
+console.log(validatedA.toBind())
+test.example.com.    3600    IN  A   192.0.2.128
+```
+
+The setters are named: `set` + `Field`, where field is the resource record field name to modify. Multi-word names are camel cased, so a field named `Certificate Usage` has a setter named `setCertificateUsage`. The RFCs aren't always consistent regarding RR field names so aliases are permissible for interoperability.
+
+## FUNCTIONS
+
+Get the field names for each RR type with `getFields()`:
+
+```js
+> import * as RR from 'dns-resource-record'
+> new RR.A(null).getFields()
+[ 'owner', 'ttl', 'class', 'type', 'address' ]
+
+> new RR.PTR(null).getFields()
+[ 'owner', 'ttl', 'class', 'type', 'dname' ]
+
+> new RR.SSHFP(null).getFields()
+[ 'owner', 'ttl', 'class', 'type', 'algorithm', 'fptype', 'fingerprint' ]
+```
+
+Get a list of RFCs for references about each RR type:
+
+```js
+> new RR.A(null).getRFCs()
+[ 1035 ]
+
+> new RR.SRV(null).getRFCs()
+[ 2782 ]
+
+> new RR.MX(null).getRFCs()
+[ 1035, 2181, 7505 ]
+```
+
+### toBind
+
+Validate a record and export to BIND format.
+
+```js
+console.log(new RR.A(exampleRRs.A).toBind())
+test.example.com    3600    IN  A   192.0.2.127
+
+console.log(new RR.AAAA(exampleRRs.AAAA).toBind())
+test.example.com    3600    IN  AAAA    2605:7900:20:a::4
+```
+
+### toTinydns
+
+Validate a record and export to tinydns format:
+
+```js
+console.log(new RR.A(exampleRRs.A).toTinydns())
++test.example.com:192.0.2.127:3600::
+```
+
+### fromTinydns toBind
+
+Convert a tinydns line to BIND:
+
+```js
+console.log(new RR.CAA({
+  tinyline: ':ns1.example.com:257:\\000\\005issue"http\\072\\057\\057letsencrypt.org":3600::\n'
+}).toBind())
+ns1.example.com 3600    IN  CAA 0   issue   "http://letsencrypt.org"
+```
+
+### set
+
+The DNS validation checks can be bypassed entirely by using 'set':
+
+```js
+> validatedA.set('address', 'oops')
+A(5) [Map] {
+  'owner' => 'test.example.com',
+  'ttl' => 3600,
+  'class' => 'IN',
+  'type' => 'A',
+  'address' => 'oops'
+}
+```
+
+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.
+
+PRs are welcome, especially PRs with tests.
+
+| **RR**     | **toBind**       | **toTinydns**    | **fromBind**     |  **fromTinydns** |
+|:---------: |:----------------:|:----------------:|:----------------:|:----------------:|
+| **A**      |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **AAAA**   |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **CAA**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **CERT**   |                  |                  |                  |                  |
+| **CNAME**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **DNAME**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **DNSKEY** |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **DS**     |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **HINFO**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+|**IPSECKEY**|:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **KEY**    |                  |                  |                  |                  |
+| **LOC**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **MX**     |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **NAPTR**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **NS**     |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **NSEC**   |                  |                  |                  |                  |
+| **NSEC3**  |                  |                  |                  |                  |
+| **NSEC3PARAM**|               |                  |                  |                  |
+| **OPENPGPKEY**|               |                  |                  |                  |
+| **PTR**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **RRSIG**  |                  |                  |                  |                  |
+| **SIG**    |                  |                  |                  |                  |
+| **SMIMEA** |:white_check_mark:|                  |:white_check_mark:|                  |
+| **SOA**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **SPF**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **SRV**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **SSHFP**  |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **TLSA**   |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **TXT**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+| **URI**    |:white_check_mark:|:white_check_mark:|:white_check_mark:|:white_check_mark:|
+
+
+## TIPS
+
+- Domain owner names are:
+    - stored fully qualified, aka absolute.
+    - normalized to lower case, because:
+        - DNS is case insensitive (see RFCs 4343, 1035, 1034)
+        - this library enforces duplicate suppression
+        - DNSSEC canonicalization (see RFC 4034)
+        - wire format for most RRs require it
+    - Master Zone File expansions exist in [dns-zone](https://github.com/NicTool/dns-zone)
+- to{Bind|MaraDNS} output can be influenced (suppress TTL, class, relative domain names) with an options object. See it in `bin/dns-zone` in the [dns-zone](https://github.com/NicTool/dns-zone) package.
+
+
+## SEE ALSO
+
+- [Dictionary of DNS terms](https://nictool.github.io/web/Dictionary)
+- [Wikipedia, List of DNS Record Types](https://en.wikipedia.org/wiki/List_of_DNS_record_types)
+
+
+## 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
+
+- this package has no dependencies. That's no accident.
+- this will be used by a node.js app & a browser based app, so ES modules
+- platform independence is a goal
+    - [x] CI tests are on linux, windows, and macos

package/index.js

@@ -0,0 +1,67 @@
+
+import RR      from './rr.js'
+import A       from './rr/a.js'
+import AAAA    from './rr/aaaa.js'
+import CAA     from './rr/caa.js'
+import CERT    from './rr/cert.js'
+import CNAME   from './rr/cname.js'
+import DNAME   from './rr/dname.js'
+import DNSKEY  from './rr/dnskey.js'
+import DS      from './rr/ds.js'
+import HINFO   from './rr/hinfo.js'
+import IPSECKEY from './rr/ipseckey.js'
+import KEY     from './rr/key.js'
+import LOC     from './rr/loc.js'
+import MX      from './rr/mx.js'
+import NAPTR   from './rr/naptr.js'
+import NS      from './rr/ns.js'
+import NSEC    from './rr/nsec.js'
+import NSEC3   from './rr/nsec3.js'
+import NSEC3PARAM from './rr/nsec3param.js'
+import OPENPGPKEY from './rr/openpgpkey.js'
+import PTR     from './rr/ptr.js'
+import RRSIG   from './rr/rrsig.js'
+import SIG     from './rr/sig.js'
+import SMIMEA  from './rr/smimea.js'
+import SOA     from './rr/soa.js'
+import SPF     from './rr/spf.js'
+import SRV     from './rr/srv.js'
+import SSHFP   from './rr/sshfp.js'
+import TLSA    from './rr/tlsa.js'
+import TXT     from './rr/txt.js'
+import URI     from './rr/uri.js'
+
+export default RR
+
+export {
+  A,
+  AAAA,
+  CAA,
+  CERT,
+  CNAME,
+  DNAME,
+  DNSKEY,
+  DS,
+  HINFO,
+  IPSECKEY,
+  KEY,
+  LOC,
+  MX,
+  NAPTR,
+  NS,
+  NSEC,
+  NSEC3,
+  NSEC3PARAM,
+  OPENPGPKEY,
+  PTR,
+  RRSIG,
+  SIG,
+  SMIMEA,
+  SSHFP,
+  SOA,
+  SPF,
+  SRV,
+  TLSA,
+  TXT,
+  URI
+}