Dnsruby 0.6.0 → 1.0

data/lib/Dnsruby/resource/domain_name.rb

@@ -15,17 +15,13 @@
 #++
 module Dnsruby
   class RR
-    # Superclass for RR's which have an additional domain name in the data section.
+    # Abstract superclass for RR's which have a domain name in the data section.
     class DomainName < RR
       # The domain name in the RR data section.
       attr_reader :domainname
       
       def set_domain_name(newname)
-        #        if (!(newname.kind_of?Name))
         @domainname=Name.create(newname)
-        #       else
-        #        @domainname = newname
-        #     end
       end
       
       alias domainname= set_domain_name

data/lib/Dnsruby/resource/generic.rb

@@ -17,6 +17,7 @@ module Dnsruby
   class RR
     #Class to store generic RRs (RFC 3597)
     class Generic < RR # RFC 3597
+      #data for the generic resource record
       attr_reader :data
       
       def from_data(data) #:nodoc: all
@@ -42,7 +43,7 @@ module Dnsruby
         return self.new(msg.get_bytes)
       end
       
-      def self.create(type_value, class_value)
+      def self.create(type_value, class_value) #:nodoc:
         c = Class.new(Generic)
         #          c.type = type_value
         #          c.klass = class_value
@@ -58,6 +59,7 @@ module Dnsruby
     # Standard (class generic) RRs
     #++
     #NS RR
+    #Nameserver resource record
     class NS < DomainName
       ClassValue = nil #:nodoc: all
       TypeValue = Types::NS #:nodoc: all
@@ -67,6 +69,7 @@ module Dnsruby
     end
     
     #CNAME RR
+    #The canonical name for an alias
     class CNAME < DomainName
       ClassValue = nil #:nodoc: all
       TypeValue = Types::CNAME #:nodoc: all
@@ -115,7 +118,7 @@ module Dnsruby
     end
     
     #ANY RR
-#    class ANY < Query
+    # A Query type requesting any RR
     class ANY < RR
       ClassValue = nil #:nodoc: all
       TypeValue = Types::ANY #:nodoc: all

data/lib/Dnsruby/resource/resource.rb

@@ -99,11 +99,11 @@ module Dnsruby
     @@RR_REGEX = Regexp.new("^\\s*(\\S+)\\s*(\\d+)?\\s*(#{Classes.regexp + "|CLASS\\d+"})?\\s*(#{Types.regexp + '|TYPE\\d+'})?\\s*([\\s\\S]*)\$") #:nodoc: all
     
     #The Resource's domain name
-    attr_accessor :name
+    attr_reader :name
     #The Resource type
-    attr_accessor :type
+    attr_reader :type
     #The Resource class
-    attr_accessor :klass
+    attr_reader :klass
     #The Resource Time-To-Live
     attr_accessor :ttl
     #The Resource data section
@@ -124,6 +124,7 @@ module Dnsruby
     def type=(type)
       @type = Types.new(type)
     end
+    alias :rr_type :type
     
     def klass=(klass)
       @klass= Classes.new(klass)
@@ -136,8 +137,13 @@ module Dnsruby
       return (@type == rec.type && @klass == rec.klass && @name== rec.name)
     end
     
+    def init_defaults
+      # Default to do nothing
+    end
+    
     private
     def initialize(*args) #:nodoc: all
+      init_defaults
       if (args.length > 0)
         if (args[0].class == Hash)
           from_hash(args[0])
@@ -153,7 +159,7 @@ module Dnsruby
           end
         end
       end
-#      raise ArgumentError.new("Don't call new! Use Dnsruby::RR::create() instead")
+      #      raise ArgumentError.new("Don't call new! Use Dnsruby::RR::create() instead")
     end
     public
     
@@ -176,7 +182,7 @@ module Dnsruby
     def RR.new_from_hash(inhash)
       hash = inhash.clone        
       type = hash[:type] || Types::ANY
-      klass = hash[:class] || Classes::IN
+      klass = hash[:klass] || Classes::IN
       ttl = hash[:ttl] || 0
       recordclass = get_class(type, klass)
       record = recordclass.new
@@ -190,7 +196,7 @@ module Dnsruby
       hash.delete(:name)
       hash.delete(:type)
       hash.delete(:ttl)
-      hash.delete(:class)
+      hash.delete(:klass)
       record.from_hash(hash)
       return record
     end
@@ -339,7 +345,7 @@ module Dnsruby
     
     #Returns a string representation of the RR in zone file format
     def to_s
