Dnsruby 0.6.0 → 1.0

data/lib/dnsruby.rb

@@ -18,11 +18,8 @@ require 'Dnsruby/code_mapper'
 require 'Dnsruby/ipv4'
 require 'Dnsruby/ipv6'
 require 'timeout'
-#--
-#@TODO@ Add to this with ideas from DNS.rb?
-#++
 #= Dnsruby library
-#Dnsruby is a resolver library written in Ruby.
+#Dnsruby is a thread-aware DNS stub resolver library written in Ruby.
 #
 #It is based on resolv.rb, the standard Ruby DNS implementation, 
 #but gives a complete DNS implementation complying with all relevant 
@@ -40,15 +37,15 @@ require 'timeout'
 #Resolver queries return Dnsruby::Message objects.  Message objects have five
 #sections:
 #
-# * The header section, a Dnsruby::Header object.
+#* The header section, a Dnsruby::Header object.
 #
-# * The question section, a list of Dnsruby::Question objects.
+#* The question section, a list of Dnsruby::Question objects.
 #
-# * The answer section, a list of Dnsruby::Resource objects.
+#* The answer section, a list of Dnsruby::Resource objects.
 #
-# * The authority section, a list of Dnsruby::Resource objects.
+#* The authority section, a list of Dnsruby::Resource objects.
 #
-# * The additional section, a list of Dnsruby::Resource objects.
+#* The additional section, a list of Dnsruby::Resource objects.
 #
 #
 #== example
@@ -62,22 +59,26 @@ require 'timeout'
 #
 #== exceptions
 #
-#  * ResolvError < StandardError
+#* ResolvError < StandardError
 #  
-#  * ResolvTimeout < TimeoutError
+#* ResolvTimeout < TimeoutError
+# 
+#* NXDomain < ResolvError
 #  
-#  * NXDomain < ResolvError
+#* FormErr < ResolvError
 #  
-#  * FormErr < ResolvError
+#* ServFail < ResolvError
 #  
-#  * ServFail < ResolvError
+#* NotImp < ResolvError
 #  
-#  * NotImp < ResolvError
+#* Refused < ResolvError
 #  
-#  * Refused < ResolvError
-#  
-#  * OtherResolvError < ResolvError
+#* OtherResolvError < ResolvError
 #  
+#== I/O
+#Dnsruby implements a pure Ruby event loop to perform I/O.
+#Dnsruby can also use EventMachine to perform I/O, if it is available on the 
+#platform - but it must be enabled through the Dnsruby::Resolver class
 #
 #== Bugs
 #* NIS is not supported.
@@ -335,97 +336,101 @@ module Dnsruby
   end
   
   
+  #An error raised while querying for a resource
   class ResolvError < StandardError
   end
   
+  #A timeout error raised while querying for a resource
   class ResolvTimeout < TimeoutError
   end
   
+  #The requested domain does not exist
   class NXDomain < ResolvError
   end
   
+  #A format error in a received DNS message
   class FormErr < ResolvError
   end
   
+  #Indicates a failure in the remote resolver
   class ServFail < ResolvError
   end
   
+  #The requested operation is not implemented in the remote resolver
   class NotImp < ResolvError
   end
   
+  #The requested operation was refused by the remote resolver
   class Refused < ResolvError
   end
   
+  #Another kind of resolver error has occurred
   class OtherResolvError < ResolvError
   end
   
-#== Dnsruby::Resolv class
-#
-#=== class methods
-#* Dnsruby::Resolv.getaddress(name)
-#* Dnsruby::Resolv.getaddresses(name)
-#* Dnsruby::Resolv.each_address(name) {|address| ...}
-#
-#    They lookups IP addresses of ((|name|)) which represents a hostname
-#    as a string by default resolver.
-#
-#*    getaddress returns first entry of resultant addresses.
-#*    getaddresses returns resultant addresses as an array.
-#*    each_address iterates over resultant addresses.
-#
-#* Dnsruby::Resolv.getname(address)
-#* Dnsruby::Resolv.getnames(address)
-#* Dnsruby::Resolv.each_name(address) {|name| ...}
-#    lookups hostnames of ((|address|)) which represents IP address as a string.
-#
-#*    getname returns first entry of resultant names.
-#*    getnames returns resultant names as an array.
-#*    each_names iterates over resultant names.
-#
-#The DNS class may be used to perform more queries. If greater control over the sending 
-#of packets is required, then the Resolver or SingleResolver classes may be used.
-#
+  #Indicates an error in decoding an incoming DNS message
+  class DecodeError < StandardError
+  end
+
+  #Indicates an error encoding a DNS message for transmission
+  class EncodeError < StandardError
+  end
+
+  #The Resolv class can be used to resolve addresses using /etc/hosts and /etc/resolv.conf, 
+  #
+  #The DNS class may be used to perform more queries. If greater control over the sending 
+  #of packets is required, then the Resolver or SingleResolver classes may be used.
   class Resolv
     
