rubydns 1.0.3 → 2.0.0.pre.rc1

data/examples/test-dns-1.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+# Copyright, 2009, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+#
+# 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 'rubygems'
+require 'rubydns'
+require 'rubydns/system'
+
+# You can specify other DNS servers easily
+# $R = Resolv::DNS.new(:nameserver => ["xx.xx.1.1", "xx.xx.2.2"])
+
+R = RubyDNS::Resolver.new(RubyDNS::System.nameservers)
+Name = Resolv::DNS::Name
+IN = Resolv::DNS::Resource::IN
+INTERFACES = [
+	[:udp, '0.0.0.0', 5300],
+	[:tcp, '0.0.0.0', 5300],
+	# [:udp, '::0', 5300],
+	# [:tcp, '::0', 5300],
+]
+
+RubyDNS.run_server(listen: INTERFACES) do
+	# % dig +nocmd +noall +answer @localhost ANY dev.mydomain.org
+	# dev.mydomain.org.	16000	IN	A	10.0.0.80
+	# dev.mydomain.org.	16000	IN	MX	10 mail.mydomain.org.
+	match(/dev.mydomain.org/, IN::ANY) do |transaction|
+		transaction.append_question!
+
+		[IN::A, IN::CNAME, IN::MX].each do |resource_class|
+			logger.debug "Appending query for #{resource_class}..."
+			transaction.append!(transaction.name, resource_class)
+		end
+	end
+
+	# For this exact address record, return an IP address
+	match('dev.mydomain.org', IN::A) do |transaction|
+		transaction.respond!('10.0.0.80')
+	end
+
+	match('80.0.0.10.in-addr.arpa', IN::PTR) do |transaction|
+		transaction.respond!(Name.create('dev.mydomain.org.'))
+	end
+
+	match('dev.mydomain.org', IN::MX) do |transaction|
+		transaction.respond!(10, Name.create('mail.mydomain.org.'))
+	end
+
+	match(/^test([0-9]+).mydomain.org$/, IN::A) do |transaction, match_data|
+		offset = match_data[1].to_i
+
+		if offset > 0 && offset < 10
+			logger.info "Responding with address #{'10.0.0.' + (90 + offset).to_s}..."
+			transaction.respond!('10.0.0.' + (90 + offset).to_s)
+		else
+			logger.info "Address out of range: #{offset}!"
+			false
+		end
+	end
+
+	# Default DNS handler
+	otherwise do |transaction|
+		logger.info 'Passing DNS request upstream...'
+		transaction.passthrough!(R)
+	 end
+end

data/examples/test-dns-2.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+# Copyright, 2009, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+#
+# 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'
+require 'process-daemon'
+
+# To run this command, use the standard daemon syntax as root
+# ./daemon2.rb start
+
+# You should be able to see that the server has dropped priviledges
+#   # ps aux | grep daemon2.rb
+#   daemon   16555   0.4  0.0    81392   2024   ??  S     3:35am   0:00.28 ruby ../test/daemon2.rb start
+
+# Test using the following command
+# dig @localhost test.mydomain.org
+# dig +tcp @localhost test.mydomain.org
+
+# You might need to change the user name "daemon". This can be a user name or a user id.
+RUN_AS = 'daemon'
+
+INTERFACES = [
+	[:udp, '0.0.0.0', 53],
+	[:tcp, '0.0.0.0', 53]
+]
+
+# We need to be root in order to bind to privileged port
+if RExec.current_user != 'root'
+	 $stderr.puts 'Sorry, this command needs to be run as root!'
+	 exit 1
+end
+
+# The Daemon itself
+class Server < Process::Daemon
+	Name = Resolv::DNS::Name
+	IN = Resolv::DNS::Resource::IN
+
+	# Use upstream DNS for name resolution.
+	UPSTREAM = RubyDNS::Resolver.new([[:udp, '8.8.8.8', 53], [:tcp, '8.8.8.8', 53]])
+
+	def startup
+		# Don't buffer output (for debug purposes)
+		$stderr.sync = true
+
+		# Start the RubyDNS server
+		RubyDNS.run_server(listen: INTERFACES) do
+			on(:start) do
+				RExec.change_user(RUN_AS)
+			end
+
+			match('test.mydomain.org', IN::A) do |transaction|
+				transaction.respond!('10.0.0.80')
+			end
+
+			# Default DNS handler
+			otherwise do |transaction|
+				logger.info "Passthrough: #{transaction}"
+				transaction.passthrough!(UPSTREAM)
+			end
+		end
+	end
+end
+
+# RExec daemon runner
+Server.daemonize

data/examples/wikipedia-dns.rb

@@ -22,7 +22,6 @@
 # THE SOFTWARE.
 
 require 'rubydns'