-      return (@name?@name.to_s():"") + ".\t" +(@ttl?@ttl.to_s():"") + "\t" + (klass()?klass.string():"") + "\t" + (type()?type.string():"") + "\t" + rdata_to_string
+      return (@name?@name.to_s():"") + ".\t" +(@ttl?@ttl.to_s():"") + "\t" + (klass()?klass.to_s():"") + "\t" + (type()?type.to_s():"") + "\t" + rdata_to_string
     end
     
     #Get a string representation of the data section of the RR (in zone file format)
@@ -372,27 +378,39 @@ module Dnsruby
     end
     
     def ==(other)
-      # @TODO@ TTL should not be compared for Updates! (RFC 2136, 1.1.1)
-      return self.class == other.class &&
-        self.instance_variables == other.instance_variables &&
-        self.instance_variables.collect {|name| self.instance_eval name} ==
-        other.instance_variables.collect {|name| other.instance_eval name}
+      return false unless self.class == other.class
+      s_ivars = self.instance_variables
+      s_ivars.sort!
+      s_ivars.delete "@ttl" # RFC 2136 section 1.1
+      
+      o_ivars = other.instance_variables
+      o_ivars.sort!
+      o_ivars.delete "@ttl" # RFC 2136 section 1.1
+      
+      return s_ivars == o_ivars &&
+        s_ivars.collect {|name| self.instance_variable_get name} == 
+        o_ivars.collect {|name| other.instance_variable_get name}
     end
     
-    def eql?(other)
+    def eql?(other) #:nodoc:
       return self == other
     end
     
