nesser 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bffba7aa303feb0c9264e87bea0b4071dd43de0a
-  data.tar.gz: f9d20c7da26f034657c8fbb16ded9222571d1b1b
+  metadata.gz: 2647db1767dd49b7498c90b61a6db3e42ddd0baa
+  data.tar.gz: 1dca698d183e7e4415ec2cbc2dd75babbab39919
 SHA512:
-  metadata.gz: 5a92a2bd9131b145d848cfc2204dbcbc5468424e43fb60cf8a8cd08d1e5480cfae325f5ec47c0e5824c20c7fcb99285a923bfa6a747e6c2bbdfaf616bb631232
-  data.tar.gz: 42c424af1ba877d784b05f1a40cb1577067d47ff6b06b672f62bb5f7a5393ace29abbcd8a1e305d282e098fe2751862dc4a1063637884b8c7ede1717370ec79c
+  metadata.gz: 05a2335a136d62fa438592616af81e0a4d1aecf23b8a3c4cfb65e35d024d2af862e08bc62957f54f0db9de85795cdea42a06f46a133e4b2692c4c3f2207b85c1
+  data.tar.gz: cf8809e713363f6497bf0ecb7caafa9ab4643cbfbb658d926724519b9939c3d7dd6fbe552896f59fbb31b43338733d2f51b9db593fed6fca0a51bb50bce7359c

data/lib/nesser/dns_exception.rb

@@ -12,7 +12,4 @@
 module Nesser
   class DnsException < StandardError
   end
-
-  class FormatException < DnsException
-  end
 end

data/lib/nesser/examples/client.rb

@@ -0,0 +1,18 @@
+# Encoding: ASCII-8BIT
+##
+# client.rb
+# Created July 8, 2017
+# By Ron Bowes
+#
+# See: LICENSE.md
+##
+
+# If you're using a gem version, you wouldn't need this line
+$LOAD_PATH.unshift File.expand_path('../../../', __FILE__)
+
+require 'socket'
+
+require 'nesser'
+
+s = UDPSocket.new()
+puts Nesser::Nesser.query(s: s, hostname: 'google.com', type: Nesser::TYPE_ANY)

data/lib/nesser/examples/server.rb

@@ -0,0 +1,33 @@
+# Encoding: ASCII-8BIT
+##
+# server.rb
+# Created July 8, 2017
+# By Ron Bowes
+#
+# See: LICENSE.md
+##
+
+# If you're using a gem version, you wouldn't need this line
+$LOAD_PATH.unshift File.expand_path('../../../', __FILE__)
+
+require 'socket'
+require 'nesser'
+
+s = UDPSocket.new()
+
+nesser = Nesser::Nesser.new(s: s) do |transaction|
+  if transaction.request_packet.questions[0].name == 'test.com'
+    transaction.answer!([Nesser::Answer.new(
+      name: 'test.com',
+      type: Nesser::TYPE_A,
+      cls: Nesser::CLS_IN,
+      ttl: 1337,
+      rr: Nesser::A.new(address: '1.2.3.4')
+    )])
+  else
+    transaction.error!(Nesser::RCODE_NAME_ERROR)
+  end
+  puts(transaction)
+end
+
+nesser.wait()

data/lib/nesser/logger.rb

@@ -0,0 +1,52 @@
+# Encoding: ASCII-8BIT
+##
+# dns_exception.rb
+# Created June 20, 2017
+# By Ron Bowes
+#
+# See LICENSE.md
+#
+# Implements a simple exception class for dns errors.
+##
+
+module Nesser
+  class Logger
+    DEBUG   = 0
+    INFO    = 1
+    WARNING = 2
+    ERROR   = 3
+    FATAL   = 4
+
+    def initialize(min_level: INFO, stream: STDERR)
+      @min_level = min_level
+      @stream = stream
+    end
+
+    def debug(msg)
+      return if @min_level > DEBUG
+      @stream.puts('[DEBUG] ' + msg.to_s)
+    end
+
+    def info(msg)
+      return if @min_level > INFO
+      @stream.puts('[INFO] ' + msg.to_s)
+    end
+
+    def warning(msg)
+      return if @min_level > WARNING
+      @stream.puts('[WARNING] ' + msg.to_s)
+    end
+
+    def error(msg)
+      return if @min_level > ERROR
+      @stream.puts('[ERROR] ' + msg.to_s)
+    end
+
+    def fatal(msg, die: false)
+      return if @min_level > FATAL
+      @stream.puts('[FATAL] ' + msg.to_s)
+
+      exit() if die
+    end
+  end
+end

