dns-zone 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7808869b41dd69a298305fa61daab900891251f
-  data.tar.gz: 163eeab6827fd8387f2405175a9f27d0b8fb5367
+  metadata.gz: ce394f29889d56814fe99dee138535282dc7031f
+  data.tar.gz: bee58379e2fdc3d33219b7dc95c0c6a4156f557f
 SHA512:
-  metadata.gz: 4049dc65b9e82fb08cbdc8b3e0bd4fccbc13f1ae906852da1cfb28e149b3f34bd4a717ebfc29470efa9d4daf3d2533d70fa514a9949d421810ea506bb63a4c9d
-  data.tar.gz: 9dc5ec1a5236725d891c8be12ded6e9925c37be1960bcf2ec9f39f361dea12479c433ab0e42e95e3db07987f1851e2d26edfc53cb0381932fb0e9789f952cc80
+  metadata.gz: b323d369cd33d0bdc2e2ad82b1cd9d4a39681ea1f7676cc25f048f0d3e946fc3d7d45c1cb2febe1aed622f2912ca484dc17d3459541617fd8cbb1f657752e1c8
+  data.tar.gz: 5560b853bf4ffb3883e842c6c90b7dd2dd6c2aa4163339afe16a3e085a75594b8a5c3aaddfb2244dc6a81d0ac6a82be126944f215c802a4553f35530df5c7f57

data/HISTORY.md

@@ -1,5 +1,24 @@
 ## HEAD
 
