async-dns 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d06ded8c25acd3d3b198a45c291b47f70d26667
+  data.tar.gz: 708bfec661ce872d73137142ad338198f548a750
+SHA512:
+  metadata.gz: 33fe2f59bf6907af89631f9b6bf13e05e8312df6d1d197cc2b530edc2e7d9a29581988830494127aaef4d95f5cdf775511e828b55c210ab07d8a6337c1281fba
+  data.tar.gz: b61ea4a2c6a9a336690165dbaa6e2789aaaccc53fb78e65e0dabc8a8ea99221b3c7d137020fac0f0e4dbe768f832fb5ab0ae72b9e9578989b3818107beba5c5c

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+sudo: false
+addons:
+  apt:
+    packages:
+    - bind9
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - rbx-2
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: rbx-2 
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "async"
+
+group :development do
+	gem "pry"
+end
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -0,0 +1,144 @@
+# Async::DNS
+
+Async::DNS is a high-performance DNS client resolver and server which can be easily integrated into other projects or used as a stand-alone daemon. It was forked from [RubyDNS] which is now implemented in terms of this library.
+
+[RubyDNS]: https://github.com/ioquatix/rubydns
+
+[![Build Status](https://secure.travis-ci.org/socketry/async-dns.svg)](http://travis-ci.org/socketry/async-dns)
+[![Code Climate](https://codeclimate.com/github/socketry/async-dns.svg)](https://codeclimate.com/github/socketry/async-dns)
+[![Coverage Status](https://coveralls.io/repos/socketry/async-dns/badge.svg)](https://coveralls.io/r/socketry/async-dns)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+	gem 'async-dns'
+
+And then execute:
+
+	$ bundle
+
+Or install it yourself as:
+
+	$ gem install async-dns
+
+## Usage
+
+### Resolver
+
+Here is a simple example showing how to use the resolver:
+
+	Async::Reactor.run do
+		resolver = Async::DNS::Resolver.new([[:udp, "8.8.8.8", 53], [:tcp, "8.8.8.8", 53]])
+
+		addresses = resolver.addresses_for("www.google.com.")
+
+		puts addresses.inspect
+	end
+	=> [#<Resolv::IPv4 202.124.127.240>, #<Resolv::IPv4 202.124.127.216>, #<Resolv::IPv4 202.124.127.223>, #<Resolv::IPv4 202.124.127.227>, #<Resolv::IPv4 202.124.127.234>, #<Resolv::IPv4 202.124.127.230>, #<Resolv::IPv4 202.124.127.208>, #<Resolv::IPv4 202.124.127.249>, #<Resolv::IPv4 202.124.127.219>, #<Resolv::IPv4 202.124.127.218>, #<Resolv::IPv4 202.124.127.212>, #<Resolv::IPv4 202.124.127.241>, #<Resolv::IPv4 202.124.127.238>, #<Resolv::IPv4 202.124.127.245>, #<Resolv::IPv4 202.124.127.251>, #<Resolv::IPv4 202.124.127.229>]
+
+### Server
+
+Here is a simple example showing how to use the server:
+
+	require 'async/dns'
+	
+	class TestServer < Async::DNS::Server
+		def process(name, resource_class, transaction)
+			@resolver ||= Async::DNS::Resolver.new([[:udp, '8.8.8.8', 53], [:tcp, '8.8.8.8', 53]])
+			
+			transaction.passthrough!(@resolver)
+		end
+	end
+	
+	server = TestServer.new(listen: [[:udp, '127.0.0.1', 2346]])
+	
+	server.run
+
+Then to test you could use `dig` like so:
+
+	dig @localhost -p 2346 google.com
+
+## FAQ
+
+### File Handle Limitations
+
+I get the error `Errno::EMFILE: Too many open files - socket(2) - udp` when trying to run a server. What should I do?
+
+On some platforms (e.g. Mac OS X) the number of file descriptors is relatively low by default and should be increased by calling `ulimit -n 10000` before running tests or even before starting a server which expects a large number of concurrent incoming connections.
+
+### Server
+
+The performance is on the same magnitude as `bind9`. Some basic benchmarks resolving 1000 names concurrently, repeated 5 times, using `Async::DNS::Resolver` gives the following:
+
+	                              user     system      total        real
+	Async::DNS::Server         4.280000   0.450000   4.730000 (  4.854862)
+	Bind9                         4.970000   0.520000   5.490000 (  5.541213)
+
+These benchmarks are included in the unit tests. To test bind9 performance, it must be installed and `which named` must return the executable.
+
+
+## Performance
+
+We welcome additional benchmarks and feedback regarding Async::DNS performance. To check the current performance results, consult the [travis build job output](https://travis-ci.org/socketry/async-dns).
+
+### Resolver
+
+The `Async::DNS::Resolver` is highly concurrent and can resolve individual names as fast as the built in `Resolv::DNS` resolver. Because the resolver is asynchronous, when dealing with multiple names, it can work more efficiently:
+
+	                              user     system      total        real
+	Async::DNS::Resolver       0.020000   0.010000   0.030000 (  0.030507)
+	Resolv::DNS                   0.070000   0.010000   0.080000 (  1.465975)
+
+These benchmarks are included in the unit tests.
+
+### Server
+
+The performance is on the same magnitude as `bind9`. Some basic benchmarks resolving 1000 names concurrently, repeated 5 times, using `Async::DNS::Resolver` gives the following:
+
+	                              user     system      total        real
+	Async::DNS::Server         4.280000   0.450000   4.730000 (  4.854862)
+	Bind9                         4.970000   0.520000   5.490000 (  5.541213)
+
+These benchmarks are included in the unit tests. To test bind9 performance, it must be installed and `which named` must return the executable.
+
+### DNSSEC support
+
+DNSSEC is currently not supported and is [unlikely to be supported in the future](http://sockpuppet.org/blog/2015/01/15/against-dnssec/). Feel free to submit a PR.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+### Desired Features
+
+* Support for more features of DNS such as zone transfer.
+* Some kind of system level integration, e.g. registering a DNS server with the currently running system resolver.
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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.

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test
+
+task :console do
+	require 'pry'
+	
+	require_relative 'lib/async/dns'
+	
+	Pry.start
+end
+
+task :server do
+	require_relative 'lib/async/dns'
+	
+	class TestServer < Async::DNS::Server
+		def process(name, resource_class, transaction)
+			@resolver ||= Async::DNS::Resolver.new([[:udp, "8.8.8.8", 53], [:tcp, "8.8.8.8", 53]])
+			
+			transaction.passthrough!(@resolver)
+		end
+	end
+	
+	server = TestServer.new(listen: [[:udp, '127.0.0.1', 2346]])
+	
+	Async::Reactor.run do
+		server.run
+	end
+end

data/async-dns.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require_relative 'lib/async/dns/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "async-dns"
+	spec.version       = Async::DNS::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.description   = <<-EOF
+		Async::DNS provides a high-performance DNS client resolver and server
+		which can be easily integrated into other projects or used as a stand-alone
+		daemon.
+	EOF
+	spec.summary       = "An easy to use DNS client resolver and server for Ruby."
+	spec.homepage      = "https://github.com/async/async-dns"
+	spec.license       = "MIT"
+	
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+	spec.has_rdoc      = "yard"
+	
+	spec.add_dependency("async", "~> 0.10")
+	
+	spec.add_development_dependency "process-daemon", "~> 1.0.0"
+	
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rspec", "~> 3.4.0"
+	spec.add_development_dependency "rake"
+end

data/lib/async/dns.rb

@@ -0,0 +1,36 @@
+# 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 'async'
+require 'async/tcp_socket'
+require 'async/udp_socket'
+
+require_relative 'dns/version'
+
+require_relative 'dns/message'
+require_relative 'dns/server'
+require_relative 'dns/resolver'
+require_relative 'dns/handler'
+require_relative 'dns/logger'
+
+module Async
+	module DNS
+	end
+end

data/lib/async/dns/chunked.rb

@@ -0,0 +1,34 @@
+# 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.
+
+module Async::DNS
+	# 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/async/dns/extensions/resolv.rb

@@ -0,0 +1,136 @@
+# 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 'resolv'
+
+class Resolv
+	class DNS
+		class Message
+			# Merge the given message with this message. A number of heuristics are applied in order to ensure that the result makes sense. For example, If the current message is not recursive but is being merged with a message that was recursive, this bit is maintained. If either message is authoritive, then the result is also authoritive.
+			#
+			# Modifies the current message in place.
+			def merge! (other)
+				# Authoritive Answer
+				@aa = @aa && other.aa
+
+				@question += other.question
+				@answer += other.answer
+				@authority += other.authority
+				@additional += other.additional
+
+				# Recursion Available
+				@ra = @ra || other.ra
+
+				# Result Code (Error Code)
+				@rcode = other.rcode unless other.rcode == 0
+
+				# Recursion Desired
+				@rd = @rd || other.rd
+			end
+		end
+		
+		class OriginError < ArgumentError
+		end
+		
+		class Name
+			def to_s
+				"#{@labels.join('.')}#{@absolute ? '.' : ''}"
+			end
+			
+			def inspect
+				"#<#{self.class}: #{self.to_s}>"
+			end
+			
+			# Return the name, typically absolute, with the specified origin as a suffix. If the origin is nil, don't change the name, but change it to absolute (as specified).
+			def with_origin(origin, absolute = true)
+				return self.class.new(@labels, absolute) if origin == nil
+				
+				origin = Label.split(origin) if String === origin
+				
+				return self.class.new(@labels + origin, absolute)
+			end
+			
+			
+			# Return the name, typically relative, without the specified origin suffix. If the origin is nil, don't change the name, but change it to absolute (as specified).
+			def without_origin(origin, absolute = false)
+				return self.class.new(@labels, absolute) if origin == nil
+				
+				origin = Label.split(origin) if String === origin
+				
+				if @labels.last(origin.length) == origin
+					return self.class.new(@labels.first(@labels.length - origin.length), absolute)
+				else
+					raise OriginError.new("#{self} does not end with #{origin.join('.')}")
+				end
+			end
+		end
+	end
+	
+	if RUBY_VERSION == "2.3.0"
+		# Clearly, the Ruby 2.3.0 release was throughly tested.
+		class IPv6
+			def self.create(arg)
+				case arg
+				when IPv6
+					return arg
+				when String
+					address = ''.b
+					if Regex_8Hex =~ arg
+						arg.scan(/[0-9A-Fa-f]+/) {|hex| address << [hex.hex].pack('n')}
+					elsif Regex_CompressedHex =~ arg
+						prefix = $1
+						suffix = $2
+						a1 = ''.b
+						a2 = ''.b
+						prefix.scan(/[0-9A-Fa-f]+/) {|hex| a1 << [hex.hex].pack('n')}
+						suffix.scan(/[0-9A-Fa-f]+/) {|hex| a2 << [hex.hex].pack('n')}
+						omitlen = 16 - a1.length - a2.length
+						address << a1 << "\0" * omitlen << a2
+					elsif Regex_6Hex4Dec =~ arg
+						prefix, a, b, c, d = $1, $2.to_i, $3.to_i, $4.to_i, $5.to_i
+						if (0..255) === a && (0..255) === b && (0..255) === c && (0..255) === d
+							prefix.scan(/[0-9A-Fa-f]+/) {|hex| address << [hex.hex].pack('n')}
+							address << [a, b, c, d].pack('CCCC')
+						else
+							raise ArgumentError.new("not numeric IPv6 address: " + arg)
+						end
+					elsif Regex_CompressedHex4Dec =~ arg
+						prefix, suffix, a, b, c, d = $1, $2, $3.to_i, $4.to_i, $5.to_i, $6.to_i
+						if (0..255) === a && (0..255) === b && (0..255) === c && (0..255) === d
+							a1 = ''.b
+							a2 = ''.b
+							prefix.scan(/[0-9A-Fa-f]+/) {|hex| a1 << [hex.hex].pack('n')}
+							suffix.scan(/[0-9A-Fa-f]+/) {|hex| a2 << [hex.hex].pack('n')}
+							omitlen = 12 - a1.length - a2.length
+							address << a1 << "\0" * omitlen << a2 << [a, b, c, d].pack('CCCC')
+						else
+							raise ArgumentError.new("not numeric IPv6 address: " + arg)
+						end
+					else
+						raise ArgumentError.new("not numeric IPv6 address: " + arg)
+					end
+					return IPv6.new(address)
+				else
+					raise ArgumentError.new("cannot interpret as IPv6 address: #{arg.inspect}")
+				end
+			end
+		end
+	end
+end