data/lib/nesser/packets/packer.rb

@@ -32,14 +32,14 @@ module Nesser
     private
     def validate!(name)
       if name.chars.detect { |ch| !LEGAL_CHARACTERS.include?(ch) }
-        raise(FormatException, "DNS name contains illegal characters")
+        raise(DnsException, "DNS name contains illegal characters")
       end
       if name.length > 253
-        raise(FormatException, "DNS name can't be longer than 253 characters")
+        raise(DnsException, "DNS name can't be longer than 253 characters")
       end
       name.split(/\./).each do |segment|
         if segment.length == 0 || segment.length > 63
-          raise(FormatException, "DNS segments must be between 1 and 63 characters!")
+          raise(DnsException, "DNS segments must be between 1 and 63 characters!")
         end
       end
     end

data/lib/nesser/packets/packet.rb

@@ -166,7 +166,7 @@ module Nesser
         QRS[@qr] || "unknown",
         @trn_id,
         OPCODES[@opcode] || "unknown opcode",
-        Nesser::FLAGS(@flags),
+        ::Nesser::FLAGS(@flags),
         RCODES[@rcode] || "unknown",
         @questions.length,
         @answers.length,

data/lib/nesser/packets/rr_types.rb

@@ -20,24 +20,24 @@ module Nesser
 
     def initialize(address:)
       if !address.is_a?(String)
-        raise(FormatException, "String required!")
+        raise(DnsException, "String required!")
       end
 
       begin
         @address = IPAddr.new(address)
       rescue IPAddr::InvalidAddressError => e
-        raise(FormatException, "Invalid address: %s" % e)
+        raise(DnsException, "Invalid address: %s" % e)
       end
 
       if !@address.ipv4?()
-        raise(FormatException, "IPv4 address required!")
+        raise(DnsException, "IPv4 address required!")
       end
     end
 
     def self.unpack(unpacker)
       length = unpacker.unpack_one('n')
       if length != 4
-        raise(FormatException, "Invalid A record!")
+        raise(DnsException, "Invalid A record!")
       end
 
       data = unpacker.unpack('a4').join()
@@ -121,7 +121,7 @@ module Nesser
     def self.unpack(unpacker)
       length = unpacker.unpack_one('n')
       if length < 22
-        raise(FormatException, "Invalid SOA record")
+        raise(DnsException, "Invalid SOA record")
       end
 
       primary = unpacker.unpack_name()
@@ -166,7 +166,7 @@ module Nesser
     def self.unpack(unpacker)
       length = unpacker.unpack_one('n')
       if length < 3
-        raise(FormatException, "Invalid MX record")
+        raise(DnsException, "Invalid MX record")
       end
 
       preference = unpacker.unpack_one('n')
@@ -198,13 +198,13 @@ module Nesser
     def self.unpack(unpacker)
       length = unpacker.unpack_one('n')
       if length < 1
-        raise(FormatException, "Invalid TXT record")
+        raise(DnsException, "Invalid TXT record")
       end
 
       len = unpacker.unpack_one("C")
 
       if len != length - 1
-        raise(FormatException, "Invalid TXT record")
+        raise(DnsException, "Invalid TXT record")
       end
 
       data = unpacker.unpack_one("a#{len}")
@@ -228,24 +228,24 @@ module Nesser
 
     def initialize(address:)
       if !address.is_a?(String)