-require 'rubydns/extensions/string'
 
 require 'process/daemon'
 require 'process/daemon/privileges'
@@ -33,6 +32,8 @@ require 'json'
 
 require 'digest/md5'
 
+require 'http'
+
 # You might need to change the user name "daemon". This can be a user name
 # or a user id.
 RUN_AS = 'daemon'
@@ -42,19 +43,6 @@ if Process::Daemon::Privileges.current_user != 'root'
 	exit 1
 end
 
-require 'http'
-
-# Celluloid::IO fetcher to retrieve URLs.
-class HttpFetcher
-	include Celluloid::IO
-
-	def get(url)
-		# Note: For SSL support specify:
-		# 	ssl_socket_class: Celluloid::IO::SSLSocket
-		HTTP.get(url, socket_class: Celluloid::IO::TCPSocket)
-	end
-end
-
 # Encapsulates the logic for fetching information from Wikipedia.
 module Wikipedia
 	def self.summary_url(title)
@@ -81,9 +69,6 @@ class WikipediaDNS < Process::Daemon
 
 		stats = { requested: 0 }
 
-		# Use a Celluloid supervisor so the system recovers if the actor dies
-		fetcher = HttpFetcher.supervise
-
 		# Start the RubyDNS server
 		RubyDNS.run_server do
 			on(:start) do
@@ -103,7 +88,8 @@ class WikipediaDNS < Process::Daemon
 				title = match_data[1]
 				stats[:requested] += 1
 
-				response = fetcher.actors.first.get(Wikipedia.summary_url(title))
+				url = Wikipedia.summary_url(title)
+				response = HTTP.get(url) # socket_class: ... is not yet supported.
 
 				summary =
 					Wikipedia.extract_summary(response).force_encoding('ASCII-8BIT')

data/lib/rubydns.rb

@@ -18,33 +18,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'rubydns/version'
+require 'async/dns'
 
-require_relative 'rubydns/message'
-require_relative 'rubydns/server'
-require_relative 'rubydns/resolver'
-require_relative 'rubydns/handler'
-require_relative 'rubydns/logger'
+require_relative 'rubydns/version'
+require_relative 'rubydns/rule_based_server'
 
 module RubyDNS
+	# Backwards compatibility:
+	Resolver = Async::DNS::Resolver
+	
 	# Run a server with the given rules.
-	def self.run_server (options = {}, &block)
-		server_class = options[:server_class] || RuleBasedServer
-		
-		supervisor = server_class.supervise(options, &block)
+	def self.run_server (server_class: RuleBasedServer, **options, &block)
+		server = server_class.new(**options, &block)
 		
-		supervisor.actors.first.run
-		if options[:asynchronous]
-			return supervisor
-		else
-			read, write = IO.pipe
-			
-			trap(:INT) {
-				write.puts
-			}
-			
-			IO.select([read])
-			supervisor.terminate
-		end
+		server.run
 	end
 end

data/lib/rubydns/{server.rb → rule_based_server.rb}

@@ -18,166 +18,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'celluloid/io'
-
-require_relative 'transaction'
-require_relative 'logger'
+require 'async/dns/server'
 
 module RubyDNS