-    def hash
-      h = 0
-      self.instance_variables.each {|name|
-        h ^= self.instance_eval("#{name}.hash")
+    def hash # :nodoc:
+      h = 0      
+      vars = self.instance_variables
+      vars.delete "@ttl"
+      vars.each {|name|
+        h ^= self.instance_variable_get(name).hash
       }
       return h
     end
     
     #Get an RR of the specified type and class
     def self.get_class(type_value, class_value) #:nodoc: all
+      #      if (type_value == Types.OPT)
+      #        return Class.new(OPT)
+      #      end
       if (type_value.class == Class)
         type_value = type_value.const_get(:TypeValue)
         return ClassHash[[type_value, Classes.to_code(class_value)]] ||

data/lib/Dnsruby/select_thread.rb

@@ -65,22 +65,23 @@ module Dnsruby
     end
     
     class QuerySettings
-      attr_accessor :query, :query_header_id, :tsig, :ignore_truncation, :client_queue, 
-        :client_query_id, :socket, :dest_server, :dest_port, :endtime, :single_resolver
-      # new(query, query_header_id, tsig, ignore_truncation, client_queue, client_query_id,
-      #     socket, dest_server, dest_port, endtime, single_resolver)
+      attr_accessor :query_bytes, :query, :ignore_truncation, :client_queue, 
+        :client_query_id, :socket, :dest_server, :dest_port, :endtime, :udp_packet_size,
+        :single_resolver
+      # new(query_bytes, query, ignore_truncation, client_queue, client_query_id,
+      #     socket, dest_server, dest_port, endtime, , udp_packet_size, single_resolver)
       def initialize(*args)
-        @query = args[0]
-        @query_header_id = args[1]
-        @tsig=args[2]
-        @ignore_truncation=args[3]
-        @client_queue = args[4]
-        @client_query_id = args[5]
-        @socket = args[6]
-        @dest_server = args[7]
-        @dest_port=args[8]
-        @endtime = args[9]  
-        @single_resolver = args[10]        
+        @query_bytes = args[0]
+        @query = args[1]
+        @ignore_truncation=args[2]
+        @client_queue = args[3]
+        @client_query_id = args[4]
+        @socket = args[5]
+        @dest_server = args[6]
+        @dest_port=args[7]
+        @endtime = args[8]  
+        @udp_packet_size = args[9]
+        @single_resolver = args[10]
       end
     end
     
@@ -88,6 +89,8 @@ module Dnsruby
       # Add the query to sockets, and then wake the select thread up
       @@mutex.synchronize {
         check_select_thread_synchronized
+        # @TODO@ This assumes that all client_query_ids are unique!
+        # Would be a good idea at least to check this...
         @@query_hash[query_settings.client_query_id]=query_settings
         @@socket_hash[query_settings.socket]=[query_settings.client_query_id] # @todo@ If we use persistent sockets then we need to update this array
         @@timeouts[query_settings.client_query_id]=query_settings.endtime
@@ -169,18 +172,26 @@ module Dnsruby
       # @todo@ Process errors [can we do this in single socket environment?]
     end
     
+#        @@query_hash[query_settings.client_query_id]=query_settings
+#        @@socket_hash[query_settings.socket]=[query_settings.client_query_id] # @todo@ If we use persistent sockets then we need to update this array
     def process_ready(ready)
       ready.each do |socket|
-        packet_size = 512 # @TODO@ Sort out per-query packet sizes!!!
-        msg = get_incoming_data(socket, packet_size)
+        query_settings = nil
+        @@mutex.synchronize{
+          # Can do this if we have a query per socket, but not otherwise...
+          c_q_id = @@socket_hash[socket][0] # @todo@ If we use persistent sockets then this won't work
+          query_settings = @@query_hash[c_q_id]
+        }
+        udp_packet_size = query_settings.udp_packet_size
+        msg, bytes = get_incoming_data(socket, udp_packet_size)
         if (msg!=nil)
-          send_response_to_client(msg, socket)
+          send_response_to_client(msg, bytes, socket)
         end
         ready.delete(socket)
       end
     end
     
-    def send_response_to_client(msg, socket)
+    def send_response_to_client(msg, bytes, socket)
       # Figure out which client_ids we were expecting on this socket, then see if any header ids match up
       client_ids=[]
       @@mutex.synchronize{
@@ -190,7 +201,7 @@ module Dnsruby
       client_ids.each do |id|
         query_header_id=nil
         @@mutex.synchronize{
-          query_header_id = @@query_hash[id].query_header_id
+          query_header_id = @@query_hash[id].query.header.id
         }
         if (query_header_id == msg.header.id)
           # process the response
@@ -204,7 +215,7 @@ module Dnsruby
           }
           tcp = (socket.class == TCPSocket)
           # At this point, we should check if the response is OK
-          if (res.check_response(msg, query, client_queue, id, tcp))
+          if (res.check_response(msg, bytes, query, client_queue, id, tcp))
             remove_id(id)
             exception = msg.header.get_exception
             TheLog.debug("Pushing response to client queue")
@@ -312,7 +323,7 @@ module Dnsruby
         ans.answerfrom=(answerfrom)
         ans.answersize=(answersize)
       end
-      return ans
+      return ans, buf
     end
     
     def handle_recvfrom_failure(socket)
@@ -353,10 +364,6 @@ module Dnsruby
     end
     
     def send_exception_to_client(err, socket, client_id, msg=nil)
-      if ((!err.kind_of?ResolvError) && (!err.kind_of?ResolvTimeout))
-        TheLog.error("INCORRECT ERROR TYPE BEING RETURNED TO CLIENT")
-        raise RuntimeError.new("INCORRECT ERROR TYPE BEING RETURNED TO CLIENT")
-      end
       # find the client response queue
       client_queue = nil
       @@mutex.synchronize {

data/lib/Dnsruby/update.rb

@@ -29,7 +29,7 @@ module Dnsruby
   # update = Dnsruby::Update.new('example.com')
   # 
   # # Prerequisite is that no A records exist for the name.
-  # update.absent('foo.example.com. A')
+  # update.absent('foo.example.com.', 'A')
   # 
   # # Add two A records for the name.
   # update.add('foo.example.com.', 'A', 86400, '192.168.1.2')
@@ -60,7 +60,7 @@ module Dnsruby
   #== Delete all A records for a name
   #
   #    update = Dnsruby::Update.new('example.com')
-  #    update.present('foo.example.com A')
+  #    update.present('foo.example.com', 'A')
   #    update.delete('foo.example.com', 'A')
   #
   #== Delete all RRs for a name
@@ -77,7 +77,7 @@ module Dnsruby
   #    update = Dnsruby::Update.new('example.com')
   #    update.add('foo.example.com', 'A', 86400, 10.1.2.3'))
   #    update.add('bar.example.com', 'A', 86400, 10.4.5.6'))
-  #    res.tsig_key=key
+  #    res.tsig=(key_name,key)
   #
   class Update < Message
     #Returns a Dnsruby::Update object suitable for performing a DNS
@@ -139,7 +139,6 @@ module Dnsruby
       rdata = []
       klass = Classes.ANY
       if (args.length>=1) # domain (RFC2136, Section 2.4.4)
-        # @TODO@ Could also be an actual RR object?
         name = args[0]
         type = Types.ANY
         if (args.length>=2) # RRSET (RFC2136, Section 2.4.1)

data/lib/Dnsruby/zone_transfer.rb

@@ -11,6 +11,21 @@ module Dnsruby
     attr_accessor :port
     # If using IXFR, this is the SOA serial number to start the incrementals from
     attr_accessor :serial
+    # The TSIG record used to sign the transfer
+    attr_reader :tsig
+    # Returns the tsigstate of the last transfer (nil if no TSIG signed transfer has occurred)
+    attr_reader :last_tsigstate
+    
+    #Sets the TSIG to sign the zone transfer with.
+    #Pass in either a Dnsruby::RR::TSIG, or a key_name and key (or just a key)
+    #Pass in nil to stop tsig signing.
+    #* res.tsig=(tsig_rr)
+    #* res.tsig=(key_name, key)
+    #* res.tsig=nil # Don't sign the transfer
+    def tsig=(*args)
+      @tsig = SingleResolver.get_tsig(args)
+    end
+    
 
     def initialize
       @server=Config.new.nameserver[0]
@@ -18,6 +33,8 @@ module Dnsruby
       @klass=Classes.IN
       @port=53
       @serial=0
+      @tsig = nil
+      @axfr = nil
     end
     
     # Perform a zone transfer (RFC1995)
@@ -78,7 +95,6 @@ module Dnsruby
           rr = RR.create("#{zone} 0 IN SOA" + '0 0 %u 0 0 0 0' % @serial)
           msg.add_authority(rr)
         end
-        # @TODO@ TSIG?
         send_message(socket, msg)
         
         while (@state != :End)
@@ -95,7 +111,6 @@ module Dnsruby
                 @transfer_type=Types.AXFR
                 # Send an initial AXFR query
                 msg = Message.new(zone, @transfer_type, @klass)
-                # @TODO@ TSIG?
                 send_message(socket, msg)
                 next
               end
@@ -113,7 +128,6 @@ module Dnsruby
               # Send an initial AXFR query
               @state = :InitialSoa
               msg = Message.new(zone, @transfer_type, @klass)
-              # @TODO@ TSIG?
               send_message(socket, msg)
               next
             end
@@ -122,10 +136,17 @@ module Dnsruby
           response.each_answer { |rr|
             parseRR(rr)
           }
-          #        if (state == END &&
-          #            response.tsigState == Message.TSIG_INTERMEDIATE)
-          #          raise ResolvError.new("last message must be signed")
-          #        end
+          if (@state == :End &&
+                response.tsigstate == :Intermediate)
+            raise ResolvError.new("last message must be signed")
+          end
+          if (@state == :End && @tsig)
+            if (response.tsigstate != :Verified)
+              @last_tsigstate = :Failed
+              raise ResolvError.new("Zone transfer not correctly signed")
+            end
+            @last_tsigstate = :Verified
+          end
         end
         # This could return with an IXFR response, or an AXFR response.
         # If it fails completely, then try to send an AXFR query.
@@ -170,6 +191,11 @@ module Dnsruby
         @adds = []
         @deletes = []
       end
+      
+      def to_s
+        ret = "Adds : " + @adds.join(",")
+        ret +=", Deletes : " + @deletes.join(",")
+      end
     end
     
     def parseRR(rec) #:nodoc: all
@@ -213,7 +239,7 @@ module Dnsruby
         
       when :Ixfr_DelSoa
         delta = Delta.new
-        @ixfr.push(delta);
+        @ixfr.push(delta)
         delta.start = rec.serial
         delta.deletes << rec
         @state = :Ixfr_Del
@@ -221,11 +247,11 @@ module Dnsruby
       when :Ixfr_Del
         if (type == Types.SOA)
           @current_serial = rec.serial
-          @state = :Ixfr_AddSoa;
+          @state = :Ixfr_AddSoa
           parseRR(rec); # Restart...
           return;
         end
-        delta = @ixfr.get(@ixfr.length - 1);
+        delta = @ixfr[@ixfr.length - 1]
         delta.deletes << rec
         
       when :Ixfr_AddSoa
@@ -270,8 +296,11 @@ module Dnsruby
     end
     
     
-    # @TODO@ Do all this with EventMachine?
     def send_message(socket, msg) #:nodoc: all
+      if (@tsig)
+        @tsig.apply(msg)        
+        @tsig = msg.tsig
+      end
       query_packet = msg.encode
       lenmsg = [query_packet.length].pack('n')
       socket.send(lenmsg, 0)
@@ -291,7 +320,12 @@ module Dnsruby
       answersize = buf.unpack('n')[0]
       buf = tcp_read(socket, answersize)
       msg = Message.decode(buf)
-      
+      if (@tsig)
+          if !@tsig.verify_envelope(msg, buf)
+            TheLog.error("Bad signature on zone transfer - closing connection")
+            raise ResolvError.new("Bad signature on zone transfer")
+          end      
+      end
       return msg
     end  
   end