-        raise(FormatException, "String required!")
+        raise(DnsException, "String required!")
       end
 
       begin
         @address = IPAddr.new(address)
       rescue IPAddr::InvalidAddressError => e
-        raise(FormatException, "Invalid address: %s" % e)
+        raise(DnsException, "Invalid address: %s" % e)
       end
 
       if !@address.ipv6?()
-        raise(FormatException, "IPv6 address required!")
+        raise(DnsException, "IPv6 address required!")
       end
     end
 
     def self.unpack(unpacker)
       length = unpacker.unpack_one('n')
       if length != 16
-        raise(FormatException, "Invalid AAAA record")
+        raise(DnsException, "Invalid AAAA record")
       end
 
       data = unpacker.unpack('a16').join()

data/lib/nesser/packets/unpacker.rb

@@ -32,7 +32,7 @@ module Nesser
     def _verify_results(results)
       # If there's at least one nil included in our results, bad stuff happened
       if results.index(nil)
-        raise(FormatException, "DNS packet was truncated (or we messed up parsing it)!")
+        raise(DnsException, "DNS packet was truncated (or we messed up parsing it)!")
       end
     end
 
@@ -41,7 +41,7 @@ module Nesser
     public
     def unpack(format)
       if @offset >= @data.length
-        raise(FormatException, "DNS packet was invalid!")
+        raise(DnsException, "DNS packet was invalid!")
       end
 
       results = @data[@offset..-1].unpack(format + "a*")
@@ -59,7 +59,7 @@ module Nesser
 
       _verify_results(results)
       if results.length != 1
-        raise(FormatException, "unpack_one() was passed a bad format string")
+        raise(DnsException, "unpack_one() was passed a bad format string")
       end
 
       return results.pop()
@@ -86,7 +86,7 @@ module Nesser
       segments = []
 
       if depth > MAX_RECURSION_DEPTH
-        raise(FormatException, "It looks like this packet contains recursive pointers!")
+        raise(DnsException, "It looks like this packet contains recursive pointers!")
       end
 
       loop do

data/lib/nesser/transaction.rb

@@ -36,6 +36,11 @@ module Nesser
       end
     end
 
+    public
+    def open?()
+      return !@sent
+    end
+
     public
     def answer!(answers=[])
       answers.each do |answer|
@@ -90,5 +95,22 @@ module Nesser
       @s.send(@response_packet.to_bytes(), 0, @host, @port)
       @sent = true
     end
+
+    public
+    def to_s()
+      result = []
+
+      result << '== Nesser (DNS) Transaction =='
+      result << '-- Request --'
+      result << @request_packet.to_s()
+      if !sent()
+        result << '-- Response [not sent yet] --'
+      else
+        result << '-- Response [sent] --'
+      end
+      result << @response_packet.to_s()
+
+      return result.join("\n")
+    end
   end
 end

data/lib/nesser/version.rb

@@ -1,3 +1,3 @@
 module Nesser
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/nesser.rb

@@ -18,40 +18,28 @@
 #
 # To make a query, use Nesser.query:
 #
-#   Nesser.query("google.com") do |response|
-#     ...
-#   end
-#
-# `response` will be of type Nesser::Packet.
-#
-# To listen for queries, create a new instance of Nesser, which will begin
-# listening on a port, but won't actually handle queries yet:
-#
-#   nesser = Nesser.new("0.0.0.0", 53) do |transaction|
-#     ...
-#   end
-#
-# `transaction` is of type Nesser::Transaction, and allows you to respond to the
-# request either immediately or asynchronously.
-#
-# Nesser currently supports the following record types: A, NS, CNAME, SOA, MX,
-# TXT, and AAAA.
+# ...TODO...
 ##
 
 require 'ipaddr'
 require 'socket'
 require 'timeout'
 
-require "nesser/version"
+require 'nesser/version'
+
+require 'nesser/packets/packet'
+require 'nesser/transaction'
+require 'nesser/logger'
 
 module Nesser
   class Nesser
     attr_reader :thread
 