+    #Looks up the first IP address for +name+
     def self.getaddress(name)
       DefaultResolver.getaddress(name)
     end
     
+    #Looks up all IP addresses for +name+
     def self.getaddresses(name)
       DefaultResolver.getaddresses(name)
     end
     
+    #Iterates over all IP addresses for +name+
     def self.each_address(name, &block)
       DefaultResolver.each_address(name, &block)
     end
     
+    #Looks up the first hostname of +address+
     def self.getname(address)
       DefaultResolver.getname(address)
     end
     
+    #Looks up all hostnames of +address+
     def self.getnames(address)
       DefaultResolver.getnames(address)
     end
     
+    #Iterates over all hostnames of +address+
     def self.each_name(address, &proc)
       DefaultResolver.each_name(address, &proc)
     end
     
+    #Creates a new Resolv using +resolvers+
     def initialize(resolvers=[Hosts.new, DNS.new])
       @resolvers = resolvers
     end
     
+    #Looks up the first IP address for +name+
     def getaddress(name)
       each_address(name) {|address| return address}
       raise ResolvError.new("no address for #{name}")
     end
     
+    #Looks up all IP addresses for +name+
     def getaddresses(name)
       ret = []
       each_address(name) {|address| ret << address}
       return ret
     end
     
+    #Iterates over all IP addresses for +name+
     def each_address(name)
       if AddressRegex =~ name
         yield name
@@ -441,17 +446,20 @@ module Dnsruby
       }
     end
     
+    #Looks up the first hostname of +address+
     def getname(address)
       each_name(address) {|name| return name}
       raise ResolvError.new("no name for #{address}")
     end
     
+    #Looks up all hostnames of +address+
     def getnames(address)
       ret = []
       each_name(address) {|name| ret << name}
       return ret
     end
     
