rubydns 0.4.1 → 0.5.0

data/Gemfile

@@ -0,0 +1,7 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "rexec", "~> 1.5.1"
+gem "rake"
+gem "eventmachine"
+

data/README.md

@@ -4,6 +4,7 @@ RubyDNS
 * Author: Samuel G. D. Williams (<http://www.oriontransfer.co.nz>)
 * Copyright (C) 2009, 2011 Samuel G. D. Williams.
 * Released under the MIT license.
+* [![Build Status](https://secure.travis-ci.org/ioquatix/rubydns.png)](http://travis-ci.org/ioquatix/rubydns)
 
 RubyDNS is a simple programmatic DSL (domain specific language) for configuring and running a DNS server. RubyDNS provides a daemon that runs a DNS server which can process DNS requests depending on specific policy. Rule selection is based on pattern matching, and results can be hard-coded, computed, fetched from a remote DNS server, fetched from a local cache, etc.
 

data/lib/rubydns.rb

@@ -23,12 +23,17 @@ require 'rubydns/version'
 if RUBY_VERSION < "1.9"
 	require 'rubydns/extensions/resolv-1.8'
 	require 'rubydns/extensions/string-1.8'
+elsif RUBY_VERSION < "1.9.3"
+	require 'rubydns/extensions/resolv-1.9'
+	require 'rubydns/extensions/string-1.9.2'
 else
 	require 'rubydns/extensions/resolv-1.9'
-	require 'rubydns/extensions/string-1.9'
+	require 'rubydns/extensions/string-1.9.3'
 end
 
 require 'rubydns/server'
+require 'rubydns/resolver'
+require 'rubydns/handler'
 
 require 'logger'
 

data/lib/rubydns/chunked.rb

@@ -0,0 +1,34 @@
+# Copyright (c) 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module RubyDNS
+	# Produces an array of arrays of binary data with each sub-array a maximum of chunk_size bytes.
+	def self.chunked(string, chunk_size = 255)
+		chunks = []
+		
+		offset = 0
+		while offset < string.bytesize
+			chunks << string.byteslice(offset, chunk_size)
+			offset += chunk_size
+		end
+		
+		return chunks
+	end
+end

data/lib/rubydns/extensions/string-1.8.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'stringio'
+
 class String
 	def bytesize
 		size
@@ -26,16 +28,8 @@ class String
 	def byteslice(*args)
 		self[*args]
 	end
-	
-	def chunked(chunk_size = 255)
-		chunks = []
-		
-		offset = 0
-		while offset < bytesize
-			chunks << byteslice(offset, chunk_size)
-			offset += chunk_size
-		end
-		
-		return chunks
-	end
+end
+
+module RubyDNS
+	BinaryStringIO = StringIO
 end

data/lib/rubydns/extensions/string-1.9.2.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'stringio'
+
+class String
+	def byteslice(*args)
+		self.dup.force_encoding("binary").slice(*args)
+	end
+end
+
+module RubyDNS
+	class BinaryStringIO < StringIO
+		def initialize
+			super
+		
+			set_encoding("binary")
+		end
+	end
+end

data/lib/rubydns/extensions/string-1.9.3.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'stringio'
+
+module RubyDNS
+	class BinaryStringIO < StringIO
+		def initialize
+			super
+		
+			set_encoding("BINARY")
+		end
+	end
+	
+	
+end

data/lib/rubydns/extensions/{string-1.9.rb → string.rb}

@@ -18,16 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rubydns/chunked'
+
 class String
 	def chunked(chunk_size = 255)
-		chunks = []
-		
-		offset = 0
-		while offset < bytesize
-			chunks << byteslice(offset, chunk_size)
-			offset += chunk_size
-		end
-		
-		return chunks
+		RubyDNS::chunked(self)
 	end
 end

data/lib/rubydns/handler.rb

@@ -18,14 +18,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'eventmachine'
-require 'stringio'
+require 'rubydns/message'
 
 module RubyDNS
-	
 	module UDPHandler
-		UDP_TRUNCATION_SIZE = 512
-
 		def initialize(server)
 			@server = server
 		end
@@ -35,7 +31,7 @@ module RubyDNS
 			query = nil
 
 			begin
-				query = Resolv::DNS::Message::decode(data)
+				query = RubyDNS::decode_message(data)
 
 				return server.process_query(query, &block)
 			rescue
@@ -69,8 +65,10 @@ module RubyDNS
 					@server.logger.warn "Response via UDP was larger than #{UDP_TRUNCATION_SIZE}!"
 					
 					# Reencode data with truncation flag marked as true:
-					answer.tc = 1
-					data = answer.encode.byteslice(0,UDP_TRUNCATION_SIZE)
+					truncation_error = Resolv::DNS::Message.new(answer.id)
+					truncation_error.tc = 1
+					
+					data = truncation_error.encode
 				end
 				
 				self.send_data(data)
@@ -84,14 +82,15 @@ module RubyDNS
 	module TCPHandler
 		def initialize(server)
 			@server = server
-			@buffer = nil
+			
+			@buffer = BinaryStringIO.new
+			
 			@length = nil
 			@processed = 0
 		end
 		
 		def receive_data(data)
 			# We buffer data until we've received the entire packet:
-			@buffer ||= StringIO.new
 			@buffer.write(data)
 			
 			# Message includes a 16-bit length field.. we need to see if we have received it yet:

data/lib/rubydns/message.rb

@@ -0,0 +1,38 @@
+# Copyright (c) 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'eventmachine'
+require 'stringio'
+require 'resolv'
+
+module RubyDNS
+	UDP_TRUNCATION_SIZE = 512
+	
+	# The DNS message container.
+	Message = Resolv::DNS::Message
+
+	def self.decode_message(data)
+		if data.respond_to? :force_encoding
+			data.force_encoding("BINARY")
+		end
+		
+		Message.decode(data)
+	end
+end

data/lib/rubydns/resolver.rb

@@ -0,0 +1,219 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'rubydns/message'
+
+module RubyDNS
+	class InvalidProtocolError < StandardError
+	end
+	
+	class ResolutionFailure < StandardError
+	end
+	
+	class Resolver
+		# Servers are specified in the same manor as options[:listen], e.g.
+		#   [:tcp/:udp, address, port]
+		# In the case of multiple servers, they will be checked in sequence.
+		def initialize(servers, options = {})
+			@servers = servers
+			@sequence = 0
+			
+			@options = options
+		end
+
+		# Provides the next sequence identification number which is used to keep track of DNS messages.
+		def next_id!
+			return (@sequence += 1)
+		end
+
+		# Look up a named resource of the given resource_class.
+		def query(name, resource_class = Resolv::DNS::Resource::IN::A, &block)
+			message = Resolv::DNS::Message.new(next_id!)
+			message.rd = 1
+			message.add_question name, resource_class
+			
+			Request.fetch(message, @servers, @options, &block)
+		end
+
+		# Manages a single DNS question message across one or more servers.
+		class Request
+			include EventMachine::Deferrable
+			
+			def self.fetch(*args)
+				request = self.new(*args)
+				
+				request.callback do |message|
+					yield message
+				end
+				
+				request.errback do |error|
+					yield error
+				end
+				
+				request.run!
+			end
+			
+			def initialize(message, servers, options = {}, &block)
+				@message = message
+				@packet = message.encode
+				
+				@servers = servers.dup
+				
+				# We select the protocol based on the size of the data:
+				if @packet.bytesize > UDP_TRUNCATION_SIZE
+					@servers.delete_if{|server| server[0] == :udp}
+				end
+				
+				# Measured in seconds:
+				@timeout = options[:timeout] || 5
+				
+				@logger = options[:logger]
+			end
+			
+			attr :message
+			attr :packet
+			attr :logger
+			
+			def run!
+				try_next_server!
+			end
+			
+			def process_response!(response)
+				if response.tc != 0
+					@logger.warn "[#{@message.id}] Received truncated response!" if @logger
+					# We hardcode this behaviour for now.
+					try_next_server!
+				else
+					@logger.warn "[#{@message.id}] Received valid response #{response.inspect}" if @logger
+					succeed response
+				end
+			end
+			
+			private
+			
+			def try_next_server!
+				if @request
+					@request.close_connection
+					@request = nil
+				end
+				
+				if @servers.size > 0
+					@server = @servers.shift
+					
+					@logger.debug "[#{@message.id}] Sending request to server #{@server.inspect}" if @logger
+					
+					# We make requests one at a time to the given server, naturally the servers are ordered in terms of priority.
+					case @server[0]
+					when :udp
+						@request = UDPRequestHandler.open(@server[1], @server[2], self)
+					when :tcp
+						@request = TCPRequestHandler.open(@server[1], @server[2], self)
+					else
+						raise InvalidProtocolError.new(@server)
+					end
+					
+					# Setting up the timeout...
+					EventMachine::Timer.new(@timeout) do
+						@logger.debug "[#{@message.id}] Request timed out!" if @logger
+						
+						try_next_server!
+					end
+				else
+					fail ResolutionFailure.new("No available servers responded to the request.")
+				end
+			end
+			
+			module UDPRequestHandler
+				def self.open(host, port, request)
+					# Open a datagram socket... EventMachine doesn't support connected datagram sockets, so we have to cheat a bit:
+					EventMachine::open_datagram_socket('', 0, self, request, host, port)
+				end
+				
+				def initialize(request, host, port)
+					@request = request
+					@host = host
+					@port = port
+				end
+				
+				def post_init
+					# Sending question to remote DNS server...
+					send_datagram(@request.packet, @host, @port)
+				end
+				
+				def receive_data(data)
+					# Receiving response from remote DNS server...
+					message = RubyDNS::decode_message(data)
+					
+					# The message id must match, and it can't be truncated:
+					if message.id == @request.message.id
+						@request.process_response!(message)
+					else
+						@request.logger.warn "[#{@request.message.id}] Received response with incorrect message id: #{message.id}" if @request.logger
+					end
+				end
+			end
+			
+			module TCPRequestHandler
+				def self.open(host, port, request)
+					EventMachine::connect(host, port, TCPRequestHandler, request)
+				end
+				
+				def initialize(request)
+					@request = request
+					@buffer = nil
+					@length = nil
+				end
+				
+				def post_init
+					data = @request.packet
+					
+					send_data([data.bytesize].pack('n'))
+					send_data data
+				end
+				
+				def receive_data(data)
+					# We buffer data until we've received the entire packet:
+					@buffer ||= BinaryStringIO.new
+					@buffer.write(data)
+
+					if @length == nil
+						if @buffer.size > 2
+							@length = @buffer.string.byteslice(0, 2).unpack('n')[0]
+						end
+					end
+
+					if @buffer.size == (@length + 2)
+						data = @buffer.string.byteslice(2, @length)
+						
+						message = RubyDNS::decode_message(data)
+						
+						if message.id == @request.message.id
+							@request.process_response!(message)
+						else
+							@request.logger.warn "[#{@request.message.id}] Received response with incorrect message id: #{message.id}" if @request.logger
+						end
+					elsif @buffer.size > (@length + 2)
+						@request.try_next_server!
+					end
+				end
+			end
+		end
+	end
+end