zonefile 1.03 → 1.04

data/lib/zonefile/zonefile.rb

@@ -27,6 +27,21 @@
 #    - :name, :ttl, :class, :host
 # * SRV
 #    - :name, :ttl, :class, :pri, :weight, :port, :host
+# * DS
+#    - :name, :ttl, :class, :key_tag, :algorithm, :digest_type, :digest
+# * DNSKEY
+#    - :name, :ttl, :class, :flag, :protocol, :algorithm, :public_key
+# * RRSIG
+#    - :name, :ttl, :class, :type_covered, :algorithm, :labels, :original_ttl,
+#      :expiration, :inception, :key_tag, :signer, :signature
+# * NSEC
+#    - :name, :ttl, :class, :next, :types
+# * NSEC3
+#    - :name, :ttl, :class, :algorithm, :flags, :iterations, :salt, :next, :types
+# * NSEC3PARAM
+#    - :name, :ttl, :class, :algorithm, :flags, :iterations, :salt
+# * NAPTR
+#    - :name, :ttl, :class, :order, :preference, :flags, :service, :regexp, :replacement
 #
 # == Examples
 #
@@ -68,14 +83,22 @@
 #  # Print new zonefile
 #  puts "New Zonefile: \n#{zf.output}"
 #
-# == Author
+# == Name attribute magic
+#
+# Since 1.04 the :name attribute is preserved and returned as defined in a previous record if a zonefile entry
+# omits it. This should be the expected behavior for most users.
+# You can switch this off globally by calling Zonefile.preserve_name(false)
+#
+# == Authors
 # 
-# Martin Boese, based on Simon Flack Perl library DNS::ZoneParse
+# Martin Boese, based on Simon Flack Perl library DNS::ZoneParse 
+#
+# Andy Newton, patch to support various additional records
 #
 
 class Zonefile
 
- RECORDS = %w{ mx a a4 ns cname txt ptr srv soa }
+ RECORDS = %w{ mx a a4 ns cname txt ptr srv soa ds dnskey rrsig nsec nsec3 nsec3param naptr }
  attr :records
  attr :soa
  attr :data
@@ -84,6 +107,15 @@ class Zonefile
  # global $TTL option
  attr :ttl
  
+ @@preserve_name = true
+
+ # For compatibility: This can switches off copying of the :name from the 
+ # previous record in a zonefile if found omitted. 
+ # This was zonefile's behavior in <= 1.03 .  
+ def self.preserve_name(do_preserve_name)
+   @@preserve_name = do_preserve_name
+ end
+ 
  def method_missing(m, *args)
    mname = m.to_s.sub("=","")
    return super unless RECORDS.include?(mname)
@@ -101,7 +133,7 @@ class Zonefile
  # 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 = zf.gsub(/(\([^\)]*?\))/) { |m| m.split(/\n/).map { |l| l.gsub(/\;.*$/, '') }.join("\n").gsub(/[\r\n]/, '').gsub( /[\(\)]/, '') }
 
     zf.split(/\n/).map do |line|
         r = line.gsub(/\t/, ' ')
@@ -145,6 +177,10 @@ class Zonefile
  end
  
  def add_record(type, data= {})
+    if @@preserve_name then
+      @lastname = data[:name] if data[:name].to_s != ''
+      data[:name] = @lastname if data[:name].to_s == ''
+    end
     @records[type.downcase.intern] << data
  end
  
@@ -172,6 +208,9 @@ class Zonefile
     rr_type    = /\b(?:NS|A|CNAME)\b/i
     rr_ttl     = /(?:\d+[wdhms]?)+/i
     ttl_cls    = Regexp.new("(?:(#{rr_ttl})\s)?(?:(#{rr_class})\s)?")
