dns-zonefile 0.0.1

data/README

@@ -0,0 +1,51 @@
+DNS::Zonefile
+=============
+
+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.
+
+
+Getting setup
+-------------
+
+Well, you'll need the treetop and polyglot gems installed. They do all 
+the hard work. Thanks!
+
+  sudo gem install treetop polyglot
+
+Now you'll need to generate the Treetop parser from the Zonefile grammar 
+that I've hacked together.
+
+  rake generate_grammar
+
+Okay, you're ready to move onto the examples now.
+
+
+Examples
+--------
+
+  zonefile = "/path/to/file.zone"
+  zone_string = File.read(zonefile)
+  zone = DNS::Zonefile.parse(zone_string)
+
+  puts zone.soa.origin
+  puts zone.soa.ns
+  puts zone.resource_records[0]
+
+
+Authors
+-------
+
+Craig R Webster <http://barkingiguana.com/>
+
+
+Contributing
+------------
+
+See the TODO. Send me patches or pull request either by email or on 
+GitHub.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+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'
+  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"
+  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")
+  source += "\nend"
+  File.open(parser_file, 'w') do |f|
+    f.write(source)
+  end
+end
+
+task :gem => :generate_grammar do
+  puts %x[gem build dns-zonefile.gemspec]
+end

data/TODO

@@ -0,0 +1,8 @@
+* 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.

data/doc/example2.com.zone

@@ -0,0 +1,16 @@
+$ORIGIN example2.com.
+$TTL 86400
+@	IN	SOA	ns1.nameservers.com. dns.example2.com. (
+					2009102121
+					7200
+					7200
+					1209600
+					86400
+				)
+@		NS	ns1.nameservers.com.
+@		NS	ns2.nameservers.com.
+@		NS	ns3.nameservers.com.
+@		NS	ns4.nameservers.com.
+@			A	197.127.138.160
+www			A	197.127.138.160
+right			A	178.109.109.208

data/doc/example3.com.zone

@@ -0,0 +1,24 @@
+$ORIGIN example1.com.
+$TTL 86400
+@	IN	SOA	ns1.name-server.com. support.example1.com. (
+					2009102121
+					7200
+					7200
+					1209600
+					86400
+				)
+@		NS	ns1.name-server.com.
+@		NS	ns2.name-server.com.
+@		NS	ns3.name-server.com.
+@		NS	ns4.name-server.com.
+@			MX	10	mx-ext-0.mx-service.com.
+@			MX	20	mx-ext-1-0.mx-service.com.
+@			MX	20	mx-ext-1-1.mx-service.com.
+@			MX	30	mx-ext-2-0.mx-service.com.
+@			MX	30	mx-ext-2-1.mx-service.co.uk.
+@			MX	30	mx-ext-2-2.mx-service.org.
+@			MX	30	mx-ext-2-3.mx-service.net.uk.
+@			A	197.207.108.251
+*			A	197.207.108.251
+googleblahblah3135			CNAME	google.com.
+mail			CNAME	ghs.google.com.

data/doc/zonefile.example

@@ -0,0 +1,45 @@
+$ORIGIN example.com. ; Start zone example.com
+$TTL 1h              ; Default TTL
+
+; TODO: Find out if the above are optional.
+; See RFC 1035 (section 5) and RFC 1034 (Section 3.6.1)
+
+example.com.  IN SOA ns.example.com. hostmaster.example.com. (
+              2009080101    ; zone serial
+              1d            ; slave refresh
+              1d            ; slave retry
+              4w            ; slave expiration
+              1h            ; minimum TTL (is this of SOA or zone?)
+              )
+
+; TODO: Find out how record-specific TTLs are listed.
+; 
+; Anything after a semi-colon is a comment
+;
+; @ means use the same name as the origin
+;
+; If the name doesn't end with a period then it's prepended to the 
+; origin.
+
+@             NS    ns1              ; specify a nameserver
+example.com.  NS    ns2.example.com. ; specify a nameserver
+
+ns1           A     123.123.123.123
+ns2           A     123.123.123.124
+
+@             A     123.123.123.122
+www           CNAME example.com
+
+mx1           A     123.123.123.123 ; Records used as MX must not be 
+                                    ; CNAME records. See RFC 2181.
+
+@             AAAA  ; TODO: Find out how IPv6 addresses are specified
+
+@             MX 10 mx1
+@             MX 20 mx2.example.com.
+@             MX 20 mx-backup.elsewhere.com.
+
+@             TXT "Random text"
+@             TXT "spf=v1 ..." ; TODO: Get an example of an SPF record
+
+@             SRV ; TODO: Get an example of a service record eg XMPP

