release 0.3.0

CHANGES.md

@@ -2,6 +2,24 @@
 #### 1.N.N - YYYY-MM-DD
 
 
+#### 0.3.0 - 2022-03-24
+
+- import
+    - added CLI options
+    - added tinydns ingest support
+    - encapsulated output logic
+- pass zone_opts to RR exporter
+- export: add JSON
+- index: import fullyQualify from dns-rr
+- grammar
+    - improved ip6 compressed parsing
+    - add PTR support in bind zone files
+- test
+    - added zonefile example.com, localhost
+    - added relative CNAME test
+- README: expand with examples
+
+
 #### 0.2.0 - 2022-03-22
 
 - add expandShortcuts

README.md

@@ -19,14 +19,175 @@ Etc, etc, etc..
 This module will input a collection of [dns-resource-records](https://github.com/msimerson/dns-resource-record) and validate that all the zone records can coexist.
 
 
+## BIN/IMPORT
+
+#### show help
+
+````
+➜ dns-zone-validator ✗ ./bin/import.js -h
+
+ +-+-+-+ +-+-+-+-+
+ |D|N|S| |Z|O|N|E|
+ +-+-+-+ +-+-+-+-+
+
+I/O
+
+  -i, --import <stdin | file path>            source of DNS zone data (default: stdin) 
+  -e, --export <js | json | bind | tinydns>   zone data export format (default: js)    
+
+Zone Settings
+
+  -o, --origin string   zone $ORIGIN             
+  -t, --ttl number      zone default TTL         
+  -c, --class string    zone class (default: IN) 
+
+Output Options
+
+  --hide-origin    remove origin from RR domain names (default: false) 
+  --hide-class     hide class (default: false)                         
+  --hide-ttl       hide TTLs (default: false)                          
+
+Misc
+
+  -v, --verbose    Show status messages during processing 
+  -h, --help       Display this usage guide               
+
+Examples
+
+  1. BIND file to tinydns      ./bin/import -i ./isi.edu -e tinydns 
+  2. BIND file to JS objects   ./bin/import -i ./isi.edu            
+  3. tinydns file to BIND      ./bin/import -i ./data -e bind       
+
+  Project home: https://github.com/msimerson/dns-zone-validator 
+````
+
+
+#### import to JS
+
+````
+➜ cat isi.edu | ./bin/import.js --origin=isi.edu
+[
+  SOA(12) [Map] {
+    'name' => 'isi.edu.',
+    'ttl' => 60,
+    'class' => 'IN',
+    'type' => 'SOA',
+    'mname' => 'venera.isi.edu.',
+    'rname' => 'action.domains.isi.edu.',
+    'serial' => 20,
+    'refresh' => 7200,
+    'retry' => 600,
+    'expire' => 3600000,
+    'minimum' => 60,
+    'comment' => {
+      serial: '     ; SERIAL',
+      refresh: '   ; REFRESH',
+      retry: '    ; RETRY',
+      expire: '; EXPIRE',
+      minimum: ''
+    }
+  },
+  NS(5) [Map] {
+    'name' => 'isi.edu.',
+    'ttl' => 60,
+    'class' => 'IN',
+    'type' => 'NS',
+    'dname' => 'a.isi.edu.'
+  },
+...<snip>...
+  A(5) [Map] {
+    'name' => 'vaxa.isi.edu.',
+    'ttl' => 60,
+    'class' => 'IN',
+    'type' => 'A',
+    'address' => '128.9.0.33'
+  }
+]
+````
+
+#### to bind
+
+````
+➜ ./bin/import.js -i isi.edu -e bind
+$TTL    60
+$ORIGIN isi.edu.
+isi.edu.    IN  SOA venera.isi.edu. action.domains.isi.edu. (
+          20     ; SERIAL
+          7200   ; REFRESH
+          600    ; RETRY
+          3600000; EXPIRE
+          60
+          )
+
+isi.edu.    60  IN  NS  A.ISI.EDU.
+isi.edu.    60  IN  NS  venera.isi.edu.
+isi.edu.    60  IN  NS  vaxa.isi.edu.
+isi.edu.    60  IN  MX  10  venera.isi.edu.
+isi.edu.    60  IN  MX  20  vaxa.isi.edu.
+a   60  IN  A   26.3.0.103
+venera  60  IN  A   10.1.0.52
+venera  60  IN  A   128.9.0.32
+vaxa    60  IN  A   10.2.0.27
+vaxa    60  IN  A   128.9.0.33
+````
+
+#### to bind (relative)
+
+````
+➜ ./bin/import.js -i isi.edu -e bind --ttl=60 --hide-ttl --hide-class --hide-origin
+$TTL  60
+$ORIGIN isi.edu.
+@ IN  SOA venera  action.domains (
+    20     ; SERIAL
+    7200   ; REFRESH
+    600    ; RETRY
+    3600000; EXPIRE
+    60
+    )
+
+@     NS  a
+@     NS  venera
+@     NS  vaxa
+@     MX  10  venera
+@     MX  20  vaxa
+a     A 26.3.0.103
+venera      A 10.1.0.52
+venera      A 128.9.0.32
+vaxa      A 10.2.0.27
+vaxa      A 128.9.0.33
+````
+
+
+#### to tinydns
+
+````
+➜  ./bin/import.js -i isi.edu -e tinydns
+Zisi.edu:venera.isi.edu:action.domains.isi.edu:20:7200:600:3600000:60:60::
+&isi.edu::A.ISI.EDU:60::
+&isi.edu::venera.isi.edu:60::
+&isi.edu::vaxa.isi.edu:60::
+@isi.edu::venera.isi.edu:10:60::
+@isi.edu::vaxa.isi.edu:20:60::
++a.isi.edu:26.3.0.103:60::
++venera.isi.edu:10.1.0.52:60::
++venera.isi.edu:128.9.0.32:60::
++vaxa.isi.edu:10.2.0.27:60::
++vaxa.isi.edu:128.9.0.33:60::
+````
+
 ## TODO
 
 - [ ] write a named.conf file parser
 - [x] write a bind zone file parser
+- [ ] write a tinydns data file parser
 - normalize the zone records
     - [x] expand `@` to zone name
     - [x] empty names are same as previous RR record
     - [x] missing TTLs inherit zone TTL, or zone MINIMUM
-    - [x] expand hostnames to FQDNs
+    - expand hostnames to FQDNs
         - [x] ALL: name field
-        - [x] MX: exchange, CNAME: cname, SOA: mname, rname, NS: dname
+        - [x] MX: exchange
+        - [x] CNAME: cname,
+        - [x] SOA: mname, rname,
+        - [x] NS,PTR: dname
+- [ ] validate zone rules