-    def initialize(s:, logger:, host:"0.0.0.0", port:53)
+    def initialize(s:, logger: nil, host:"0.0.0.0", port:53)
       @s = s
       @s.bind(host, port)
-      @logger = logger
+
+      @logger = (logger = logger || Logger.new())
 
       @thread = Thread.new() do
         begin
@@ -65,6 +53,9 @@ module Nesser
             rescue DnsException => e
               logger.error("Failed to parse the DNS packet: %s" % e.to_s())
               next
+            rescue Exception => e
+              logger.error("Error: %s" % e.to_s())
+              logger.info(e.backtrace().join("\n"))
             end
 
             # Create a transaction object, which we can use to respond
@@ -79,8 +70,11 @@ module Nesser
               proc.call(transaction)
             rescue StandardError => e
               logger.error("Error thrown while processing the DNS packet: %s" % e.to_s())
-              logger.info(e.backtrace())
-              transaction.error!(RCODE_SERVER_FAILURE)
+              logger.info(e.backtrace().join("\n"))
+
+              if transaction.open?()
+                transaction.error!(RCODE_SERVER_FAILURE)
+              end
             end
           end
         ensure
@@ -111,38 +105,39 @@ module Nesser
       @thread.join()
     end
 
-    # Send out a query, asynchronously. This immediately returns, then, when the
-    # query is finished, the callback block is called with a Nesser::Packet that
-    # represents the response (or nil, if there was a timeout).
-    def Nesser.query(s, hostname, params = {})
-      server   = params[:server]   || "8.8.8.8"
-      port     = params[:port]     || 53
-      type     = params[:type]     || Nesser::Packet::TYPE_A
-      cls      = params[:cls]      || Nesser::Packet::CLS_IN
-      timeout  = params[:timeout]  || 3
-
-      packet = Nesser::Packet.new(rand(65535), Nesser::Packet::QR_QUERY, Nesser::Packet::OPCODE_QUERY, Nesser::Packet::FLAG_RD, Nesser::Packet::RCODE_SUCCESS)
-      packet.add_question(Nesser::Packet::Question.new(hostname, type, cls))
-
+    # Send out a query
+    def self.query(s:, hostname:, server: '8.8.8.8', port: 53, type: TYPE_A, cls: CLS_IN, timeout: 3)
       s = UDPSocket.new()
 
-      return Thread.new() do
-        begin
-          s.send(packet.serialize(), 0, server, port)
-
-          timeout(timeout) do
-            response = s.recv(65536)
-            proc.call(Nesser::Packet.unpack(response))
-          end
-        rescue Timeout::Error
-          proc.call(nil)
-        rescue Exception => e
-          @logger.error("There was an exception sending a query for #{hostname} to #{server}:#{port}: #{e}")
-        ensure
-          if(s)
-            s.close()
+      question = Question.new(
+        name: hostname,
+        type: type,
+        cls: cls,
+      )
+
+      packet = Packet.new(
+        trn_id: rand(65535),
+        qr: QR_QUERY,
+        opcode: OPCODE_QUERY,
+        flags: FLAG_RD,
+        rcode: RCODE_SUCCESS,
+        questions: [question],
+        answers: [],
+      )
+
+      begin
+        Timeout.timeout(timeout) do
+          s.send(packet.to_bytes(), 0, server, port)
+          response = s.recv(65536)
+
+          if response.nil?()
+            raise(DnsException, "Error communicating with the DNS server")
           end
+
+          return Packet.parse(response)
         end
+      rescue Timeout::Error
+        raise(DnsException, "Timeout communicating with the DNS server")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nesser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - iagox86
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,9 @@ files:
 - bin/setup
 - lib/nesser.rb
 - lib/nesser/dns_exception.rb
+- lib/nesser/examples/client.rb
+- lib/nesser/examples/server.rb
+- lib/nesser/logger.rb
 - lib/nesser/packets/answer.rb
 - lib/nesser/packets/constants.rb
 - lib/nesser/packets/packer.rb