zonefile 1.00

data/lib/zonefile/zonefile.rb

@@ -0,0 +1,263 @@
+#
+# = Ruby Zonefile - Parse and manipulate DNS Zone Files.
+#
+# == Description
+# This class can read, manipulate and create DNS zone files. It supports A, AAAA, MX, NS, SOA, 
+# TXT, CNAME and SRV records. The data can be accessed by the instance method of the same
+# name. All except SOA return an array of hashes containing the named data. SOA directly returns the 
+# hash since there can only be one SOA information.
+#
+# The following hash keys are returned per record type:
+#
+# * SOA
+#    - :ttl, :primary, :email, :serial, :refresh, :retry, :expire, :minimumTTL
+# * A
+#    - :name, :ttl, :class, :host
+# * MX
+#    - :name, :ttl, :class, :pri, :host
+# * NS
+#    - :name, :ttl, :class, :host
+# * CNAME
+#    - :name, :ttl, :class, :host
+# * TXT
+#    - :name, :ttl, :class, :text
+# * A4 (AAAA)
+#    - :name, :ttl, :class, :host
+# * SRV
+#    - :name, :ttl, :class, :pri, :weight, :port, :host
+#
+# == Examples
+#
+# === Read a Zonefile
+#
+#  zf = Zonefile.from_file('/path/to/zonefile.db')
+#  
+#  # Display MX-Records
+#  zf.mx.each do |mx_record|
+#     puts "Mail Exchagne with priority: #{mx_record[:pri]} --> #{mx_record[:host]}"
+#  end
+#
+#  # Show SOA TTL
+#  puts "Record Time To Live: #{zf.soa[:ttl]}"
+#
+#  # Show A-Records
+#  zf.a.each do |a_record|
+#     puts "#{a_record[:name]} --> #{a_record[:host]}"
+#  end
+#
+#
+# ==== Manipulate a Zonefile
+#
+#  zf = Zonefile.from_file('/path/to/zonefile.db')
+#
+#  # Change TTL and add an A-Record
+#
+#  zf.soa[:ttl] = '123123'	# Change the SOA ttl
+#  zf.a << { :class => 'IN', :name => 'www', :host => '192.168.100.1', :ttl => 3600 }  # add A-Record
+#
+#  # Increase Serial Number
+#  zf.new_serial
+#
+#  # Print new zonefile
+#  puts "New Zonefile: \n#{zf.output}"
+#
+# == Author
+# 
+# Martin Boese, based on Simon Flack Perl library DNS::ZoneParse
+#
+
+class Zonefile
+
+ RECORDS = %w{ mx a a4 ns cname txt ptr srv soa }
+ attr :records 
+ attr :soa
+ attr :data
+  
+ def method_missing(m)
+   return super unless RECORDS.include?(m.to_s)
+   @records[m]
+ end
+
+
+ # Compact a zonefile content - removes empty lines, comments, 
+ # converts tabs into spaces etc...
+ def self.simplify(zf)
+    # concatenate everything split over multiple lines in parentheses - remove ;-comments in block
+    zf = zf.gsub(/(\([^\)]*?\))/) { |m| m.split(/\n/).map { |l| l.gsub(/\;.*$/, '') }.join("\n").gsub(/[\r\n]/, '') }
+
+    zf.split(/\n/).map do |line|
+        r = line.gsub(/\t/, ' ')
+        r = r.gsub(/\s+/, ' ')
+        r = r.gsub(/\;.*$/, '')
+    end.delete_if { |line| line.empty? || line[0].chr == ';'}.join("\n")
+ end
+
+
+ # create a new zonefile object by passing the content of the zonefile
+ def initialize(zonefile = '', file_name= nil, origin= nil)
+   @data = zonefile
+   @filename = file_name
+   @origin = origin
+  
+   @records = {}
+   @soa = {}
+   RECORDS.each { |r| @records[r.intern] = [] }
+   parse
+ end
+ 
+ # Create a new object by reading the content of a file
+ def self.from_file(file_name, origin = nil)
+    Zonefile.new(File.read(file_name), file_name.split('/').last, origin)
+ end
+ 
+ def add_record(type, data= {})
+    @records[type.downcase.intern] << data
+ end
+ 
+ # Generates a new serial number in the format of YYYYMMDDII if possible
+ def new_serial
+   base = "%04d%02d%02d" % [Time.now.year, Time.now.month, Time.now.day ]
+
+   if ((self.soa[:serial].to_i / 100) > base.to_i) then
+       ns = self.soa[:serial].to_i + 1
+       self.soa[:serial] = ns.to_s
+       return ns.to_s
+   end
+   
+   ii = 0
+   while (("#{base}%02d" % ii).to_i <= self.soa[:serial].to_i) do
+    ii += 1
+   end
+   self.soa[:serial] = "#{base}%02d" % ii   
+ end
+
+ def parse_line(line)
+    valid_name = /[\@a-z_\-\.0-9\*]+/i
+    valid_ip6  = /[\@a-z_\-\.0-9\*:]+/i
+    rr_class   = /\b(?:IN|HS|CH)\b/i
+    rr_type    = /\b(?:NS|A|CNAME)\b/i
+    rr_ttl     = /(?:\d+[wdhms]?)+/i
+    ttl_cls    = Regexp.new("(?:(#{rr_ttl})\s)?(?:(#{rr_class})\s)?")
+
+    data = {}
+    if line =~ /^(#{valid_name})? \s*
+                 #{ttl_cls}
+                 (#{rr_type}) \s
+                 (#{valid_name})
+               /ix then
+              (name, ttl, dclass, type, host) = [$1, $2, $3, $4, $5]
+             add_record($4, :name => $1, :ttl => $2, :class => $3, :host => $5)
+    elsif line=~/^(#{valid_name})? \s*
+                #{ttl_cls}
+                AAAA \s
+                (#{valid_ip6})               
+                /x then
+              add_record('a4', :name => $1, :ttl => $2, :class => $3, :host => $4)
+    elsif line=~/^(#{valid_name})? \s*
+                 #{ttl_cls}
+                 MX \s
+                 (\d+) \s
+                 (#{valid_name})
+               /ix then
+               add_record('mx', :name => $1, :ttl => $2, :class => $3, :pri => $4.to_i, :host => $5)
+    elsif line=~/^(#{valid_name})? \s*
+                 #{ttl_cls}
+                 SRV \s
+                 (\d+) \s
+                 (\d+) \s
+                 (\d+) \s
+                 (#{valid_name})
+               /ix
+	       add_record('srv', :name => $1, :ttl => $2, :class => $3, :pri => $4, :weight => $5,
+	                         :port => $6, :host => $7)
+    elsif line=~/^(#{valid_name}) \s+
+                 #{ttl_cls}
+                 SOA \s+
+                 (#{valid_name}) \s+
+                 (#{valid_name}) \s*
+                 \(?\s*
+                     (#{rr_ttl}) \s+
+                     (#{rr_ttl}) \s+
+                     (#{rr_ttl}) \s+
+                     (#{rr_ttl}) \s+
+                     (#{rr_ttl}) \s*
+                 \)?
+               /ix
+            ttl = @soa[:ttl] || $2 || ''
+            @soa[:origin] = $1
+            @soa[:ttl] = ttl
+            @soa[:primary] = $4
+            @soa[:email] = $5
+            @soa[:serial] = $6
+            @soa[:refresh] = $7
+            @soa[:retry] = $8
+            @soa[:expire] = $9
+            @soa[:minimumTTL] = $10
+
+    elsif line=~ /^(#{valid_name})? \s*
+                #{ttl_cls}
+                PTR \s+
+                (#{valid_name})
+               /ix
+            add_record('ptr', :name => $1, :class => $3, :ttl => $2, :host => $4)
+    elsif line =~ /(#{valid_name})? \s #{ttl_cls} TXT \s \"([^\"]*)\"/ix
+            add_record('txt', :name => $1, :ttl => $2, :class => $3, :text => $4)
+    elsif line =~ /\$TTL\s+(#{rr_ttl})/i 
+            @soa[:ttl] = $1
+    end
+ end
+
+ def parse
+    Zonefile.simplify(@data).each_line do |line|
+        parse_line(line)      
+    end
+ end
+ 
+ 
+ # Build a new nicely formatted Zonefile
+ #
+ def output
+    out =<<-ENDH
+;
+;  Database file #{@filename || 'unknown'} for #{@origin || 'unknown'} zone.
+;	Zone version: #{self.soa[:serial]}
+;
+#{self.soa[:ttl] ? "$TTL #{self.soa[:ttl]}" : ''}
+#{self.soa[:origin]}		#{self.soa[:ttl]} IN  SOA  #{self.soa[:primary]} #{self.soa[:email]} (
+				#{self.soa[:serial]}	; serial number
+				#{self.soa[:refresh]}	; refresh
+				#{self.soa[:retry]}	; retry
+				#{self.soa[:expire]}	; expire
+				#{self.soa[:minimumTTL]}	; minimum TTL
+				)
+; Zone NS Records
+ENDH
+   self.ns.each do |ns|
+     out <<  "#{ns[:name]}	#{ns[:ttl]}	#{ns[:class]}	NS	#{ns[:host]}\n"
+   end
+   out << "\n; Zone MX Records\n" unless self.mx.empty?
+   self.mx.each do |mx|
+     out << "#{mx[:name]}	#{mx[:ttl]}	#{mx[:class]}	MX	#{mx[:pri]} #{mx[:host]}\n"
+   end
+   
+   self.a.each do |a|
+        out <<  "#{a[:name]}	#{a[:ttl]}	#{a[:class]}	A	#{a[:host]}\n"
+   end   
+   self.cname.each do |cn|
+     out << "#{cn[:name]}	#{cn[:ttl]}	#{cn[:class]}	CNAME	#{cn[:host]}\n"
+   end  
+   self.a4.each do |a4|
+     out << "#{a4[:name]}	#{a4[:ttl]}	#{a4[:class]}	AAAA	#{a4[:host]}\n"
+   end
+   self.txt.each do |tx|
+     out << "#{tx[:name]}	#{tx[:ttl]}	#{tx[:class]}	TXT	\"#{tx[:text]}\"\n"
+   end
+   self.srv.each do |srv|
+     out << "#{srv[:name]}	#{srv[:ttl]}	#{srv[:class]}	SRV	#{srv[:pri]} #{srv[:weight]} #{srv[:port]}	#{srv[:host]}\n"
+   end
+   
+   out
+ end
+
+end
+

data/lib/zonefile.rb

@@ -0,0 +1 @@
+require 'zonefile/zonefile'

data/tests/test-zone.db

@@ -0,0 +1,32 @@
+;  Database file dns-zoneparse-test.net.dns for dns-zoneparse-test.net zone.
+;      Zone version:  2000100501
+$TTL 1H
+@                       3600	IN	SOA	ns0.dns-zoneparse-test.net.	support.dns-zoneparse-test.net.	(
+                        2000100501   ; serial number
+                        10800       ; refresh
+                        3600        ; retry
+                        691200      ; expire
+                        86400     ) ; minimum TTL
+
+         43200          IN	NS	ns0.dns-zoneparse-test.net.	; ( A multi line
+         comment )
+@                       IN	NS	ns1.dns-zoneparse-test.net.
+
+@                       IN	A	127.0.0.1
+@                       IN	MX	10	mail
+ftp                     IN	CNAME	www
+localhost               IN	A	127.0.0.1
+mail                    IN	A	127.0.0.1
+www                     IN	A	127.0.0.1
+                        in      a       10.0.0.2
+         43200          IN      A       10.0.0.3
+                        IN      MX      10      10.0.0.4
+                                A       10.0.0.5
+                                TXT     "web server"
+foo                     IN      A       10.0.0.6
+mini                            A       10.0.0.7
+icarus                  IN      AAAA    fe80::0260:83ff:fe7c:3a2a
+soup                    IN      TXT     "This is a text message"
+txta                            TXT     "This is another text message"
+_sip._tcp.example.com. 86400 IN SRV 0 5 5060 sipserver.example.com.
+

data/tests/zonefile.rb

@@ -0,0 +1,141 @@
+require 'test/unit'
+
+
+$: << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'zonefile'
+
+$zonefile = ARGV[0] || 'test-zone.db'
+
+class TC_Zonefile  < Test::Unit::TestCase
+
+  def setup
+    @zf = Zonefile.from_file(File.dirname(__FILE__) + '/'+$zonefile, 'test-origin')
+  end
+
+  def swap # generate output and re-read @zf from it
+    @zf = Zonefile.new(@zf.output, 'test-origin')
+  end
+
+  def test_soa
+    assert_equal '86400', @zf.soa[:minimumTTL]
+    assert_equal '691200', @zf.soa[:expire]
+    assert_equal '3600', @zf.soa[:retry]
+    assert_equal '10800', @zf.soa[:refresh]
+    assert_equal '2000100501', @zf.soa[:serial]
+    assert_equal 'support.dns-zoneparse-test.net.', @zf.soa[:email]
+    assert_equal 'ns0.dns-zoneparse-test.net.', @zf.soa[:primary]
+    
+    begin
+      @swap_soa = true
+      swap
+      test_soa
+    end unless @swap_soa
+  end
+
+  def test_a
+    assert_equal 9, @zf.a.size
+    assert_equal 'mini', @zf.a.last[:name]
+    assert_equal '10.0.0.7', @zf.a.last[:host]
+    assert_equal '127.0.0.1', @zf.a.first[:host]
+
+    a = @zf.a.find { |a| a[:host] == '10.0.0.3'}
+    assert_equal '43200', a[:ttl]
+    assert_equal '', a[:name].to_s
+
+    begin
+      @swap_a = true
+      swap
+      test_a
+    end unless @swap_a
+  end
+
+  def test_mx
+    assert_equal 2, @zf.mx.size
+    assert_equal 10, @zf.mx.first[:pri]
+    begin
+      @swap_mx = true
+      swap
+      test_mx
+    end unless @swap_mx
+  end
+  
+  def test_cname 
+    assert !!@zf.cname.find { |e| e[:host] == 'www' }
+    begin
+      @swap_cname = true
+      swap
+      test_cname
+    end unless @swap_cname
+  end
+  
+  def test_ns
+    assert_equal 'ns0.dns-zoneparse-test.net.', @zf.ns[0][:host]
+    assert_equal 'ns1.dns-zoneparse-test.net.', @zf.ns[1][:host]
+    begin
+      @swap_ns = true
+      swap
+      test_ns
+    end unless @swap_ns
+  end
+  
+  def test_txt
+    assert_equal 'web server', @zf.txt[0][:text]
+    assert_equal 'IN', @zf.txt[1][:class]
+    assert_equal 'soup', @zf.txt[1][:name]
+    assert_equal 'txta', @zf.txt[2][:name]
+    assert_equal 3, @zf.txt.size
+    begin
+      @swap_txt = true
+      swap
+      test_txt
+    end unless @swap_txt
+  end
+  
+  def test_a4
+    assert_equal 'icarus', @zf.a4[0][:name]
+    assert_equal 'IN', @zf.a4[0][:class]
+    assert_equal 1, @zf.a4.size
+    assert_equal 'fe80::0260:83ff:fe7c:3a2a', @zf.a4[0][:host]
+    begin
+      @swap_a4 = true
+      swap
+      test_a4
+    end unless @swap_a4
+  end
+  
+  def test_srv
+    assert_equal '_sip._tcp.example.com.', @zf.srv[0][:name]
+    assert_equal '86400', @zf.srv[0][:ttl]
+    assert_equal '0', @zf.srv[0][:pri]
+    assert_equal '5', @zf.srv[0][:weight]
+    assert_equal '5060', @zf.srv[0][:port]
+    assert_equal 'sipserver.example.com.', @zf.srv[0][:host]
+    begin
+      @swap_srv = true
+      swap
+      test_srv
+    end unless @swap_srv
+  end
+  
+  def test_serial_generator
+    old = @zf.soa[:serial]
+    new = @zf.new_serial
+    assert new.to_i > old.to_i
+    newer = @zf.new_serial
+    assert newer.to_i - 1, new
+    
+    @zf.soa[:serial] = '9999889901'
+    @zf.new_serial
+    assert_equal '9999889902', @zf.soa[:serial]
+
+  end
+  
+  
+  def test_output
+#      puts @zf.data
+#      puts '==================='
+#      puts @zf.output  
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: zonefile
+version: !ruby/object:Gem::Version 
+  version: "1.00"
+platform: ruby
+authors: 
+- Martin Boese
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-04 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: martin@internet.ao
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/zonefile
+- lib/zonefile/zonefile.rb
+- lib/zonefile.rb
+- tests/test-zone.db
+- tests/zonefile.rb
+has_rdoc: true
+homepage: http://zonefile.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: zonefile
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: BIND 8/9 Zonefile Reader and Writer
+test_files: []
+