dns-zonefile 0.0.1 → 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dns-zonefile.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    dns-zonefile (1.0.0)
+      polyglot
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    polyglot (0.3.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dns-zonefile!
+  rspec (= 2.6)
+  treetop

data/LICENCE

@@ -0,0 +1,13 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Copyright (C) 2010 Craig R Webster <craig@barkingiguana.com>
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO.

data/README

@@ -25,24 +25,48 @@ that I've hacked together.
 
 Okay, you're ready to move onto the examples now.
 
+The above steps should not be necessary if you install the gem via rubygems.
+
 
 Examples
 --------
 
+Using raw data from the parser. Note that "@" isn't translated in this mode.
+Nor are inherited TTLs interpreted.
+
   zonefile = "/path/to/file.zone"
   zone_string = File.read(zonefile)
   zone = DNS::Zonefile.parse(zone_string)
 
+  puts zone.soa.origin.to_s
+  puts zone.soa.ns.to_s
+  puts zone.rr[0].to_s
+
+Using more structure data. @, TTLs, and empty hostname inheritance are all
+handled in this mode.
+
+  zonefile = "/path/to/file.zone"
+  zone_string = File.read(zonefile)
+  zone = DNS::Zonefile.load(zone_string)
+  # or, if no $origin is in the zone file
+  zone = DNS::Zonefile.load(zone_string, 'example.com.')
+
   puts zone.soa.origin
-  puts zone.soa.ns
-  puts zone.resource_records[0]
+  puts zone.soa.nameserver
+  puts zone.records[1]
+  # get all MX records
+  puts zone.records_of(DNS::MX)
 
 
 Authors
 -------
 
+Original code and concept:
 Craig R Webster <http://barkingiguana.com/>
 
+Additions:
+t.e.morgan <http://zerigo.com/>
+
 
 Contributing
 ------------

data/Rakefile

@@ -1,32 +1,30 @@
+require "bundler/gem_tasks"
+
 require 'rake'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-desc "Run the tests"
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.ruby_opts = [ '-rubygems' ]
-  t.spec_opts = [ '--format specdoc' ]
-  t.libs << 'lib'
-  t.libs << 'spec'
-end
 task :default => [ :generate_grammar, :spec ]
 
 desc "Regenerate the grammar definition"
 task :generate_grammar do
-  parser_file = 'lib/dns/zonefile_parser.rb'
+  parser_file = 'lib/dns/zonefile/parser.rb'
   File.unlink(parser_file) if File.exists?(parser_file)
   puts %x[tt doc/zonefile -o #{parser_file}]
   source = "require 'treetop'\n\n"
   source += "module DNS\n"
+  source += "  module Zonefile\n"
   parser_source = File.open(parser_file, 'r').read
   parser_source.gsub!(/(\s+)Zonefile$/, '\1ZonefileGrammar # :nodoc:')
-  source += parser_source.split(/\n/).map { |l| "\t#{l}" }.join("\n")
+  parser_source.gsub!(/(\s+)ZonefileParser/, '\1Parser')
+  source += parser_source.split(/\n/).map { |l| "    #{l}".rstrip }.join("\n")
+  source += "\n  end"
   source += "\nend"
   File.open(parser_file, 'w') do |f|
     f.write(source)
   end
 end
 
-task :gem => :generate_grammar do
+task :build => [ :generate_grammar, :spec ] do
   puts %x[gem build dns-zonefile.gemspec]
-end
+end

data/TODO

@@ -1,8 +1,4 @@
-* Allow empty host strings which expand to the zone origin eg:
-    [spaces] MX 100 mail4
-    -> example.com. MX 100 mail4.example.com.
 * Support more record types: http://www.dns.net/dnsrd/rr.html
 * Output the zone object-graph as a zone string.
-* Should this support sub-types of TXT records - should we recognise 
-  SPF records as special TXT records or are these just TXT records?
-* Allow comparison of resource records and zones for checking equality.
+* Allow comparison of resource records and zones for checking equality.
+* Allow unqualified ns and rp in SOA

data/dns-zonefile.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dns/zonefile/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dns-zonefile"
+  s.version     = DNS::Zonefile::VERSION
+  s.authors     = ["Craig R Webster"]
+  s.email       = ["craig@barkingiguana.com"]
+  s.homepage    = ""
+  s.summary     = %q{Work with zonefiles (RFC 1035 section 5 and RFC 1034 section 3.6.1)}
+  s.description = %q{The format of a DNS Zonefile is defined in RFC 1035 section 5 and RFC
+1034 section 3.6.1. To anyone who's using BIND they'll look very 
+familiar.
+
+This is an attempt to use Ruby parse them into an object graph which can 
+be investigated programatically, manipulated, validated or printed into 
+some canonical form.}
+
+  s.rubyforge_project = "dns-zonefile"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "= 2.6"
+  s.add_development_dependency "treetop"
+  s.add_runtime_dependency "polyglot"
+end

data/doc/example.com.zone

@@ -0,0 +1,60 @@
+; Hi! I'm an example zonefile.
+$ORIGIN example.com.
+$TTL 86400; expire in 1 day.
+@             IN  SOA  ns.example.com. hostmaster.example.com. (
+              2007120710 ; serial number of this zone file
+              1d         ; slave refresh (1 day)
+              1d         ; slave retry time in case of a problem (1 day)
+              4W         ; slave expiration time (4 weeks)
+              3600       ; minimum caching time in case of failed lookups (1 hour)
+              )
+; That's the SOA part done.
+
+; Next comment line has nothing after the semi-colon.
+;
+
+; Let's start the resource records.
+example.com.  NS    ns                    ; ns.example.com is the nameserver for example.com
+example.com.  NS    ns.somewhere.com.     ; ns.somewhere.com is a backup nameserver for example.com
+example.com.  A     10.0.0.1              ; ip address for "example.com"
+@             A     10.0.0.11             ; secondary ip for "example.com"
+              A     10.0.0.12             ; tertiary ip for "example.com"
+ns            A     10.0.0.2              ; ip address for "ns.example.com"
+              A     10.0.0.21             ; secondary ip for "ns.example.com"
+*             A     10.0.0.100            ; wildcard
+*.sub         A     10.0.0.101            ; subdomain wildcard
+with-class   IN  A   10.0.0.3             ; record that includes the class type of IN
+with-ttl  60     A   10.0.0.5             ; with a specified TTL
+ttl-class 60 IN  A   10.0.0.6             ; with TTL and class type
+www           CNAME ns                    ; "www.example.com" is an alias for "ns.example.com"
+wwwtest       CNAME www                   ; "wwwtest.example.com" is another alias for "www.example.com"
+www2          CNAME ns.example.com.       ; yet another alias, with FQDN target
+
+; Email... that'll be fun then
+example.com.  MX    10 mail.example.com.  ; mail.example.com is the mailserver for example.com
+@             MX    20 mail2.example.com. ; Similar to above line, but using "@" to say "use $ORIGIN"
+@             MX    50 mail3              ; Similar to above line, but using a host within this domain
+
+@             AAAA  2001:db8:a::1         ; IPv6, lowercase
+ns            AAAA  2001:DB8:B::1         ; IPv6, uppercase
+mail          AAAA  2001:db8:c::10.0.0.4  ; IPv6, with trailing IPv4-type address
+
+sip           NAPTR 100 10 "U" "E2U+sip" "!^.*$!sip:cs@example.com!i" .   ; NAPTR record
+sip2          NAPTR 100 10 "" "" "/urn:cid:.+@([^\.]+\.)(.*)$/\2/i" .     ; another one
+
+_xmpp-server._tcp   SRV   5 0 5269 xmpp-server.l.google.com.  ; SRV record
+
+; TXT record, with embedded semicolons
+_domainkey    TXT   "v=DKIM1\;g=*\;k=rsa\; p=4tkw1bbkfa0ahfjgnbewr2ttkvahvfmfizowl9s4g0h28io76ndow25snl9iumpcv0jwxr2k"
+
+@             TXT   "some other \"message\" goes here" ; embedded quotes
+long          TXT   "a multi-segment TXT record" "usually used for really long TXT records" "since each segment can only span 255 chars"
+@             SPF   "v=spf1 a a:other.domain.com ~all"
+
+45        IN   PTR   @
+
+$ORIGIN test.example.com.
+$TTL 3600; expire in 1 day.
+@             A     10.1.0.1              ; Test with alternate origin
+              MX    10  mail.example.com.
+www           A     10.1.0.2              ; www.test.example.com.

data/doc/zonefile.treetop

@@ -1,6 +1,6 @@
 grammar Zonefile
   rule zone
-    (variable / space / comment)* soa (resource_record / comment / space)* {
+    (variable / space_or_break / comment)* soa (resource_record / variable / comment / space / linebreak)* {
       def variables
         @variables ||= begin
           raw = elements[0].elements.select { |e| e.to_s =~ /^\$/ }
@@ -21,7 +21,13 @@ grammar Zonefile
       end
 
       def rr
-        elements[-1].elements.select { |e| e.to_s !~ /\A\s*(;.*)?\z|\A\z/; }
+        elements[-1].elements.select { |e| e.to_s !~ /\A\s*([;$].*)?\z|\A\z/; }
+      end
+      
+      def entries
+        elements[0].elements.select { |e| e.to_s !~ /\A\s*(;.*)?\z|\A\z/; } +
+          [soa] +
+          elements[-1].elements.select { |e| e.to_s !~ /\A\s*(;.*)?\z|\A\z/; }
       end
     }
   end
@@ -31,25 +37,41 @@ grammar Zonefile
       def to_s
         "$#{name.text_value.to_s} #{value.text_value.to_s}"
       end
+
+      def parse_type ; :variable ; end
     }
   end
 
   rule soa
-    origin space zone_type space "SOA" space ns space rp space "(" space* serial space refresh space retry space expiry space ttl space* ")" {
+    origin space ttl klass "SOA" space ns space rp space "("? space_or_break* serial space_or_break refresh space_or_break reretry space_or_break expiry space_or_break nxttl space_or_break* ")"? {
       def to_s
-        text_value
+        "#{origin} #{ttl} #{klass} SOA #{ns} #{rp} (#{serial} #{refresh} #{reretry} #{expiry} #{nxttl})"
       end
+      
+      def parse_type ; :soa ; end
     }
   end
 
   rule resource_record
-    space? record:(a_record / cname_record / mx_record / ns_record) space? comment? {
+    record:(a_record / aaaa_record / cname_record / mx_record / naptr_record / ns_record / ptr_record / srv_record / spf_record / txt_record / soa_record) space* comment? linebreak {
+      def zone
+        p = parent
+        while p.respond_to?(:parent) && p.parent
+          p = p.parent
+        end
+        p
+      end
+      
       def to_s
         text_value
       end
 
       def record_type
-        record.elements[2].text_value
+        record.elements[4].text_value
+      end
+      
+      def ttl
+        record.ttl || zone.variables['TTL'].to_i
       end
 
       def method_missing(method_name, *args)
@@ -61,13 +83,15 @@ grammar Zonefile
       def respond_to?(method_name)
         super || record.respond_to?(method_name)
       end
+
+      def parse_type ; :record ; end
     }
   end
 
   rule a_record
-    host space "A" space ip_address {
+    host space ttl klass "A" space ip_address {
       def to_s
-        text_value
+        "#{host} #{ttl} #{klass} A #{ip_address}"
       end
     }
   end
@@ -79,27 +103,91 @@ grammar Zonefile
       end
     }
   end
+  
+  rule aaaa_record
+    host space ttl klass "AAAA" space ip_address:ip6_address {
+      def to_s
+        "#{host} #{ttl} #{klass} AAAA #{ip_address}"
+      end
+    }
+  end
+  
+  rule ip6_address
+    [\da-fA-F:.] 2..39 {
+      def to_s
+        text_value.downcase
+      end
+    }
+  end
 
   rule cname_record
-    alias:host space "CNAME" space host {
+    host space ttl klass "CNAME" space target:host {
       def to_s
-        text_value
+        "#{host} #{ttl} #{klass} CNAME #{target}"
       end
     }
   end
 
   rule mx_record
-    host space "MX" space priority:integer space exchanger:host {
+    host space ttl klass "MX" space priority:integer space exchanger:host {
       def to_s
-        text_value
+        "#{host} #{ttl} #{klass} MX #{priority} #{exchanger}"
+      end
+    }
+  end
+  
+  rule naptr_record
+    host space ttl klass "NAPTR" space data {
+      def to_s
+        "#{host} #{ttl} #{klass} NAPTR #{data}"
       end
     }
   end
 
   rule ns_record
-    host space "NS" space nameserver:host {
+    host space ttl klass "NS" space nameserver:host {
       def to_s
-        text_value
+        "#{host} #{ttl} #{klass} NS #{nameserver}"
+      end
+    }
+  end
+
+  rule ptr_record
+    host space ttl klass "PTR" space target:host {
+      def to_s
+        "#{host} #{ttl} #{klass} PTR #{target}"
+      end
+    }
+  end
+
+  rule soa_record
+    origin space ttl klass "SOA" space ns space rp space data {
+      def to_s
+        "#{origin} #{ttl} #{klass} SOA #{ns} #{rp} (#{space})"
+      end
+    }
+  end
+
+  rule srv_record
+    host space ttl klass "SRV" space priority:integer space weight:integer space port:integer space target:host {
+      def to_s
+        "#{host} #{ttl} #{klass} SRV #{priority} #{weight} #{port} #{target}"
+      end
+    }
+  end
+  
+  rule spf_record
+    host space ttl klass "SPF" space data:txt_data {
+      def to_s
+        "#{host} #{ttl} #{klass} SPF #{data}"
+      end
+    }
+  end
+  
+  rule txt_record
+    host space ttl klass "TXT" space data:txt_data {
+      def to_s
+        "#{host} #{ttl} #{klass} TXT #{data}"
       end
     }
   end
@@ -107,31 +195,47 @@ grammar Zonefile
   rule origin
     host comment* {
       def to_s
-        text_value
+        "#{host}"
       end
     }
   end
 
   rule space
-    [\s]+ {
+    [ \t]+ {
       def to_s
         text_value
       end
     }
   end
-
-  rule zone_type
-    "IN" {
+  
+  rule linebreak
+    [\n\r]+ {
+      def to_s
+        ''
+      end
+    }
+  end
+  
+  rule space_or_break
+    [\s]+ {
       def to_s
         text_value
       end
     }
   end
 
+  rule klass
+    (("IN" space) / '') {
+      def to_s
+        text_value.strip
+      end
+    }
+  end
+  
   rule comment
-    space* ";" [^\n]+ {
+    space* ";" [^\n\r]* {
       def to_s
-        text_value
+        text_value.strip
       end
     }
   end
@@ -139,11 +243,12 @@ grammar Zonefile
   rule ns
     host comment* {
       def to_s
-        text_value
+        "#{host}"
       end
     }
   end
 
+  # fixme: same as host, except also allow \. -- eg: firstname\.lastname.domain.com
   rule rp
     ([a-zA-Z0-9\-]+ ".")+ {
       def to_s
@@ -157,6 +262,9 @@ grammar Zonefile
       def to_i
         integer.to_i
       end
+      def to_s
+        "#{to_i}"
+      end
     }
   end
 
@@ -167,15 +275,7 @@ grammar Zonefile
       end
 
       def to_i
-        multipliers = {
-          ""  => 1,
-          "h" => 60 * 60,
-          "d" => 60 * 60 * 24,
-          "w" => 60 * 60 * 24 * 7,
-          "m" => 60 * 60 * 24 * 7 * 4,
-          "y" => 60 * 60 * 24 * 7 * 4 * 52
-        }
-        multipliers[time_multiplier.to_s] * integer.to_i
+        time_multiplier.to_i * integer.to_i
       end
     }
   end
@@ -185,6 +285,9 @@ grammar Zonefile
       def to_i
         time_interval.to_i
       end
+      def to_s
+        time_interval.to_s
+      end
     }
   end
 
@@ -193,22 +296,38 @@ grammar Zonefile
       def to_i
         text_value.to_i
       end
+      def to_s
+        "#{to_i}"
+      end
     }
   end
 
   rule time_multiplier
-    ("h" / "d" / "w" / "m" / "y" / "") {
+    ( 's' / 'S' / 'm' / 'M' / 'h' / 'H' / 'd' / 'D' / 'w' / 'W' / '' ) {
       def to_s
         text_value
       end
+      def to_i
+        case text_value.downcase
+          when 'm' then 60
+          when 'h' then 60 * 60
+          when 'd' then 60 * 60 * 24
+          when 'w' then 60 * 60 * 24 * 7
+          else
+            1
+        end
+      end
     }
   end
 
-  rule retry
+  rule reretry
     time_interval comment* {
       def to_i
         time_interval.to_i
       end
+      def to_s
+        time_interval.to_s
+      end
     }
   end
 
@@ -217,41 +336,62 @@ grammar Zonefile
       def to_i
         time_interval.to_i
       end
+      def to_s
+        time_interval.to_s
+      end
     }
   end
 
-  rule ttl
+  rule nxttl
     time_interval comment* {
       def to_i
         time_interval.to_i
       end
+      def to_s
+        time_interval.to_s
+      end
     }
   end
-
-  rule host
-    (([a-zA-Z0-9\-\.])+ / "@"?) {
-      def zone
-        p = parent
-        while p.respond_to?(:parent) && p.parent
-          p = p.parent
-        end
-        p
+  
+  rule ttl
+    ((time_interval space) / '') {
+      def to_i
+        respond_to?(:time_interval) ? time_interval.to_i : nil
+      end
+      def to_s
+        respond_to?(:time_interval) ? time_interval.to_s : ''
       end
+    }
+  end
 
+  rule host
+    ( ([*a-zA-Z0-9\-\._]+) / "@" / ' ' / "\t" ) {
       def to_s
-        case
-        when text_value =~ /\.$/
+        case text_value
+        when /\.$/
+          text_value
+        when "@", /\s/
           text_value
-        when text_value == "@" || text_value == ""
-          if parent == zone.soa.origin
-            zone.variables['ORIGIN']
-          else
-            zone.origin.to_s
-          end
         else
-          text_value + '.' + zone.origin.to_s
+          text_value + '.@'
         end
       end
     }
   end
-end
+
+  rule data
+    [^;\n\r]+ {
+      def to_s
+        text_value.strip
+      end
+    }
+  end
+  
+  rule txt_data
+    '"'? ('\\"' / !'"' [^\n\r])* '"'? (space '"' ('\\"' / !'"' [^\n\r])* '"')* {
+      def to_s
+        text_value
+      end
+    }
+  end
+end