data/doc/zonefile.treetop

@@ -0,0 +1,257 @@
+grammar Zonefile
+  rule zone
+    (variable / space / comment)* soa (resource_record / comment / space)* {
+      def variables
+        @variables ||= begin
+          raw = elements[0].elements.select { |e| e.to_s =~ /^\$/ }
+          variables = {}
+          raw.each do |e|
+            variables[e.name.text_value.to_s] = e.value.text_value.to_s
+          end
+          variables
+        end
+      end
+
+      def origin
+        soa.origin.host.to_s
+      end
+
+      def to_s
+        text_value
+      end
+
+      def rr
+        elements[-1].elements.select { |e| e.to_s !~ /\A\s*(;.*)?\z|\A\z/; }
+      end
+    }
+  end
+
+  rule variable
+    "$" name:([a-zA-Z0-9]+) space value:([a-zA-Z0-9\.\-]+) space? comment? {
+      def to_s
+        "$#{name.text_value.to_s} #{value.text_value.to_s}"
+      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* ")" {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule resource_record
+    space? record:(a_record / cname_record / mx_record / ns_record) space? comment? {
+      def to_s
+        text_value
+      end
+
+      def record_type
+        record.elements[2].text_value
+      end
+
+      def method_missing(method_name, *args)
+        if record.respond_to?(method_name)
+          record.send(method_name, *args)
+        end
+      end
+
+      def respond_to?(method_name)
+        super || record.respond_to?(method_name)
+      end
+    }
+  end
+
+  rule a_record
+    host space "A" space ip_address {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule ip_address
+    [\d]+ "." [\d]+ "." [\d]+ "." [\d]+ {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule cname_record
+    alias:host space "CNAME" space host {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule mx_record
+    host space "MX" space priority:integer space exchanger:host {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule ns_record
+    host space "NS" space nameserver:host {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule origin
+    host comment* {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule space
+    [\s]+ {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule zone_type
+    "IN" {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule comment
+    space* ";" [^\n]+ {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule ns
+    host comment* {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule rp
+    ([a-zA-Z0-9\-]+ ".")+ {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule serial
+    integer comment* {
+      def to_i
+        integer.to_i
+      end
+    }
+  end
+
+  rule time_interval
+    integer time_multiplier {
+      def to_s
+        text_value
+      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
+      end
+    }
+  end
+
+  rule refresh
+    time_interval comment* {
+      def to_i
+        time_interval.to_i
+      end
+    }
+  end
+
+  rule integer
+    [0-9]+ {
+      def to_i
+        text_value.to_i
+      end
+    }
+  end
+
+  rule time_multiplier
+    ("h" / "d" / "w" / "m" / "y" / "") {
+      def to_s
+        text_value
+      end
+    }
+  end
+
+  rule retry
+    time_interval comment* {
+      def to_i
+        time_interval.to_i
+      end
+    }
+  end
+
+  rule expiry
+    time_interval comment* {
+      def to_i
+        time_interval.to_i
+      end
+    }
+  end
+
+  rule ttl
+    time_interval comment* {
+      def to_i
+        time_interval.to_i
+      end
+    }
+  end
+
+  rule host
+    (([a-zA-Z0-9\-\.])+ / "@"?) {
+      def zone
+        p = parent
+        while p.respond_to?(:parent) && p.parent
+          p = p.parent
+        end
+        p
+      end
+
+      def to_s
+        case
+        when text_value =~ /\.$/
+          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
+        end
+      end
+    }
+  end
+end

data/lib/dns/zonefile.rb

@@ -0,0 +1,16 @@
+require 'dns/zonefile_parser'
+
+module DNS
+  class Zonefile
+    VERSION = "0.0.1"
+
+    attr_reader :origin, :soa
+
+    class << self
+      def parse(zone_string)
+        parser = DNS::ZonefileParser.new
+        parser.parse(zone_string)
+      end
+    end
+  end
+end