celluloid-dns 0.0.1 → 0.17.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29e1cad84a40b70653b74e2e83c6b5689bae12c1
+  data.tar.gz: 81a1d5628a6a87f5287ac28d0da32f58fe536cb2
+SHA512:
+  metadata.gz: bb292adfcede83a136d78469e948ecc22dd89c247d5ceed0ecdcd9a05124aa48d15066f787152ce5abcc4b9e2b29aa693b560698005894710397db43abd348ab
+  data.tar.gz: ecd62d8c8265e14a7bca932f48c7ce759c5711a071e5b971973d1212aa98b399abc619be511cb4283f8375105a12ebf9eb483fa704f3b7dfa656d41eeb7e9066

data/.rspec

@@ -1,4 +1,2 @@
 --color 
 --format documentation 
---backtrace
---default_path spec

data/.simplecov

@@ -0,0 +1,15 @@
+
+SimpleCov.start do
+	add_filter "/spec/"
+end
+
+# Work correctly across forks:
+pid = Process.pid
+SimpleCov.at_exit do
+	SimpleCov.result.format! if Process.pid == pid
+end
+
+if ENV['TRAVIS']
+	require 'coveralls'
+	Coveralls.wear!
+end

data/.travis.yml

@@ -1,16 +1,22 @@
+language: ruby
+sudo: false
+addons:
+  apt:
+    packages:
+    - bind9
 rvm:
-  - 1.9.3
   - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - rbx-2
   - ruby-head
-  - jruby-19mode
   - jruby-head
-  - rbx-19mode 
-
 matrix:
   allow_failures:
+    - rvm: rbx-2 
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-19mode # deadlocks :(
-
+env: COVERAGE=true
 notifications:
-  irc: "irc.freenode.org#celluloid"
+  irc: "irc.freenode.org#celluloid"

data/Gemfile

@@ -1,9 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'celluloid',    github: 'celluloid/celluloid'
-gem 'celluloid-io', github: 'celluloid/celluloid-io'
-
-gem 'coveralls', require: false
-
-# Specify your gem's dependencies in celluloid-dns.gemspec
 gemspec
+
+group :test do
+	gem 'simplecov'
+	gem 'coveralls', require: false
+end

data/README.md