+    #Iterates over all hostnames of +address+
     def each_name(address)
       yielded = false
       @resolvers.each {|r|
@@ -470,7 +478,11 @@ module Dnsruby
     require 'Dnsruby/DNSSEC'
     require 'Dnsruby/update'
     require 'Dnsruby/zone_transfer'
+    
+    #Default Resolver to use for Dnsruby class methods
     DefaultResolver = self.new
+    
+    #Address RegExp to use for matching IP addresses
     AddressRegex = /(?:#{IPv4::Regex})|(?:#{IPv6::Regex})/
   end
 end

data/test/tc_axfr.rb

@@ -15,8 +15,7 @@
 #++
 require 'rubygems'
 require 'test/unit'
-require 'Dnsruby'
-require 'socket'
+require 'dnsruby'
 class TestAxfr < Test::Unit::TestCase
   def test_axfr
     zt = Dnsruby::ZoneTransfer.new
@@ -24,19 +23,58 @@ class TestAxfr < Test::Unit::TestCase
     zt.server = "ns0.validation-test-servers.nominet.org.uk"
     zone = zt.transfer("validation-test-servers.nominet.org.uk")
     assert(zone.length > 0)
+    assert(zt.last_tsigstate==nil)
   end
+
+  KEY_NAME="rubytsig"
+  KEY = "8n6gugn4aJ7MazyNlMccGKH1WxD2B3UvN/O/RA6iBupO2/03u9CTa3Ewz3gBWTSBCH3crY4Kk+tigNdeJBAvrw=="
   
   def test_ixfr
-    # @TODO@
-    #           zone.gsub!(/\.$/o, "")
-
+  # Check the SOA serial, do an update, check that the IXFR for that soa serial gives us the update we did,
+  # then delete the updated record
+   start_soa_serial = get_soa_serial("validation-test-servers.nominet.org.uk")
+    
+    # Now do an update
+    res = Dnsruby::Resolver.new("ns0.validation-test-servers.nominet.org.uk")
+    res.query_timeout=10
+    res.tsig=KEY_NAME, KEY
+    
+    update = Dnsruby::Update.new("validation-test-servers.nominet.org.uk")
+    # Generate update record name, and test it has been made. Then delete it and check it has been deleted
+    update_name = Time.now.to_i.to_s + rand(100).to_s + ".update.validation-test-servers.nominet.org.uk"
+    update.absent(update_name)
+    update.add(update_name, 'TXT', 100, "test zone transfer")
+    assert(!update.signed?, "Update has been signed")
+    
+    response = res.send_message(update)
+    assert(response.header.rcode == Dnsruby::RCode.NOERROR)
+    
+   end_soa_serial = get_soa_serial("validation-test-servers.nominet.org.uk")
+    
     zt = Dnsruby::ZoneTransfer.new
     zt.transfer_type = Dnsruby::Types.IXFR
     zt.server = "ns0.validation-test-servers.nominet.org.uk"
-    zt.serial = 2007090401
+    zt.serial = start_soa_serial # 2007090401
     deltas = zt.transfer("validation-test-servers.nominet.org.uk")
     assert(deltas.length > 0)
     assert(deltas[0].class == Dnsruby::ZoneTransfer::Delta)
-    assert_equal("Should show up in transfer", deltas[0].adds[1].data)
+    assert_equal("test zone transfer", deltas[0].adds[1].strings.join(" "))
+    assert(zt.last_tsigstate==nil)
+    
+    # Now delete the updated record
+    update = Dnsruby::Update.new("validation-test-servers.nominet.org.uk")
+    update.present(update_name, 'TXT')
+    update.delete(update_name)
+    response = res.send_message(update)
+    assert_equal( Dnsruby::RCode.NOERROR, response.header.rcode)
+  end
+  
+  def get_soa_serial(name)
+    soa_serial = nil
+    Dnsruby::DNS.open {|dns|
+      soa_rr = dns.getresource(name, 'SOA')
+      soa_serial = soa_rr.serial
+    }
+    return soa_serial    
   end
 end

data/test/tc_dns.rb

@@ -74,7 +74,7 @@ class TestDNS < Test::Unit::TestCase
     #
     # Check that new() is vetting things properly.
     #
-    
+    Dnsruby::TheLog.level=Logger::FATAL
     [:nameserver].each do |test|
       [{}, 'string',1,'\1',nil].each do |input|
         res=nil
@@ -180,7 +180,6 @@ class TestDNS < Test::Unit::TestCase
                   :domain     => 't.dnsruby.validation-test-servers.nominet.org.uk',
     :search => ["t.dnsruby.validation-test-servers.nominet.org.uk", "dnsruby.validation-test-servers.nominet.org.uk"]
     )
-    p res
     
     #
     # test the send_query() appends the default domain and 

data/test/tc_em_deferrable.rb

@@ -3,7 +3,7 @@ $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 require 'rubygems'
 require 'test/unit'
 require 'eventmachine'
-require 'Dnsruby'
+require 'dnsruby'
 #begin
 #  require 'test/tc_single_resolver'
 #rescue Exception
@@ -11,9 +11,8 @@ require 'Dnsruby'
 #end
 
 class EmDeferrableTest < Test::Unit::TestCase
-    Dnsruby::Resolver.use_eventmachine(true)
+  Dnsruby::Resolver.use_eventmachine(true)
   def setup
-    #Dnsruby::TheLog.level=Logger::DEBUG
     Dnsruby::Resolver.use_eventmachine(true)
   end
   def teardown
@@ -21,24 +20,16 @@ class EmDeferrableTest < Test::Unit::TestCase
   end
   
   def test_deferrable_success
-    Dnsruby::TheLog.level=Logger::DEBUG
     res = Dnsruby::SingleResolver.new
     Dnsruby::Resolver.use_eventmachine
     q = Queue.new
     id = 1
     done = false
-        EM.run {
-    df = res.send_async(Dnsruby::Message.new("nominet.org.uk"), id, q) #@TODO@ Shouldn't need ID and queue
-    df.callback {|id, msg| puts "callback: #{id}, #{msg}"; done = true; EM.stop}
-    df.errback {|id, msg, err| puts "errback: #{id}, #{msg}, #{err}"; done = true; EM.stop}
-        }
-#    while (!done)
-#      sleep 0.1
-#    end
-#    #    id+=1
-#    #    df2 = res.send_async(Dnsruby::Message.new("example.com"), id, q)
-#    #    df2.callback {|obj| puts "callback" + obj}
-#    #    df2.errback {|obj| puts "errback" + obj}
+    EM.run {
+      df = res.send_async(Dnsruby::Message.new("nominet.org.uk"))
+      df.callback {|id, msg| puts "callback: #{id}, #{msg}"; done = true; EM.stop}
+      df.errback {|id, msg, err| puts "errback: #{id}, #{msg}, #{err}"; done = true; EM.stop}
+    }
   end
   
   def test_deferrable_timeout

data/test/tc_escapedchars.rb

@@ -32,17 +32,7 @@ class TestEscapedChars < Test::Unit::TestCase
     # invidual labels by a regular expression. It made no sense to remove
     # the more ackward tests as they have to pass anyway ...
     
-    
-    # @todo Net::DNS still to have this functionality
-    #~ message="Using the "
-    #~ message+= if (Net::HAVE_XS) then " XS compiled " else " perl implemented " end
-    #~ message+="dn_expand function "
-    #~ diag (message)
-    
-    
-    #~ had_xs=Net::HAVE_XS 
-    
-    
+        
     # Note that in perl the \\ in a presentation format can only be achieved
     # through \\\\ .
     
@@ -50,7 +40,6 @@ class TestEscapedChars < Test::Unit::TestCase
     # length octet. content octets, length octet, content , NULL octet
     
     
-    
     # Below are test combos, 1st and 2nd array elements are
     # representations of the name. The output of the perl functions should
     # yield the 2nd presentation (eg \037 gets presented as % )
@@ -59,11 +48,6 @@ class TestEscapedChars < Test::Unit::TestCase
     # The 4th element represents the number of octets per label
     # The 5th element is a hexdump of the domain name in wireformat
     
-    # The optional 6th element is a boolean instructing to use the perl
-    # based dn_expand.  This because the conversion between the native
-    # dn_expand output to a perl varialbe provides some problems.
-    
-    
     testcombos=[
     ['bla.fo\.o.org',
 	 'bla.fo\.o.org',
@@ -108,8 +92,8 @@ class TestEscapedChars < Test::Unit::TestCase
 	 "05626c61003003666f6f036f726700"  ,
     ],
     
-    ['bla.fo\o.org',
-	 'bla.foo.org',
+    ["bla.fo\o.org",
+	 "bla.foo.org",
     3,
     [3,3,3],
     #Wire:            3 b l a 3 f o o 3 o r g 0   ignoring backslash on input	  
@@ -132,8 +116,8 @@ class TestEscapedChars < Test::Unit::TestCase
 	 "012003626c6103666f6f036f726700",
     ],
     
-    ['\\\\a.foo',
-	 '\\\\a.foo',
+    ["\\\\a.foo",
+	 "\\\\a.foo",
     2,
     [2,3],
     #Wire:            2 \ a  3 f o o 0		  

data/test/tc_event_machine_deferrable.rb

@@ -3,7 +3,7 @@ $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 require 'rubygems'
 require 'test/unit'
 require 'eventmachine'
-require 'Dnsruby'
+require 'dnsruby'
 
 class EventMachineTestDeferrable < Test::Unit::TestCase
   Dnsruby::Resolver.use_eventmachine(true)

data/test/tc_event_machine_res.rb

@@ -3,7 +3,7 @@ $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 require 'rubygems'
 require 'test/unit'
 require 'eventmachine'
-require 'Dnsruby'
+require 'dnsruby'
 
 class EventMachineTestResolver < Test::Unit::TestCase
   include Dnsruby