bind-zone-parser 0.0.0

data/lib/bind/zone_parser.rl

@@ -0,0 +1,107 @@
+%%{
+  machine bind_parser;
+
+  action read_number    { num = (num * 10) + (fc - ?0) }
+  action clear_number   { num = 0 }
+  action clear_str_p    { str_p = p }
+
+  action store_dist     { record[:dist] = num }
+  action store_ttl      { record[:ttl] = num }
+  action store_priority { record[:priority] = num }
+  action store_weight   { record[:weight] = num }
+  action store_port     { record[:port] = num }
+  action store_serial   { record[:serial] = num }
+  action store_refresh  { record[:refresh] = num }
+  action store_retry    { record[:retry] = num }
+  action store_expire   { record[:expire] = num }
+  action store_minimum  { record[:minimum] = num }
+
+  action store_owner    { record[:owner] = data[str_p..p].pack('c*').strip }
+  action store_target   { record[:target] = data[str_p..p].pack('c*').strip }
+  action store_mbox     { record[:mbox] = data[str_p..p].pack('c*').strip }
+  action store_text     { record[:text] = data[(str_p+1)..(p-2)].pack('c*').strip }
+  action store_ipv4     { record[:address] = data[str_p..p].pack('c*').strip }
+  action store_name     { record[:domain] = data[str_p..p].pack('c*').strip }
+
+  action a              { record[:type] = :a }
+  action ns             { record[:type] = :ns }
+  action mx             { record[:type] = :mx }
+  action txt            { record[:type] = :txt }
+  action ptr            { record[:type] = :ptr }
+  action soa            { record[:type] = :soa }
+  action srv            { record[:type] = :srv }
+  action cname          { record[:type] = :cname }
+
+  sp           = space+;
+  newline      = "\n";
+  comment      = space* ";" [^\n]* newline;
+  endofline    = comment | newline @{ records << record; record = Hash.new };
+
+  escapes      = ('\\' [^0-9\n]) | ('\\' digit{3});
+  quotedstr    = ('"' ([^"\n\\]|escapes)* '"') >clear_str_p %store_text;
+
+  ipv4_octet   = ("25" [0-5] | "2" [01234] [0-9] | [01]? [0-9]{1,2});
+  ipv4_address = (ipv4_octet "." ipv4_octet "." ipv4_octet "." ipv4_octet) >clear_str_p %store_ipv4;
+
+  origin       = "@";
+  alnumhyphen  = (alnum | "-");
+  dname        = (alnumhyphen+ ".")* alnumhyphen+ "."?;
+  fqdname      = dname >clear_str_p %store_name;
+  owner        = (sp | origin | dname) >clear_str_p %store_owner;
+  dist         = (digit @read_number)+ >clear_number %store_dist;
+  ttl          = (digit @read_number)+ >clear_number %store_ttl;
+  priority     = (digit @read_number)+ >clear_number %store_priority;
+  weight       = (digit @read_number)+ >clear_number %store_weight;
+  port         = (digit @read_number)+ >clear_number %store_port;
+  serial       = (digit @read_number)+ >clear_number %store_serial;
+  refresh      = (digit @read_number)+ >clear_number %store_refresh;
+  retry        = (digit @read_number)+ >clear_number %store_retry;
+  expire       = (digit @read_number)+ >clear_number %store_expire;
+  minimum      = (digit @read_number)+ >clear_number %store_minimum;
+  target       = ("." | dname) >clear_str_p %store_target;
+  srv_o        = ("_" alnumhyphen+ "." ("_tcp" | "_udp") ("." dname)?) >clear_str_p %store_owner;
+  mbox         = dname >clear_str_p %store_mbox;
+
+  eol_or_sp    = sp | (endofline sp);
+  soa_rdata    = "(" sp? serial eol_or_sp refresh eol_or_sp retry eol_or_sp expire eol_or_sp minimum sp? ")";
+
+  host_record  = owner (sp ttl)? (sp "IN")? sp ("A" @a) sp ipv4_address endofline;
+  ns_record    = owner (sp ttl)? (sp "IN")? sp ("NS" @ns) sp fqdname endofline;
+  mx_record    = owner (sp ttl)? (sp "IN")? sp ("MX" @mx) sp dist sp fqdname endofline;
+  txt_record   = owner (sp ttl)? (sp "IN")? sp ("TXT" @txt) sp quotedstr endofline;
+  ptr_record   = owner (sp ttl)? (sp "IN")? sp ("PTR" @ptr) sp fqdname endofline;
+  cname_record = owner (sp ttl)? (sp "IN")? sp ("CNAME" @cname) sp fqdname endofline;
+  soa_record   = owner (sp ttl)?  sp "IN"   sp ("SOA" @soa) sp fqdname sp mbox sp soa_rdata endofline;
+  srv_record   = srv_o (sp ttl)? (sp "IN")? sp ("SRV" @srv) sp priority sp weight sp port sp target endofline;
+
+  record       = host_record
+               | ns_record
+               | mx_record
+               | txt_record
+               | ptr_record
+               | cname_record
+               | soa_record
+               | srv_record;
+
+  main        := (newline | comment | record)*;
+}%%
+
+module Bind
+  class ZoneParser
+    def self.parse(zone)
+      new.parse(zone)
+    end
+    def parse(zone)
+      data = zone.unpack('c*')
+      records = []
+      record = {}
+
+      %% write data;
+      %% write init;
+      %% write exec;
+
+      return records if p == pe && cs == bind_parser_first_final
+      raise "cs: #{cs} p: #{p} pe: #{pe} data[p]: #{data[p] ? data[p].chr.inspect : 'nil'}"
+    end
+  end
+end

data/test/examples/example.com.db

@@ -0,0 +1,21 @@
+; Zone database file for example.com zone
+
+@		86400	IN SOA	ns1.example.com. hostmaster (
+					 2010080201    ; Serial number
+					 3600          ; Refresh
+					 900           ; Retry
+					 604800        ; Expire
+					 14400       ) ; Minimum TTL
+			NS	ns1.example.com.
+			NS	ns2.example.com.
+			A	172.16.147.66
+			MX	100 mx1.example-mail.com.
+			MX	200 mx2.example-mail.com.
+			TXT	"v=spf1 a mx ip4:192.168.1.75 ?all"
+www			A	172.16.147.66
+sso			A	172.16.169.185
+jabber			A	172.16.157.212
+_jabber._tcp		SRV	10 10  5269 jabber ; Jabber Server
+_xmpp-client._tcp	SRV	10 10  5222 jabber ; Jabber Server
+_xmpp-server._tcp	SRV	10 10  5269 jabber ; Jabber Server
+xmpp			CNAME	jabber

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bind-zone-parser'
+
+class Test::Unit::TestCase
+end

data/test/test_zone.rb

@@ -0,0 +1,13 @@
+require 'helper'
+
+class TestBindZone < Test::Unit::TestCase
+  context ".load_file" do
+    setup do
+      @zone_file = File.expand_path('../examples/example.com.db', __FILE__)
+    end
+    should "return new zone with the records from the file" do
+      @zone = Bind::Zone.load_file(@zone_file)
+      assert !@zone.records.empty?
+    end
+  end
+end

data/test/test_zone_parser.rb

@@ -0,0 +1,164 @@
+require 'helper'
+
+class TestBindZoneParser < Test::Unit::TestCase
+  context "#parse" do
+    setup do
+      @zone_parser = Bind::ZoneParser.new
+    end
+    context "Comments" do
+      should "parse comment" do
+        assert @zone_parser.parse(";$; Updated with Simple DNS Plus record editor 2 Aug 2010 13:57:42\n; Zone database file for m247.com zone\n")
+      end
+    end
+    context "Host Record" do
+      should "parse subdomain" do
+        assert @zone_parser.parse("www    IN  A   192.168.1.68\n")
+      end
+      should "parse dotted subdomain" do
+        assert @zone_parser.parse("a.mx   IN  A   192.168.1.69\n")
+      end
+      should "parse qualified owner" do
+        assert @zone_parser.parse("www.example.com. IN A  192.168.1.70\n")
+      end
+      should "parse @ origin owner" do
+        assert @zone_parser.parse("@      IN  A   192.168.1.71\n")
+      end
+      should "parse blank owner" do
+        assert @zone_parser.parse("       IN  A   192.168.1.72\n")
+      end
+      should "parse with ttl" do
+        assert @zone_parser.parse("  300  IN  A   192.168.1.73\n")
+      end
+      should "parse with ending comment" do
+        assert @zone_parser.parse("       IN  A   192.168.1.74  ; Example record\n")
+      end
+      should "parse with out IN defined" do
+        assert @zone_parser.parse("           A   192.168.1.76\n")
+      end
+    end
+    context "Name Server Record" do
+      should "parse @ origin owner, subdomain host" do
+        assert @zone_parser.parse("@      IN  NS  ns1\n")
+      end
+      should "parse @ origin owner, dotted subdomain host" do
+        assert @zone_parser.parse("@      IN  NS  a.ns\n")
+      end
+      should "parse @ origin owner, qualified host" do
+        assert @zone_parser.parse("@      IN  NS  a.ns.example.com.\n")
+      end
+      should "parse blank owner, subdomain host" do
+        assert @zone_parser.parse("       IN  NS  ns1\n")
+      end
+      should "parse blank owner, dotted subdomain host" do
+        assert @zone_parser.parse("       IN  NS  a.ns\n")
+      end
+      should "parse blank owner, qualified host" do
+        assert @zone_parser.parse("       IN  NS  a.ns.example.com.\n")
+      end
+      should "parse sub delegation, subdomain host" do
+        assert @zone_parser.parse("hr     IN  NS  hr-ns1\n")
+      end
+      should "parse sub delegation, dotted subdomain host" do
+        assert @zone_parser.parse("hr     IN  NS  a.ns-hr\n")
+      end
+      should "parse sub delegation, qualified host" do
+        assert @zone_parser.parse("hr     IN  NS  hr-ns1.example.com\n")
+      end
+      should "parse qualified delegation" do
+        assert @zone_parser.parse("another.com. IN  NS  ns1\n")
+      end
+    end
+    context "Mail Exchange Record" do
+      should "parse @ origin owner, subdomain host" do
+        assert @zone_parser.parse("@      IN  MX  10    mx1\n")
+      end
+      should "parse @ origin owner, dotted subdomain host" do
+        assert @zone_parser.parse("@      IN  MX  10    a.mx\n")
+      end
+      should "parse @ origin owner, qualified host" do
+        assert @zone_parser.parse("@      IN  MX  10    a.mx.example.com.\n")
+      end
+      should "parse blank owner, subdomain host" do
+        assert @zone_parser.parse("       IN  MX  10    mx1\n")
+      end
+      should "parse blank owner, dotted subdomain host" do
+        assert @zone_parser.parse("       IN  MX  10    a.mx\n")
+      end
+      should "parse blank owner, qualified host" do
+        assert @zone_parser.parse("       IN  MX  10    a.mx.example.com.\n")
+      end
+    end
+    context "Text Record" do
+      should "parse subdomain owner" do
+        assert @zone_parser.parse("mail      IN  TXT \"v=spf1 a mx ip4:192.168.1.75 ?all\"\n")
+      end
+      should "parse dotted subdomain owner" do
+        assert @zone_parser.parse("a.mx      IN  TXT \"v=spf1 a mx ip4:192.168.1.75 ?all\"\n")
+      end
+      should "parse qualified owner" do
+        assert @zone_parser.parse("example.com. IN  TXT \"v=spf1 a mx ip4:192.168.1.75 ?all\"\n")
+      end
+      should "parse @ origin owner" do
+        assert @zone_parser.parse("@        IN  TXT \"v=spf1 a mx ip4:192.168.1.75 ?all\"\n")
+      end
+      should "parse blank owner" do
+        assert @zone_parser.parse("         IN  TXT \"v=spf1 a mx ip4:192.168.1.75 ?all\"\n")
+      end
+    end
+    context "Pointer Record" do
+      should "parse octet owner" do
+        assert @zone_parser.parse("69                         IN PTR a.mx.example.com.\n")
+      end
+      should "parse multiple octet owner" do
+        assert @zone_parser.parse("69.1                       IN PTR a.mx.example.com.\n")
+      end
+      should "parse qualified in-addr.arpa" do
+        assert @zone_parser.parse("69.1.168.192.in-addr.arpa. IN PTR a.mx.example.com.\n")
+      end
+    end
+    context "CNAME Record" do
+      should "parse subdomain to subdomain" do
+        assert @zone_parser.parse("webmail  IN  CNAME   mail\n")
+      end
+      should "parse subdomain to qualified domain" do
+        assert @zone_parser.parse("webmail  IN  CNAME   mail.example.com.\n")
+      end
+    end
+    context "SRV Record" do
+      should "parse subdomain to subdomain" do
+        assert @zone_parser.parse("_jabber._tcp		IN  SRV	10 10  5269 jabber\n")
+      end
+      should "parse qualified to subdomain" do
+        assert @zone_parser.parse("_xmpp-client._tcp.example.com. IN	SRV	10 10  5222 jabber\n")
+      end
+      should "parse qualified to qualified" do
+        assert @zone_parser.parse("_xmpp-server._tcp.example.com.	IN	SRV	10 10  5269 jabber.example.com.\n")
+      end
+    end
+    context "SOA Record" do
+      should "parse single, @ origin owner, short source, short mbox" do
+        assert @zone_parser.parse("@  IN  SOA ns1 hostmaster (1282731423 16384 2048 1048576 2560)\n")
+      end
+      should "parse single, @ origin owner, short source, qualified mbox" do
+        assert @zone_parser.parse("@  IN  SOA ns1 dns.example.com. (1282731423 16384 2048 1048576 2560)\n")
+      end
+      should "parse single, @ origin owner, qualified source, qualified mbox" do
+        assert @zone_parser.parse("@  IN  SOA ns1.dns.com. dns.example.com. (1282731423 16384 2048 1048576 2560)\n")
+      end
+      should "parse single, qualified origin, source and mbox" do
+        assert @zone_parser.parse("example.com. IN  SOA ns1.dns.com. dns.example.com. (1282731423 16384 2048 1048576 2560)\n")
+      end
+      should "parse multiline rdata" do
+        multiline = <<-EOF
+@	86400	IN SOA	ns1.example.com. hostmaster (
+          			 1282731423   ; Serial number
+          			 16384        ; Refresh
+          			 2048         ; Retry
+          			 1048576      ; Expire
+          			 2560       ) ; Minimum TTL
+EOF
+        assert @zone_parser.parse(multiline)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: bind-zone-parser
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Geoff Garside
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-25 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Helps with parsing records and data from BIND Zone files
+email: geoff@geoffgarside.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bind-zone-parser.gemspec
+- lib/bind-zone-parser.rb
+- lib/bind/zone.rb
+- lib/bind/zone_parser.rb
+- lib/bind/zone_parser.rl
+- test/examples/example.com.db
+- test/helper.rb
+- test/test_zone.rb
+- test/test_zone_parser.rb
+has_rdoc: true
+homepage: http://github.com/geoffgarside/bind-zone-parser
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: BIND Zone file parser
+test_files: 
+- test/helper.rb
+- test/test_zone.rb
+- test/test_zone_parser.rb