@@ -1,69 +1,146 @@
 ![Celluloid::DNS](https://github.com/celluloid/celluloid-dns/raw/master/logo.png)
-=================
-[![Build Status](https://secure.travis-ci.org/celluloid/celluloid-dns.png?branch=master)](http://travis-ci.org/celluloid/celluloid-dns)
-[![Dependency Status](https://gemnasium.com/celluloid/celluloid-dns.png)](https://gemnasium.com/celluloid/celluloid-dns)
-[![Code Climate](https://codeclimate.com/github/celluloid/celluloid-dns.png)](https://codeclimate.com/github/celluloid/celluloid-dns)
-[![Coverage Status](https://coveralls.io/repos/celluloid/celluloid-dns/badge.png?branch=master)](https://coveralls.io/r/celluloid/celluloid-dns)
 
-Celluloid::DNS is a programmable Celluloid "cell" for answering DNS requests.
-It's implemented using Celluloid::IO and is great for programatic DNS servers
-which dynamically generate DNS responses, particularly within Celluloid-based
-programs.
+Celluloid::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][1] which is now implemented in terms of this library.
 
-A nonblocking DNS client is already built into Celluloid::IO itself.
-Celluloid::DNS is just for servers.
+[1]: https://github.com/ioquatix/rubydns
 
-Installation
-------------
+[![Gem Version](https://badge.fury.io/rb/celluloid-dns.svg)](http://rubygems.org/gems/celluloid-dns)
+[![Build Status](https://secure.travis-ci.org/celluloid/celluloid-dns.svg?branch=master)](http://travis-ci.org/celluloid/celluloid-dns)
+[![Dependency Status](https://gemnasium.com/celluloid/celluloid-dns.svg)](https://gemnasium.com/celluloid/celluloid-dns)
+[![Code Climate](https://codeclimate.com/github/celluloid/celluloid-dns.svg)](https://codeclimate.com/github/celluloid/celluloid-dns)
+[![Coverage Status](https://coveralls.io/repos/celluloid/celluloid-dns/badge.svg?branch=master)](https://coveralls.io/r/celluloid/celluloid-dns)
+
+## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'celluloid-dns'
+	gem 'celluloid-dns'
 
 And then execute:
 
-    $ bundle
+	$ bundle
 
 Or install it yourself as:
 
-    $ gem install celluloid-dns
+	$ gem install celluloid-dns
+
+## Usage
+
+### Resolver
+
+Here is a simple example showing how to use the resolver:
+
+	resolver = Celluloid::DNS::Resolver.new([[:udp, "8.8.8.8", 53], [:tcp, "8.8.8.8", 53]])
+
+	addresses = resolver.addresses_for("www.google.com.")
+
+	expect(addresses.size).to be > 0
+
+	addresses.each do |address|
+		expect(address).to be_kind_of(Resolv::IPv4) | be_kind_of(Resolv::IPv6)
+	end
+
+### Server
+
+Here is a simple example showing how to use the server:
+
+	class TestServer < Celluloid::DNS::Server
+		def process(name, resource_class, transaction)
+			@resolver ||= Celluloid::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, 'localhost', 2346]])
+	server.run
+	
+	sleep
+
+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 `Celluloid::DNS::Resolver` gives the following:
+
+	                              user     system      total        real
+	Celluloid::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 Celluloid::DNS performance. To check the current performance results, consult the [travis build job output](https://travis-ci.org/celluloid/celluloid-dns).
+
+### Resolver
+
+The `Celluloid::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
+	Celluloid::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
 
-Inside of your Ruby project, use:
+The performance is on the same magnitude as `bind9`. Some basic benchmarks resolving 1000 names concurrently, repeated 5 times, using `Celluloid::DNS::Resolver` gives the following:
 
-    require 'celluloid/dns'
+	                              user     system      total        real
+	Celluloid::DNS::Server        4.280000   0.450000   4.730000 (  4.854862)
+	Bind9                         4.970000   0.520000   5.490000 (  5.541213)
 
-...to pull Celluloid::DNS in as a dependency.
+These benchmarks are included in the unit tests. To test bind9 performance, it must be installed and `which named` must return the executable.
 
-Usage
------
+### DNSSEC support
 
-Start a DNS server that always resolves to `127.0.0.1`:
+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.
 
-```ruby
-require "celluloid/dns"
+## Contributing
 
-Celluloid::DNS::Server.new("127.0.0.1", 1234) do |request|
-  request.answer request.questions.map { |q| [q, "127.0.0.1"] }
-end
+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
 
-sleep
-```
+### Desired Features
 
-Query the server:
+* 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.
 
-    $ dig @localhost -p 1234 anything.com
+## License
 
+Released under the MIT license.
 
-Contributing to Celluloid::DNS
-------------------------------
+Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
 
-* Fork this repository on github
-* Make your changes and send me a pull request
-* If I like them I'll merge them
-* If I've accepted a patch, feel free to ask for commit access
+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:
 
-License
--------
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
-Copyright (c) 2012 Tony Arcieri. Distributed under the MIT License. See
-LICENSE.txt for further details.
+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

@@ -1,5 +1,10 @@
-#!/usr/bin/env rake
 require "bundler/gem_tasks"
-Dir["tasks/**/*.task"].each { |task| load task }
+require "rspec/core/rake_task"
 
-task :default => :spec
+RSpec::Core::RakeTask.new(:spec) do |task|
+	task.rspec_opts = ["--require", "simplecov"] if ENV['COVERAGE']
+end
+
+task :default => :spec
+
+require 'celluloid/current'

data/celluloid-dns.gemspec

@@ -1,23 +1,34 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/celluloid/dns/version', __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Tony Arcieri"]
-  gem.email         = ["tony.arcieri@gmail.com"]
-  gem.description   = "Celluloid::IO-powered DNS server"
-  gem.summary       = "Celluloid::DNS provides a DNS server implemented as a Celluloid cell"
-  gem.homepage      = "https://github.com/celluloid/celluloid-dns"
+Gem::Specification.new do |spec|
+	spec.name          = "celluloid-dns"
+	spec.version       = Celluloid::DNS::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.description   = <<-EOF
+		Celluloid::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/celluloid/celluloid-dns"
+	spec.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "celluloid-dns"
-  gem.require_paths = ["lib"]
-  gem.version       = Celluloid::DNS::VERSION
-  
-  gem.add_runtime_dependency 'celluloid',    '>= 0.11.0'
-  gem.add_runtime_dependency 'celluloid-io', '>= 0.11.0'
-  
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'rspec'
+	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.required_ruby_version = '>= 2.0.0'
+
+	spec.add_dependency("celluloid", "~> 0.17.3")
+	spec.add_dependency("celluloid-io", "~> 0.17.3")
+	spec.add_dependency("timers", "~> 4.1.0")
+	
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "process-daemon", "~> 1.0.0"
+	spec.add_development_dependency "rspec", "~> 3.4.0"
+	spec.add_development_dependency "rake"
 end

data/lib/celluloid/dns.rb

@@ -1,12 +1,35 @@
-require 'celluloid/dns/version'
+# 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 'celluloid/current'
 require 'celluloid/io'
 
-require 'celluloid/dns/request'
-require 'celluloid/dns/server'
+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 Celluloid
-  module DNS
-    # Default time-to-live for DNS responses
-    DEFAULT_TTL = 900
-  end
+	module DNS
+	end
 end

data/lib/celluloid/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 Celluloid::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/celluloid/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