-	class UDPSocketWrapper < Celluloid::IO::UDPSocket
-		def initialize(socket)
-			@socket = socket
-		end
-	end
-	
-	class TCPServerWrapper < Celluloid::IO::TCPServer
-		def initialize(server)
-			@server = server
-		end
-	end
-	
-	class Server
-		include Celluloid::IO
-		
-		finalizer :shutdown
-		
-		# The default server interfaces
-		DEFAULT_INTERFACES = [[:udp, "0.0.0.0", 53], [:tcp, "0.0.0.0", 53]]
-		
-		# Instantiate a server with a block
-		#
-		#	server = Server.new do
-		#		match(/server.mydomain.com/, IN::A) do |transaction|
-		#			transaction.respond!("1.2.3.4")
-		#		end
-		#	end
-		#
-		def initialize(options = {})
-			@handlers = []
-			
-			@logger = options[:logger] || Celluloid.logger
-			@interfaces = options[:listen] || DEFAULT_INTERFACES
-			
-			@origin = options[:origin] || '.'
-		end
-
-		# Records are relative to this origin:
-		attr_accessor :origin
-
-		attr_accessor :logger
-
-		# Fire the named event as part of running the server.
-		def fire(event_name)
-		end
-		
-		def shutdown
-			fire(:stop)
-		end
-		
-		# Give a name and a record type, try to match a rule and use it for processing the given arguments.
-		def process(name, resource_class, transaction)
-			raise NotImplementedError.new
-		end
-		
-		# Process an incoming DNS message. Returns a serialized message to be sent back to the client.
-		def process_query(query, options = {}, &block)
-			start_time = Time.now
-			
-			# Setup response
-			response = Resolv::DNS::Message::new(query.id)
-			response.qr = 1                 # 0 = Query, 1 = Response
-			response.opcode = query.opcode  # Type of Query; copy from query
-			response.aa = 1                 # Is this an authoritative response: 0 = No, 1 = Yes
-			response.rd = query.rd          # Is Recursion Desired, copied from query
-			response.ra = 0                 # Does name server support recursion: 0 = No, 1 = Yes
-			response.rcode = 0              # Response code: 0 = No errors
-			
-			transaction = nil
-			
-			begin
-				query.question.each do |question, resource_class|
-					begin
-						question = question.without_origin(@origin)
-						
-						@logger.debug {"<#{query.id}> Processing question #{question} #{resource_class}..."}
-						
-						transaction = Transaction.new(self, query, question, resource_class, response, options)
-						
-						transaction.process
-					rescue Resolv::DNS::OriginError
-						# This is triggered if the question is not part of the specified @origin:
-						@logger.debug {"<#{query.id}> Skipping question #{question} #{resource_class} because #{$!}"}
-					end
-				end
-			rescue Celluloid::ResumableError
-				raise
-			rescue StandardError => error
-				@logger.error "<#{query.id}> Exception thrown while processing #{transaction}!"
-				RubyDNS.log_exception(@logger, error)
-			
-				response.rcode = Resolv::DNS::RCode::ServFail
-			end
-			
-			end_time = Time.now
-			@logger.debug {"<#{query.id}> Time to process request: #{end_time - start_time}s"}
-			
-			return response
-		end
-		
-		#
-		# By default the server runs on port 53, both TCP and UDP, which is usually a priviledged port and requires root access to bind. You can change this by specifying `options[:listen]` which should contain an array of `[protocol, interface address, port]` specifications.
-		# 
-		#	INTERFACES = [[:udp, "0.0.0.0", 5300]]
-		#	RubyDNS::run_server(:listen => INTERFACES) do
-		#		...
-		#	end
-		#
-		# You can specify already connected sockets if need be:
-		#
-		#   socket = UDPSocket.new; socket.bind("0.0.0.0", 53)
-		#   Process::Sys.setuid(server_uid)
-		#   INTERFACES = [socket]
-		#
-		def run
-			@logger.info "Starting RubyDNS server (v#{RubyDNS::VERSION})..."
-			
-			fire(:setup)
-			
-			# Setup server sockets
-			@interfaces.each do |spec|
-				if spec.is_a?(BasicSocket)
-					spec.do_not_reverse_lookup
-					protocol = spec.getsockopt(Socket::SOL_SOCKET, Socket::SO_TYPE).unpack("i")[0]
-					ip = spec.local_address.ip_address
-					port = spec.local_address.ip_port
-					
-					case protocol
-					when Socket::SOCK_DGRAM
-						@logger.info "<> Attaching to pre-existing UDP socket #{ip}:#{port}"
-						link UDPSocketHandler.new(self, UDPSocketWrapper.new(spec))
-					when Socket::SOCK_STREAM
-						@logger.info "<> Attaching to pre-existing TCP socket #{ip}:#{port}"
-						link TCPSocketHandler.new(self, TCPServerWrapper.new(spec))
-					else
-						raise ArgumentError.new("Unknown socket protocol: #{protocol}")
-					end
-				elsif spec[0] == :udp
-					@logger.info "<> Listening on #{spec.join(':')}"
-					link UDPHandler.new(self, spec[1], spec[2])
-				elsif spec[0] == :tcp
-					@logger.info "<> Listening on #{spec.join(':')}"
-					link TCPHandler.new(self, spec[1], spec[2])
-				else
-					raise ArgumentError.new("Invalid connection specification: #{spec.inspect}")
-				end
-			end
-			
-			fire(:start)
-		end
-	end
-	
 	# Provides the core of the RubyDNS domain-specific language (DSL). It contains a list of rules which are used to match against incoming DNS questions. These rules are used to generate responses which are either DNS resource records or failures.
-	class RuleBasedServer < Server
+	class RuleBasedServer < Async::DNS::Server
 		# Represents a single rule in the server.
 		class Rule
 			def initialize(pattern, callback)
@@ -247,9 +92,6 @@ module RubyDNS
 			end
 		end
 		
-		# Don't wrap the block going into initialize.
-		execute_block_on_receiver :initialize
-		
 		# Instantiate a server with a block
 		#
 		#	server = Server.new do

data/lib/rubydns/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module RubyDNS
-	VERSION = '1.0.3'
+	VERSION = '2.0.0-rc1'
 end