+    base64     = /([\s\w\+\/]*=*)/i
+    hexadeimal = /([\sA-F0-9]*)/i
+    quoted     = /(\"[^\"]*\")/i
 
     data = {}
     if line =~ /^\$ORIGIN\s*(#{valid_name})/ix then
@@ -206,18 +245,94 @@ class Zonefile
                /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}
+                DS \s
+                (\d+) \s
+                (\w+) \s
+                (\d+) \s
+                #{hexadeimal}
+                /ix
+        add_record( 'ds', :name => $1, :ttl => $2, :class => $3, :key_tag => $4.to_i, :algorithm => $5,
+                    :digest_type => $6.to_i, :digest => $7.gsub( /\s/,'') )
+    elsif line=~/^(#{valid_name})? \s*
+                #{ttl_cls}
+                NSEC \s
+                (#{valid_name}) \s
+                ([\s\w]*)
+                /ix
+      add_record( 'nsec', :name => $1, :ttl => $2, :class => $3, :next => $4, :types => $5.strip )
+    elsif line=~/^(#{valid_name})? \s*
+                #{ttl_cls}
+                NSEC3 \s
+                (\d+) \s
+                (\d+) \s
+                (\d+) \s
+                (-|[A-F0-9]*) \s
+                ([A-Z2-7=]*) \s
+                ([\s\w]*)
+                /ix
+      add_record( 'nsec3', :name => $1, :ttl => $2, :class => $3, :algorithm => $4, :flags => $5,
+                   :iterations => $6, :salt => $7, :next => $8.strip, :types => $9.strip )
+    elsif line=~/^(#{valid_name})? \s*
+                #{ttl_cls}
+                NSEC3PARAM \s
+                (\d+) \s
+                (\d+) \s
+                (\d+) \s
+                (-|[A-F0-9]*)
+                /ix
+      add_record( 'nsec3param', :name => $1, :ttl => $2, :class => $3, :algorithm => $4, :flags => $5,
+                  :iterations => $6, :salt => $7 )
+    elsif line=~/^(#{valid_name})? \s*
+                #{ttl_cls}
+                DNSKEY \s
+                (\d+) \s
+                (\d+) \s
+                (\w+) \s
+                #{base64}
+                /ix
+      add_record( 'dnskey', :name => $1, :ttl => $2, :class => $3, :flag => $4.to_i, :protocol => $5.to_i,
+                  :algorithm => $6, :public_key => $7.gsub( /\s/,'') )
+    elsif line=~/^(#{valid_name})? \s*
+                #{ttl_cls}
+                RRSIG \s
+                (\w+) \s
+                (\w+) \s
+                (\d+) \s
+                (\d+) \s
+                (\d+) \s
+                (\d+) \s
+                (\d+) \s
+                (#{valid_name}) \s
+                #{base64}
+                /ix
+      add_record( 'rrsig', :name => $1, :ttl => $2, :class => $3, :type_covered => $4, :algorithm => $5,
+                  :labels => $6.to_i, :original_ttl => $7.to_i, :expiration => $8.to_i, :inception => $9.to_i,
+                  :key_tag => $10.to_i, :signer => $11, :signature => $12.gsub( /\s/,'')  )
+    elsif line=~/^(#{valid_name})? \s*
+                #{ttl_cls}
+                NAPTR \s
+                (\d+) \s
+                (\d+) \s
+                #{quoted} \s
+                #{quoted} \s
+                #{quoted} \s
+                (#{valid_name})
+                /ix
+      add_record( 'naptr', :name => $1, :ttl => $2, :class => $3, :order => $4.to_i, :preference => $5.to_i,
+                  :flags => $6, :service => $7, :regexp => $8, :replacement => $9 )
     elsif line=~/^(#{valid_name}) \s+
                  #{ttl_cls}
                  SOA \s+
                  (#{valid_name}) \s+
                  (#{valid_name}) \s*
-                 \(?\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
@@ -308,7 +423,42 @@ ENDH
    self.ptr.each do |ptr|
      out << "#{ptr[:name]}	#{ptr[:ttl]}	#{ptr[:class]}	PTR	#{ptr[:host]}\n"
    end
-   
+
+   out << "\n; Zone DS Records\n" unless self.ds.empty?
+   self.ds.each do |ds|
+     out << "#{ds[:name]} #{ds[:ttl]} #{ds[:class]} DS #{ds[:key_tag]} #{ds[:algorithm]} #{ds[:digest_type]} #{ds[:digest]}\n"
+   end
+
+   out << "\n; Zone NSEC Records\n" unless self.ds.empty?
+   self.nsec.each do |nsec|
+     out << "#{nsec[:name]} #{nsec[:ttl]} #{nsec[:class]} NSEC #{nsec[:next]} #{nsec[:types]}\n"
+   end
+
+   out << "\n; Zone NSEC3 Records\n" unless self.ds.empty?
+   self.nsec3.each do |nsec3|
+     out << "#{nsec3[:name]} #{nsec3[:ttl]} #{nsec3[:class]} NSEC3 #{nsec3[:algorithm]} #{nsec3[:flags]} #{nsec3[:iterations]} #{nsec3[:salt]} #{nsec3[:next]} #{nsec3[:types]}\n"
+   end
+
+   out << "\n; Zone NSEC3PARAM Records\n" unless self.ds.empty?
+   self.nsec3param.each do |nsec3param|
+     out << "#{nsec3param[:name]} #{nsec3param[:ttl]} #{nsec3param[:class]} NSEC3PARAM #{nsec3param[:algorithm]} #{nsec3param[:flags]} #{nsec3param[:iterations]} #{nsec3param[:salt]}\n"
+   end
+
+   out << "\n; Zone DNSKEY Records\n" unless self.ds.empty?
+   self.dnskey.each do |dnskey|
+     out << "#{dnskey[:name]} #{dnskey[:ttl]} #{dnskey[:class]} DNSKEY #{dnskey[:flag]} #{dnskey[:protocol]} #{dnskey[:algorithm]} #{dnskey[:public_key]}\n"
+   end
+
+   out << "\n; Zone RRSIG Records\n" unless self.ds.empty?
+   self.rrsig.each do |rrsig|
+     out << "#{rrsig[:name]} #{rrsig[:ttl]} #{rrsig[:class]} RRSIG #{rrsig[:type_covered]} #{rrsig[:algorithm]} #{rrsig[:labels]} #{rrsig[:original_ttl]} #{rrsig[:expiration]} #{rrsig[:inception]} #{rrsig[:key_tag]} #{rrsig[:signer]} #{rrsig[:signature]}\n"
+   end
+
+   out << "\n; Zone NAPTR Records\n" unless self.ds.empty?
+   self.naptr.each do |naptr|
+     out << "#{naptr[:name]} #{naptr[:ttl]} #{naptr[:class]} NAPTR #{naptr[:order]} #{naptr[:preference]} #{naptr[:flags]} #{naptr[:service]} #{naptr[:regexp]} #{naptr[:replacement]}\n"
+   end
+
    out
  end
 

data/tests/test-zone.db

@@ -32,4 +32,26 @@ txta                            TXT     "t=y; o=-" 	; Nasty Comment
 _kerberos           IN  TXT     maxnet.ao
 _sip._tcp.example.com. 86400 IN SRV 0 5 5060 sipserver.example.com.
 12.23.21.23.in-addr.arpa	IN 	PTR	www.myhost.example.com.
-
+ds1                     IN DS 31528 5 1 2274EACD70C5CD6862E1C0262E99D48D9FDEC271
+ds2                     IN DS 31528 5 1 ( 2BB183AF5F22588179A53B0A
+                                          98631FAD1A292118 )
+example.com. 86400 IN DNSKEY 256 3 5 ( AQPSKmynfzW4kyBv015MUG2DeIQ3
+                                          Cbl+BBZH4b/0PY1kxkmvHjcZc8no
+                                          kfzj31GajIQKY+5CptLr3buXA10h
+                                          WqTkF7H6RfoRqXQeogmMHfpftf6z
+                                          Mv1LyBUgia7za6ZEzOJBOztyvhjL
+                                          742iU/TpPSEDhm2SNKLijfUppn1U
+                                          aNvv4w==  )
+example.net. 86400 IN DNSKEY 256 3 5 AQPSKmynfzW4kyBv015MUG2DeIQ3Cbl+BBZH4b/0PY1kxkmvHjcZc8nokfzj31GajIQKY+5CptLr3buXA10hWqTkF7H6RfoRqXQeogmMHfpftf6zMv1LyBUgia7za6ZEzOJBOztyvhjL742iU/TpPSEDhm2SNKLijfUppn1UaNvv4w==
+host.example.com. 86400 IN RRSIG A 5 3 86400 20030322173103 (
+                                  20030220173103 2642 example.com.
+                                  oJB1W6WNGv+ldvQ3WDG0MQkg5IEhjRip8WTr
+                                  PYGv07h108dUKGMeDPKijVCHX3DDKdfb+v6o
+                                  B9wfuh3DTJXUAfI/M0zmO/zz8bW0Rznl8O3t
+                                  GNazPwQKkRN20XPXV6nwwfoXmJQbsLNrLfkG
+                                  J5D6fwFm8nN+6pBzeDQfsS3Ap3o= )
+alfa.example.com. 86400 IN NSEC host.example.com. (
+                                   A MX RRSIG NSEC TYPE1234 )
+                        IN NSEC3   1 1 12 aabbccdd ( 2vptu5timamqttgl4luu7kg2leoaor3s A RRSIG )
+                        IN NSEC3PARAM 1 0 12 aabbccdd
+urn.example.com.        IN NAPTR 100  50  "s"    "http+N2L+N2C+N2R"  ""   www.example.com.

data/tests/zonefile.rb

@@ -5,6 +5,8 @@ $: << File.expand_path(File.dirname(__FILE__) + '/../lib')
 
 require 'zonefile'
 
+# Zonefile.preserve_name(false)
+
 $zonefile = ARGV[0] || 'test-zone.db'
 
 class TC_Zonefile  < Test::Unit::TestCase
@@ -60,7 +62,7 @@ class TC_Zonefile  < Test::Unit::TestCase
 
     a = @zf.a.find { |a| a[:host] == '10.0.0.3'}
     assert_equal '43200', a[:ttl]
-    assert_equal '', a[:name].to_s
+    assert_equal 'www', a[:name].to_s   # name preserved
 
     begin
       @swap_a = true
@@ -68,6 +70,19 @@ class TC_Zonefile  < Test::Unit::TestCase
       test_a
     end unless @swap_a
   end
+  
+  def test_preserve_name
+    Zonefile.preserve_name(false)
+    setup
+    a = @zf.a.find { |a| a[:host] == '10.0.0.2'}
+    assert_nil a[:name]             # no name preserved
+    assert_nil @zf.nsec3[0][:name]  # same here
+    Zonefile.preserve_name(true)
+    setup
+    a = @zf.a.find { |a| a[:host] == '10.0.0.2'}
+    assert_equal 'www', a[:name]        # now name IS preserved
+    assert_equal 'alfa.example.com.', @zf.nsec3[0][:name]  # same here
+  end
 
   def test_mx
     assert_equal 2, @zf.mx.size
@@ -164,7 +179,129 @@ class TC_Zonefile  < Test::Unit::TestCase
        test_ptr
      end unless @swap_ptr
   end
-  
+
+  def test_ds
+    assert_equal "ds1", @zf.ds[0][:name]
+    assert_equal 31528, @zf.ds[0][:key_tag]
+    assert_equal "5", @zf.ds[0][:algorithm]
+    assert_equal 1, @zf.ds[0][:digest_type]
+    assert_equal "2274EACD70C5CD6862E1C0262E99D48D9FDEC271", @zf.ds[0][:digest]
+    assert_equal "ds2", @zf.ds[1][:name]
+    assert_equal 31528, @zf.ds[1][:key_tag]
+    assert_equal "5", @zf.ds[1][:algorithm]
+    assert_equal 1, @zf.ds[1][:digest_type]
+    assert_equal "2BB183AF5F22588179A53B0A98631FAD1A292118", @zf.ds[1][:digest]
+    begin
+      @swap_ds = true
+      swap
+      test_ds
+    end unless @swap_ds
+  end
+
+  def test_nsec
+    assert_equal "alfa.example.com.", @zf.nsec[0][:name]
+    assert_equal "host.example.com.", @zf.nsec[0][:next]
+    assert_equal "A MX RRSIG NSEC TYPE1234", @zf.nsec[0][:types]
+    begin
+      @swap_nsec = true
+      swap
+      test_nsec
+    end unless @swap_nsec
+  end
+
+  def test_nsec3
+    assert_equal "1", @zf.nsec3[0][:algorithm]
+    assert_equal "1", @zf.nsec3[0][:flags]
+    assert_equal "12", @zf.nsec3[0][:iterations]
+    assert_equal "aabbccdd", @zf.nsec3[0][:salt]
+    assert_equal "2vptu5timamqttgl4luu7kg2leoaor3s", @zf.nsec3[0][:next]
+    assert_equal "A RRSIG", @zf.nsec3[0][:types]
+    begin
+      @swap_nsec3 = true
+      swap
+      test_nsec3
+    end unless @swap_nsec3
+  end
+
+  def test_nsec3param
+    assert_equal "1", @zf.nsec3param[0][:algorithm]
+    assert_equal "0", @zf.nsec3param[0][:flags]
+    assert_equal "12", @zf.nsec3param[0][:iterations]
+    assert_equal "aabbccdd", @zf.nsec3param[0][:salt]
+    begin
+      @swap_nsec3param = true
+      swap
+      test_nsec3param
+    end unless @swap_nsec3param
+  end
+
+  def test_naptr
+    assert_equal "urn.example.com.", @zf.naptr[0][:name]
+    assert_equal 100, @zf.naptr[0][:order]
+    assert_equal 50, @zf.naptr[0][:preference]
+    assert_equal "\"s\"", @zf.naptr[0][:flags]
+    assert_equal "\"http+N2L+N2C+N2R\"", @zf.naptr[0][:service]
+    assert_equal "\"\"", @zf.naptr[0][:regexp]
+    assert_equal "www.example.com.", @zf.naptr[0][:replacement]
+    begin
+      @swap_natpr = true
+      swap
+      test_naptr
+    end unless @swap_natpr
+  end
+
+  def test_dnskey
+    assert_equal "example.com.", @zf.dnskey[0][:name]
+    assert_equal 256, @zf.dnskey[0][:flag]
+    assert_equal 3, @zf.dnskey[0][:protocol]
+    assert_equal "5", @zf.dnskey[0][:algorithm]
+    pkey = <<PUBLIC_KEY.gsub( /\s+/,'').strip
+           AQPSKmynfzW4kyBv015MUG2DeIQ3
+           Cbl+BBZH4b/0PY1kxkmvHjcZc8no
+           kfzj31GajIQKY+5CptLr3buXA10h
+           WqTkF7H6RfoRqXQeogmMHfpftf6z
+           Mv1LyBUgia7za6ZEzOJBOztyvhjL
+           742iU/TpPSEDhm2SNKLijfUppn1U
+           aNvv4w==
+PUBLIC_KEY
+    assert_equal pkey, @zf.dnskey[0][:public_key]
+    assert_equal "example.net.", @zf.dnskey[1][:name]
+    assert_equal 256, @zf.dnskey[1][:flag]
+    assert_equal 3, @zf.dnskey[1][:protocol]
+    assert_equal "5", @zf.dnskey[1][:algorithm]
+    assert_equal pkey, @zf.dnskey[1][:public_key]
+    begin
+      @swap_dnskey = true
+      swap
+      test_dnskey
+    end unless @swap_dnskey
+  end
+
+  def test_rrsig
+    assert_equal "host.example.com.", @zf.rrsig[0][:name]
+    assert_equal 'A', @zf.rrsig[0][:type_covered]
+    assert_equal "5", @zf.rrsig[0][:algorithm]
+    assert_equal 3, @zf.rrsig[0][:labels]
+    assert_equal 86400, @zf.rrsig[0][:original_ttl]
+    assert_equal 20030322173103, @zf.rrsig[0][:expiration]
+    assert_equal 20030220173103, @zf.rrsig[0][:inception]
+    assert_equal 2642, @zf.rrsig[0][:key_tag]
+    assert_equal "example.com.", @zf.rrsig[0][:signer]
+    sig = <<SIGNATURE.gsub( /\s+/,'').strip
+        oJB1W6WNGv+ldvQ3WDG0MQkg5IEhjRip8WTr
+        PYGv07h108dUKGMeDPKijVCHX3DDKdfb+v6o
+        B9wfuh3DTJXUAfI/M0zmO/zz8bW0Rznl8O3t
+        GNazPwQKkRN20XPXV6nwwfoXmJQbsLNrLfkG
+        J5D6fwFm8nN+6pBzeDQfsS3Ap3o=
+SIGNATURE
+    assert_equal sig, @zf.rrsig[0][:signature]
+    begin
+      @swap_rrsig = true
+      swap
+      test_rrsig
+    end unless @swap_rrsig
+  end
+
   def test_origin
      assert_equal 'test-zone.db', @zf.origin
      swap

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: zonefile
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 1
-  - 3
-  version: "1.03"
+  - 4
+  version: "1.04"
 platform: ruby
 authors: 
 - Martin Boese
@@ -14,8 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-12 00:00:00 +01:00
-default_executable: 
+date: 2013-02-06 00:00:00 Z
 dependencies: []
 
 description: |-
@@ -35,7 +34,6 @@ files:
 - tests/test-zone.db
 - tests/zonefile.rb
 - CHANGELOG
-has_rdoc: true
 homepage: http://zonefile.rubyforge.org/
 licenses: []
 
@@ -65,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: zonefile
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: BIND 8/9 Zonefile Reader and Writer