+## 0.2.0 (2015-10-20)
+
+Development sponsored by Peter J. Philipp [centroid.eu](http://centroid.eu)
+
+* Add support for DNSSEC focused RR Types:
+    - RFC 3403: NAPTR
+    - RFC 4255: SSHFP
+    - RFC 4034: DNSKEY, DS, RRSIG, NSEC
+    - RFC 7344: CDNSKEY, CDS
+    - RFC 4431: DLV
+    - RFC 5155: NSEC3, NSEC3PARAM
+* Allow unqualified `domain-name` labels.
+* Allow `ORIGIN` to be specified as an optional parameter when loading a zone, e.g. `zone = DNS::Zone.load(zone_as_string, 'example.com.')`
+
+# 0.1.4 (no gem release)
+
+* Add helper method to quickly access (or create) SOA.
+* Add `dump_pretty` method to `DNS::Zone`.
+
 ## 0.1.3 (2014-10-21)
 
 * Fix TXT record parsing bug, when quote enclosed RDATA contained semicolons.

data/README.md

@@ -3,8 +3,10 @@ dns-zone
 
 [![Build Status](https://secure.travis-ci.org/lantins/dns-zone.png?branch=master)](http://travis-ci.org/lantins/dns-zone)
 [![Gem Version](https://badge.fury.io/rb/dns-zone.png)](http://badge.fury.io/rb/dns-zone)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/lantins/dns-zone/blob/master/LICENSE)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/lantins/dns-zone/master/frames)
 
-A Ruby library for building and parsing DNS zone files.
+A Ruby library for building, parsing and manipulating DNS zone files.
 
 ## Installation
 
@@ -26,15 +28,26 @@ Require the gem in your code:
 
     zone = DNS::Zone.load(zone_as_string)
 
+### Loading a zone file, without an `$ORIGIN` directive
+
+    zone = DNS::Zone.load(zone_as_string, "example.com.")
+
 ### Creating a new zone programmatically
 
     zone = DNS::Zone.new
     zone.origin = 'example.com.'
     zone.ttl = '1d'
+    
+    # quick access to SOA RR
     zone.soa.nameserver = 'ns0.lividpenguin.com.'
     zone.soa.email = 'hostmaster.lividpenguin.com.'
-
-    # output as dns zone file
+    
+    # add an A RR
+    rec = DNS::Zone::RR::A.new
+    rec.address = '127.0.0.1'
+    zone.records << rec
+    
+    # output using dns zone file format
     zone.dump
 
 # Development
@@ -53,6 +66,12 @@ Require the gem in your code:
     # watch for changes and run development commands (tests, documentation, etc)
     bundle exec guard
 
+# Acknowledgement
+
+Special thanks to Peter J. Philipp [centroid.eu](http://centroid.eu) for sponsoring the 0.2.0 release of dns-zone.
+
+---
+
 # TODO
 
 ## Must have
@@ -71,6 +90,30 @@ Require the gem in your code:
     [x] Add support for RR Type: HINFO
     [x] Support loading zone where some records have an empty label
 
+    [x] Add support for RR Type: NAPTR (RFC 3403)
+    [x] Add support for RR Type: SSHFP (RFC 4255)
+
+    [ ] Add test using real bind zone file, with DNSSEC RR's.
+    [ ] Add support for DNSSEC (RFC 4034) RR Types:
+        [x] DNSKEY
+            [ ] Algorithm may be integer or mnemonic.
+        [x] RRSIG
+            [ ] Algorithm may be integer or mnemonic.
+        [x] NSEC
+            [ ] Handle "Type Bit Maps" better, much better...
+        [x] DS
+    [ ] Add support for DNSSEC (RFC 5155) RR Types:
+        [x] NSEC3
+        [x] NSEC3PARAM
+        [ ] Correctly handle "Presentation Format" as defined in RFC.
+
+    [x] Add support for DNSSEC (RFC 4431 & RFC 7344) RR Types:
+        [x] CDNSKEY (identical to DNSKEY)
+        [x] CDS (identical to DS)
+        [x] DLV (identical to DS)
+
+    [ ] Look at newly added DNSSEC RR's and rename fields to be more appropriate, where required.
+
 ## Would be nice
 
     [ ] Handle parsing a zone file that uses more then one $ORIGIN directive.
@@ -78,7 +121,7 @@ Require the gem in your code:
         [ ] Only one SOA per zone.
         [ ] CNAMEs can't use a label of `@`.
         [ ] PTR zones have some extra conditions:
-            [ ] labels cant be repeted
+            [ ] labels cant be repeated
             [ ] names should end in a dot, otherwise they are invalid after expansion
             [ ] IPv4 and IPv6 cant be mixed
 
@@ -93,17 +136,12 @@ Require the gem in your code:
             [ ] add comments to explain TTL's that are in seconds
     [ ] Ability to add comment to RR (n.b. currently we strip comments when parsing)
     [ ] Add support for RR Type: LOC (RFC 1876)
-    [ ] Add support for RR Type: DNAME
-    [ ] Add support for RR Type: DNSKEY
-    [ ] Add support for RR Type: DS
+    [ ] Add support for RR Type: DNAME (RFC 2672)
     [ ] Add support for RR Type: KEY
-    [ ] Add support for RR Type: NSEC
-    [ ] Add support for RR Type: RRSIG
-    [ ] Add support for RR Type: NAPTR
     [ ] Add support for RR Type: RP
     [ ] Add support for RR Type: RT
 
-# Notes
+# Misc. Development Notes
 
 - RR Format: `[<TTL>] [<class>] <type> <RDATA>`
 - A DNS zone is built from RR's and a couple of other special directives.

data/dns-zone.gemspec

@@ -12,7 +12,7 @@ spec = Gem::Specification.new do |s|
   s.email               = ['luke@lividpenguin.com']
 
   # gem settings for what files to include.
-  s.files               = %w(Rakefile README.md HISTORY.md Gemfile Guardfile dns-zone.gemspec)
+  s.files               = %w(Rakefile README.md HISTORY.md Gemfile dns-zone.gemspec)
   s.files              += Dir.glob('{test/**/*,lib/**/*}')
   s.require_paths       = ['lib']
   #s.executables         = ['dns-zone']
@@ -29,9 +29,9 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency('minitest',       '~> 5.0')
   s.add_development_dependency('simplecov',      '~> 0.7.1')
   s.add_development_dependency('yard',           '~> 0.8')
-  s.add_development_dependency('inch',           '~> 0.3')
+  s.add_development_dependency('inch',           '~> 0.6')
   s.add_development_dependency('guard-minitest', '~> 2.0')
-  s.add_development_dependency('guard-bundler',  '~> 0')
+  s.add_development_dependency('guard-bundler',  '~> 2.0')
 
   # long description.
   s.description       = <<-EOL

data/lib/dns/zone.rb

@@ -9,14 +9,52 @@ module DNS
   # This is also the primary namespace for the `dns-zone` gem.
   class Zone
 
-    attr_accessor :ttl, :origin, :records
-
+    # The default $TTL (directive) of the zone.
+    attr_accessor :ttl
+    # The primary $ORIGIN (directive) of the zone.
+    attr_accessor :origin
+    # Array of all the zones RRs (including the SOA).
+    attr_accessor :records
+
+    # Create an empty instance of a DNS zone that you can drive programmatically.
+    #
+    # @api public
     def initialize
       @records = []
+      soa = DNS::Zone::RR::SOA.new
+      # set a couple of defaults on the SOA
+      soa.serial = Time.now.utc.strftime("%Y%m%d01")    
+      soa.refresh_ttl = '3h'
+      soa.retry_ttl = '15m'
+      soa.expiry_ttl = '4w'
+      soa.minimum_ttl = '30m'
+    end
+
+    # Helper method to access the zones SOA RR.
+    #
+    # @api public
+    def soa
+      # return the first SOA we find in the records array.
+      rr = @records.find { |rr| rr.type == "SOA" }
+      return rr if rr
+      # otherwise create a new SOA
+      rr = DNS::Zone::RR::SOA.new
+      rr.serial = Time.now.utc.strftime("%Y%m%d01")    
+      rr.refresh_ttl = '3h'
+      rr.retry_ttl = '15m'
+      rr.expiry_ttl = '4w'
+      rr.minimum_ttl = '30m'
+      # store and return new SOA
+      @records << rr
+      return rr
     end
 
+    # Generates output of the zone and its records.
+    #
+    # @api public
     def dump
       content = []
+
       @records.each do |rr|
         content << rr.dump
       end
@@ -24,16 +62,26 @@ module DNS
       content.join("\n") << "\n"
     end
 
-    # FROM RFC:
-    #     The format of these files is a sequence of entries.  Entries are
-    #     predominantly line-oriented, though parentheses can be used to continue
-    #     a list of items across a line boundary, and text literals can contain
-    #     CRLF within the text.  Any combination of tabs and spaces act as a
-    #     delimiter between the separate items that make up an entry.  The end of
-    #     any line in the master file can end with a comment.  The comment starts
-    #     with a ";" (semicolon). 
+    # Generates pretty output of the zone and its records.
+    #
+    # @api public
+    def dump_pretty
+      content = []
+
+      last_type = "SOA"
+      sorted_records.each do |rr|
+        content << '' if last_type != rr.type
+        content << rr.dump
+        last_type = rr.type
+      end
+
+      content.join("\n") << "\n"
+    end
 
-    def self.load(string)
+    # Load the provided zone file data into a new DNS::Zone object.
+    #
+    # @api public
+    def self.load(string, default_origin = "")
       # get entries
       entries = self.extract_entries(string)
 
@@ -41,27 +89,43 @@ module DNS
 
       options = {}
       entries.each do |entry|
+        # read in special statments like $TTL and $ORIGIN
         if entry =~ /\$(ORIGIN|TTL)\s+(.+)/
           instance.ttl    = $2 if $1 == 'TTL'
           instance.origin = $2 if $1 == 'ORIGIN'
           next
         end
 
+        # parse each RR and create a Ruby object for it
         if entry =~ DNS::Zone::RR::REGEX_RR
           rec = DNS::Zone::RR.load(entry, options)
           next unless rec
           instance.records << rec
           options[:last_label] = rec.label
         end
+      end
 
+      # use default_origin if we didn't see a ORIGIN directive in the zone
+      if instance.origin.to_s.empty? && !default_origin.empty?
+        instance.origin = default_origin
       end
 
-      # read in special statments like $TTL and $ORIGIN
-      # parse each RR and create a Ruby object for it
       return instance
     end
 
+    # Extract entries from a zone file that will be later parsed as RRs.
+    #
+    # @api private
     def self.extract_entries(string)
+      # FROM RFC:
+      #     The format of these files is a sequence of entries.  Entries are
+      #     predominantly line-oriented, though parentheses can be used to continue
+      #     a list of items across a line boundary, and text literals can contain
+      #     CRLF within the text.  Any combination of tabs and spaces act as a
+      #     delimiter between the separate items that make up an entry.  The end of
+      #     any line in the master file can end with a comment.  The comment starts
+      #     with a ";" (semicolon). 
+
       entries = []
       mode = :line
       entry = ''
@@ -115,5 +179,25 @@ module DNS
       return entries
     end
 
+    private
+
+    # Records sorted with more important types being at the top.
+    #
+    # @api private
+    def sorted_records
+      # pull out RRs we want to stick near the top
+      top_rrs = {}
+      top = %w{SOA NS MX SPF TXT}
+      top.each { |t| top_rrs[t] = @records.select { |rr| rr.type == t } }
+
+      remaining = @records.reject { |rr| top.include?(rr.type) }
+
+      # sort remaining RRs by type, alphabeticly
+      remaining.sort! { |a,b| a.type <=> b.type }
+
+      top_rrs.values.flatten + remaining
+    end
+
+
   end
 end

data/lib/dns/zone/rr.rb

@@ -7,10 +7,13 @@ module DNS
 
       REGEX_TTL = /\d+[wdmhs]?/i
       REGEX_KLASS = /(?<klass>IN)?/i
-      REGEX_TYPE = /(?<type>A|AAAA|CNAME|HINFO|MX|NS|SOA|SPF|SRV|TXT|PTR)\s{1}/i
+      REGEX_TYPE = /(?<type>A|AAAA|CDNSKEY|CDS|CNAME|DLV|DNSKEY|DS|HINFO|MX|NAPTR|NS|NSEC|NSEC3|NSEC3PARAM|RRSIG|SOA|SPF|SRV|SSHFP|TXT|PTR)\s{1}/i
       REGEX_RR = /^(?<label>\S+|\s{1})\s*(?<ttl>#{REGEX_TTL})?\s*#{REGEX_KLASS}\s*#{REGEX_TYPE}\s*(?<rdata>[\s\S]*)$/i
-      REGEX_DOMAINNAME = /\S+\./i
+      REGEX_DOMAINNAME = /\S+\.?/i
       REGEX_STRING = /((?:[^"\\]+|\\.)*)/
+      REGEX_CHARACTER_STRING = %r{
+        "#{DNS::Zone::RR::REGEX_STRING}"|#{DNS::Zone::RR::REGEX_STRING}
+      }mx
 
       # Load RR string data and return an instance representing the RR.
       #
@@ -27,35 +30,57 @@ module DNS
         return nil unless captures
 
         case captures[:type]
-        when 'A' then A.new.load(string, options)
-        when 'AAAA' then AAAA.new.load(string, options)
-        when 'CNAME' then CNAME.new.load(string, options)
-        when 'HINFO' then HINFO.new.load(string, options)
-        when 'MX' then MX.new.load(string, options)
-        when 'NS' then NS.new.load(string, options)
-        when 'PTR' then PTR.new.load(string, options)
-        when 'SOA' then SOA.new.load(string, options)
-        when 'SPF' then SPF.new.load(string, options)
-        when 'SRV' then SRV.new.load(string, options)
-        when 'TXT' then TXT.new.load(string, options)
+        when 'A'           then A.new.load(string, options)
+        when 'AAAA'        then AAAA.new.load(string, options)
+        when 'CDNSKEY'     then CDNSKEY.new.load(string, options)
+        when 'CDS'         then CDS.new.load(string, options)
+        when 'CNAME'       then CNAME.new.load(string, options)
+        when 'DLV'         then DLV.new.load(string, options)
+        when 'DNSKEY'      then DNSKEY.new.load(string, options)
+        when 'DS'          then DS.new.load(string, options)
+        when 'HINFO'       then HINFO.new.load(string, options)
+        when 'MX'          then MX.new.load(string, options)
+        when 'NAPTR'       then NAPTR.new.load(string, options)
+        when 'NS'          then NS.new.load(string, options)
+        when 'NSEC'        then NSEC.new.load(string, options)
+        when 'NSEC3'       then NSEC3.new.load(string, options)
+        when 'NSEC3PARAM'  then NSEC3PARAM.new.load(string, options)
+        when 'PTR'         then PTR.new.load(string, options)
+        when 'RRSIG'       then RRSIG.new.load(string, options)
+        when 'SOA'         then SOA.new.load(string, options)
+        when 'SPF'         then SPF.new.load(string, options)
+        when 'SRV'         then SRV.new.load(string, options)
+        when 'SSHFP'       then SSHFP.new.load(string, options)
+        when 'TXT'         then TXT.new.load(string, options)
         else
-          raise 'Unknown RR Type'          
+          raise 'Unknown or unsupported RR Type'          
         end
       end
 
       autoload :Record, 'dns/zone/rr/record'
 
-      autoload :A,      'dns/zone/rr/a'
-      autoload :AAAA,   'dns/zone/rr/aaaa'
-      autoload :CNAME,  'dns/zone/rr/cname'
-      autoload :HINFO,  'dns/zone/rr/hinfo'
-      autoload :MX,     'dns/zone/rr/mx'
-      autoload :NS,     'dns/zone/rr/ns'
-      autoload :PTR,    'dns/zone/rr/ptr'
-      autoload :SOA,    'dns/zone/rr/soa'
-      autoload :SPF,    'dns/zone/rr/spf'
-      autoload :SRV,    'dns/zone/rr/srv'
-      autoload :TXT,    'dns/zone/rr/txt'
+      autoload :A,          'dns/zone/rr/a'
+      autoload :AAAA,       'dns/zone/rr/aaaa'
+      autoload :CDNSKEY,    'dns/zone/rr/cdnskey'
+      autoload :CDS,        'dns/zone/rr/cds'
+      autoload :CNAME,      'dns/zone/rr/cname'
+      autoload :DLV,        'dns/zone/rr/dlv'
+      autoload :DNSKEY,     'dns/zone/rr/dnskey'
+      autoload :DS,         'dns/zone/rr/ds'
+      autoload :HINFO,      'dns/zone/rr/hinfo'
+      autoload :MX,         'dns/zone/rr/mx'
+      autoload :NAPTR,      'dns/zone/rr/naptr'
+      autoload :NS,         'dns/zone/rr/ns'
+      autoload :NSEC,       'dns/zone/rr/nsec'
+      autoload :NSEC3,      'dns/zone/rr/nsec3'
+      autoload :NSEC3PARAM, 'dns/zone/rr/nsec3param'
+      autoload :PTR,        'dns/zone/rr/ptr'
+      autoload :RRSIG,      'dns/zone/rr/rrsig'
+      autoload :SOA,        'dns/zone/rr/soa'
+      autoload :SPF,        'dns/zone/rr/spf'
+      autoload :SRV,        'dns/zone/rr/srv'
+      autoload :SSHFP,      'dns/zone/rr/sshfp'
+      autoload :TXT,        'dns/zone/rr/txt'
     end
 
   end

data/lib/dns/zone/rr/cdnskey.rb

@@ -0,0 +1,5 @@
+# `CDNSKEY` resource record.
+#
+# RFC 7344
+class DNS::Zone::RR::CDNSKEY < DNS::Zone::RR::DNSKEY
+end

data/lib/dns/zone/rr/cds.rb

@@ -0,0 +1,5 @@
+# `CDS` resource record.
+#
+# RFC 7344
+class DNS::Zone::RR::CDS < DNS::Zone::RR::DS
+end

data/lib/dns/zone/rr/dlv.rb

@@ -0,0 +1,5 @@
+# `DLV` resource record.
+#
+# RFC 4431
+class DNS::Zone::RR::DLV < DNS::Zone::RR::DS
+end