unbound 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44bef7bb342a48227c09e4c002a815bd4b7a4b47
+  data.tar.gz: a78682e4f9191e66a78e9a9c30da43602ec618ae
+SHA512:
+  metadata.gz: 2ac8d61b74fa8fc29e1f2d414d54782e70ad33acfdff9bc55e09b6d89b34f6557c21c5b2db2044b8873988d232707f3b8412accf2fe04c85cdb42231d4c8ba9b
+  data.tar.gz: 8a9af9603f3f472dad7d2fe38902fa5316f6288ca6e6c92acc2c8076db8449ee8e9b09c81279681061863ffe9f568f0318ae8c2db25cce204ab6f019c3e4e46e

data/Gemfile

@@ -0,0 +1,14 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem "ffi"
+
+group :development do
+  gem "jeweler"
+  gem "rake"
+end
+
+group :test do
+  gem "rspec"
+  gem "simplecov"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Michael Ryan
+
+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/README.md

@@ -0,0 +1,77 @@
+## Synopsis
+
+Ruby FFI bindings for [Unbound](http://www.unbound.net/), a validating, recursive, and caching DNS resolver. Specifically, we are binding to the [libunbound](http://www.unbound.net/documentation/libunbound.html) API, allowing a for a full Unbound DNS resolver to be embedded within a Ruby application. 
+
+These bindings allow for asynchronous and synchronous name resolution. You really should familiarize yourself with [libunbound](http://www.unbound.net/documentation/libunbound.html) in order to leverage this library. The current bindings will support versions of versions of libunbound distributed with Unbound 1.4.2 or newer. 
+
+## Code Example
+
+```
+require 'unbound/context'
+require 'unbound/result'
+
+ctx = Unbound::Context.new
+
+CB = Proc.new do |mydata, err, result_ptr|
+  if (err == 0) 
+    result = Unbound::Result.new(result_ptr)
+    puts "Got response rcode: #{result[:rcode]}, qname: #{result[:qname]}"
+  end
+end
+
+fd = ctx.fd
+io = IO.for_fd(fd)
+
+google_id = ctx.resolve_async("www.google.com", 1, 1, CB)
+yahoo_id = ctx.resolve_async("www.yahoo.com", 1, 1, CB)
+github_id = ctx.resolve_async("www.github.com", 1, 1, CB)
+
+# Keep looping until we haven't gotten any
+while (::IO.select([io], nil, nil, 5)) 
+  ctx.process()
+end
+
+ctx.close()
+puts "all done!"
+```
+
+outputs:
+```
+Got response rcode: 0, qname: www.google.com
+Got response rcode: 0, qname: www.github.com
+Got response rcode: 0, qname: www.yahoo.com
+all done!
+```
+
+
+## Motivation
+
+I needed to resolve millions of DNS queries, and didn't want to spend more than 5 seconds waiting for answers to each question. I had found myself subject to timeouts imposed by my recursive resolver, specifically that these were longer than the 5 seconds.My resolver was only capable of handling so many queries concurrently, so it was very easy to knock it over. I needed a way to cancel queries, freeing resources on my resolver, something that is not possible through the typical UDP DNS interface. 
+
+By creating bindings for libunbound, I gained access to the ability to cancel DNS queries (specifically ub_cancel), allowing my name resolution process to move forward at a fair clip.
+
+## Installation
+
+You'll need libunbound for Unbound 1.4.2 or greater. This can typically be achieved by installing the 'unbound' DNS package for your distribution. 
+
+To install this gem:
+```
+gem install unbound
+```
+
+## API Reference
+
+
+## Tests
+
+```
+rake spec
+```
+
+## Contributors
+
+* [Mike Ryan](https://github.com/justfalter)
+
+## License
+
+See LICENSE.txt

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "unbound"
+  gem.homepage = "http://github.com/justfalter/unbound-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Unbound DNS resolver bindings for Ruby}
+  gem.description = %Q{Unbound DNS resolver bindings for Ruby}
+  gem.email = "falter@gmail.com"
+  gem.authors = ["Mike Ryan"]
+  gem.files  = Dir.glob("lib/**/*.rb") + 
+              Dir.glob("spec/{*.rb}") + 
+              Dir.glob("spec/conf/{*.conf}") + 
+              %w(LICENSE.txt Gemfile README.md Rakefile VERSION)
+
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/unbound/bindings.rb

@@ -0,0 +1,66 @@
+require 'ffi'
+module Unbound
+  module Bindings
+    extend FFI::Library
+
+    LIBNAMES = ['unbound', 'libunbound.so', 'libunbound.so.2']
+    if ENV['LIBUNBOUND']
+      LIBNAMES.unshift(ENV['LIBUNBOUND'])
+    end
+
+    ffi_lib LIBNAMES
+
+
+    typedef :pointer, :mydata
+    typedef :pointer, :ub_ctx_ptr
+    typedef :pointer, :ub_result_ptr
+    typedef :pointer, :ub_result_ptrptr
+
+    callback :ub_callback_t, [:mydata, :int, :ub_result_ptr], :void
+
+
+    attach_function :ub_ctx_create, [], :ub_ctx_ptr
+    attach_function :ub_ctx_delete, [:ub_ctx_ptr], :void
+
+    attach_function :ub_ctx_set_option, [:ub_ctx_ptr, :string, :string], :int
+    attach_function :ub_ctx_get_option, [:ub_ctx_ptr, :string, :pointer], :int
+    attach_function :ub_ctx_config, [:ub_ctx_ptr, :string], :int
+
+    attach_function :ub_ctx_set_fwd, [:ub_ctx_ptr, :string], :int
+    attach_function :ub_ctx_resolvconf, [:ub_ctx_ptr, :string], :int
+    attach_function :ub_ctx_hosts, [:ub_ctx_ptr, :string], :int
+
+    attach_function :ub_ctx_add_ta, [:ub_ctx_ptr, :string], :int
+    attach_function :ub_ctx_add_ta_file, [:ub_ctx_ptr, :string], :int
+
+    attach_function :ub_ctx_trustedkeys, [:ub_ctx_ptr, :string], :int
+
+    attach_function :ub_ctx_debugout, [:ub_ctx_ptr, :pointer], :int # TODO: FILE pointer
+    attach_function :ub_ctx_debuglevel, [:ub_ctx_ptr, :int], :int
+
+    attach_function :ub_ctx_async, [:ub_ctx_ptr, :int], :int
+
+    attach_function :ub_poll, [:ub_ctx_ptr], :int
+    attach_function :ub_wait, [:ub_ctx_ptr], :int, :blocking => true
+    attach_function :ub_fd, [:ub_ctx_ptr], :int
+    attach_function :ub_process, [:ub_ctx_ptr], :int, :blocking => true
+
+    attach_function :ub_resolve,       [:ub_ctx_ptr, :string, :int, :int, :ub_result_ptrptr], :int, :blocking => true
+    attach_function :ub_resolve_async, [:ub_ctx_ptr, :string, :int, :int, :mydata, :ub_callback_t, :pointer], :int
+    attach_function :ub_cancel, [:ub_ctx_ptr, :int], :int
+
+    attach_function :ub_resolve_free, [:ub_result_ptr], :void
+    attach_function :ub_strerror, [:int], :string
+
+    attach_function :ub_ctx_print_local_zones, [:ub_ctx_ptr], :int
+
+    attach_function :ub_ctx_zone_add, [:ub_ctx_ptr, :string, :string], :int
+    attach_function :ub_ctx_zone_remove, [:ub_ctx_ptr, :string], :int
+
+    attach_function :ub_ctx_data_add, [:ub_ctx_ptr, :string], :int
+    attach_function :ub_ctx_data_remove, [:ub_ctx_ptr, :string], :int
+
+    ## This wasn't added until unbound 1.4.15
+    # attach_function :ub_version, [], :string
+  end
+end

data/lib/unbound/context.rb

@@ -0,0 +1,77 @@
+require 'unbound/bindings'
+require 'unbound/exceptions'
+
+module Unbound
+  class Context
+    def initialize
+      @ub_ctx = Unbound::Bindings.ub_ctx_create()
+    end
+
+    def check_closed!
+      if @ub_ctx.nil?
+        raise ContextClosedError.new
+      end
+    end
+
+    def raise_if_error!(retval)
+      if retval != 0
+        raise APIError.new(retval)
+      end
+      return retval
+    end
+
+    def closed?
+      @ub_ctx.nil?
+    end
+
+    def load_config(filename)
+      check_closed!
+      raise_if_error!(Unbound::Bindings.ub_ctx_config(@ub_ctx, filename))
+    end
+
+    def get_option(varname)
+      check_closed!
+      ret_ptr = FFI::MemoryPointer.new(:pointer)
+      raise_if_error!(Unbound::Bindings.ub_ctx_get_option(@ub_ctx, varname, ret_ptr))
+      ret_ptr.read_pointer().read_string()
+    end
+
+    def set_option(varname, val)
+      check_closed!
+      unless varname.end_with?(':')
+        varname = varname + ":"
+      end
+      raise_if_error!(Unbound::Bindings.ub_ctx_set_option(@ub_ctx, varname, val))
+    end
+
+    def close
+      check_closed!
+      Unbound::Bindings.ub_ctx_delete(@ub_ctx)
+      @ub_ctx = nil
+    end
+
+    def process
+      check_closed!
+      raise_if_error!(Unbound::Bindings.ub_process(@ub_ctx))
+    end
+
+    def cancel_async_query(async_id)
+      check_closed!
+      raise_if_error!(Unbound::Bindings.ub_cancel(@ub_ctx, async_id))
+    end
+
+    def fd
+      check_closed!
+      Unbound::Bindings.ub_fd(@ub_ctx)
+    end
+
+    def resolve_async(name, rrtype, rrclass, callback, private_data = nil)
+      check_closed!
+      async_id_ptr = FFI::MemoryPointer.new :int
+      raise_if_error!(
+        Unbound::Bindings.ub_resolve_async(
+          @ub_ctx, name, rrtype, rrclass, private_data, callback, async_id_ptr))
+      return async_id_ptr.get_int(0)
+    end
+  end
+end

data/lib/unbound/exceptions.rb

@@ -0,0 +1,26 @@
+require 'unbound/bindings'
+
+module Unbound
+  class Error < StandardError
+  end
+
+  # An APIError is the result of a failure in an unbound api call. It expects
+  # an error code and translates that into a human-readable string.
+  class APIError < Error
+    attr_reader :error_code
+    def initialize(error_code)
+      @error_code = error_code
+      msg = Unbound::Bindings.ub_strerror(@error_code)
+      super(msg)
+    end
+  end
+
+  # Indicates that an API call was attempted, but no context was provided.
+  class MissingContextError < Error
+  end
+
+  # Indicates that the context was closed (for Unbound::Context)
+  class ContextClosedError < MissingContextError
+  end
+
+end

data/lib/unbound/resolver.rb

@@ -0,0 +1,36 @@
+require 'unbound/bindings'
+require 'unbound/result'
+require 'unbound/context'
+
+module Unbound
+  class Resolver
+    def initialize()
+      @ctx = Unbound::Context.new
+      @ctx.load_config("unbound/etc/unbound.conf")
+
+      cb = Proc.new { |a,b,c| nil }
+      self.query("localhost", 1, 1, cb) 
+      @ctx.wait()
+    end
+
+    def close
+      @ctx.close
+    end
+
+    def fd
+      @ctx.fd
+    end
+
+    def process
+      @ctx.process
+    end
+
+    def cancel(async_id)
+      @ctx.cancel_async_query(async_id)
+    end
+
+    def query(name, rrtype, rrclass, callback, private_data = nil)
+      @ctx.resolve_async(name, rrtype, rrclass, callback, private_data)
+    end
+  end
+end

data/lib/unbound/result.rb

@@ -0,0 +1,66 @@
+require 'ffi'
+require 'resolv'
+module Unbound
+  module ResultLayout
+    # TODO Figure out how to determine version of libunbound and, 
+    #  thus, proper structure of ub_result
+    def self.included(base)
+      base.class_eval do
+        layout( 
+               :qname, :string, # char* qname
+               :qtype, :int,    # int qtype
+               :qclass, :int,   # int qclass
+
+               :data, :pointer, # char** data
+               :len,  :pointer, # int* len
+
+               :canonname, :string, # char* canonname
+
+               :rcode, :int, # int rcode
+
+               :answer_packet, :pointer, # void* answer_packet
+               :answer_len, :int,        # int answer_len
+
+               :havedata, :int,  # int havedata
+
+               :secure, :int,     # int secure
+
+               :bogus,  :int,       # int bogus
+               :why_bogus, :string, # char* why_bogus
+
+               # This wasn't added until unbound version 1.4.20
+               #:ttl, :int       # int ttl 
+              )
+
+      end
+    end
+
+    def answer_packet
+      if self[:answer_len] <= 0
+        return nil
+      end
+      self[:answer_packet].read_bytes(self[:answer_len])
+    end
+
+    def to_resolv
+      if ap = answer_packet()
+        return Resolv::DNS::Message.decode(ap)
+      end
+      return nil
+    end
+  end
+
+  class Result < FFI::ManagedStruct
+    include ResultLayout
+
+    def self.release(ptr)
+      Unbound.ub_resolve_free(ptr)
+    end
+  end
+
+  class ResultCast < FFI::Struct
+    include ResultLayout
+  end
+end
+
+

data/lib/unbound.rb

@@ -0,0 +1,3 @@
+module Unbound
+  require 'unbound/bindings'
+end

data/spec/conf/local_zone.conf

@@ -0,0 +1,5 @@
+
+server:
+  local-zone: 'local.' static
+  local-data: 'mycomputer.local IN A 192.0.2.51'
+  local-data: 'mytext.local TXT "data for a TXT record"'

data/spec/conf/test_config.conf

@@ -0,0 +1,3 @@
+server:
+  do-ip6: yes
+  version: "test config loaded!"

data/spec/context_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+require 'unbound/context'
+require 'unbound/exceptions'
+require 'unbound/result'
+require 'pp'
+
+describe Unbound::Context do
+  before :each do
+    @ctx = Unbound::Context.new
+  end
+
+  after :each do
+    @ctx.close unless @ctx.closed?
+  end
+
+  describe "#closed?" do
+    it "should indicate whether the context is closed or not" do
+      expect(@ctx.closed?).to be_false
+      @ctx.close
+      expect(@ctx.closed?).to be_true
+    end
+  end
+
+  describe "#close" do
+    it "should delete the underlying context" do
+      Unbound::Bindings.should_receive(:ub_ctx_delete)
+      @ctx.close
+    end
+
+    it "should raise an Unbound::ContextClosedError if we try to close it more than once" do
+      @ctx.close
+      expect(lambda do
+        @ctx.close
+      end).to raise_error(Unbound::ContextClosedError)
+    end
+
+    it "should raise an Unbound::ContextClosedError if we make an API call after the context is closed." do
+      @ctx.close
+      expect(lambda do
+        @ctx.fd
+      end).to raise_error(Unbound::ContextClosedError)
+    end
+  end
+
+  it "should let me set and retrieve unbound configuration options" do
+    @ctx.set_option("do-ip6", "no")
+    expect(@ctx.get_option("do-ip6")).to eq("no")
+    @ctx.set_option("do-ip6", "yes")
+    expect(@ctx.get_option("do-ip6")).to eq("yes")
+  end
+
+  describe "#load_config" do
+    it "should load a proper unbound configuration file" do
+      @ctx.set_option("do-ip6", "no")
+      expect(@ctx.get_option("do-ip6")).to eq("no")
+      @ctx.load_config(UnboundHelper.config_file("test_config.conf"))
+      expect(@ctx.get_option("do-ip6")).to eq("yes")
+      expect(@ctx.get_option("version")).to eq("test config loaded!")
+    end
+
+    it "should raise an Unbound::APIError if the configuration file was not found" do
+      expect(lambda do
+        @ctx.load_config(UnboundHelper.config_file("this_config_doesnt_exist.conf"))
+      end).to raise_error(Unbound::APIError)
+    end
+  end
+
+  shared_examples_for "an asynchronous name resolution method" do
+    # expects:
+    #   @processing_proc = A Proc
+    #   @ctx 
+    before :each do
+      @ctx.load_config(UnboundHelper.config_file("local_zone.conf"))
+      expect(1).to be(1)
+
+      @cb_result_ptr = nil
+      @cb_result = nil
+      @cb_err = nil
+      @cb_mydata = nil
+
+      @cb = Proc.new do |mydata, err, result_ptr|
+        @cb_mydata = mydata
+        @cb_err = err
+        @cb_result_ptr = result_ptr
+        if (@cb_err == 0) 
+          @cb_result = Unbound::Result.new(@cb_result_ptr)
+        end
+      end
+    end
+
+    describe "resolving mycomputer.local IN A" do
+      before :each do
+        @async_id = @ctx.resolve_async("mycomputer.local", 1, 1, @cb)
+        @processing_proc.call()
+      end
+
+      it "should have an error in the callback" do
+        expect(@cb_err).to be(0)
+      end
+
+      it "should have a result_ptr" do
+        expect(@cb_result_ptr).not_to be_nil
+      end
+
+      describe "result.to_resolv" do
+        subject {Unbound::Result.new(@cb_result_ptr).to_resolv}
+        its(:rcode) {should eq(0)}
+
+        it "should have the proper answer" do
+          expect(subject.answer.length).to be(1)
+          answer = subject.answer[0]
+          expect(answer[0].to_s).to eq("mycomputer.local")
+          expect(answer[2].address.to_s).to eq("192.0.2.51")
+        end
+      end
+    end
+    describe "#cancel_async_query" do
+      before :each do
+        @async_id = @ctx.resolve_async("mycomputer.local", 1, 1, @cb)
+      end
+
+      it "should cancel a query" do
+        expect(@ctx.cancel_async_query(@async_id)).to be(0)
+      end
+      
+      it "should raise an APIError when canceling a non-existent query" do
+        expect(lambda do 
+          @ctx.cancel_async_query(@async_id + 1)
+        end).to raise_error(Unbound::APIError)
+      end
+    end
+  end
+
+
+  describe "asynchronous query processing via select/process" do
+    before :each do
+      @processing_proc = lambda do
+        fd = @ctx.fd
+        io = IO.for_fd(fd)
+        ret = ::IO.select([io], nil, nil, 5)
+        expect(ret).not_to be_nil
+        @ctx.process
+      end
+    end
+    it_should_behave_like "an asynchronous name resolution method"
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup :default, :test
+
+module UnboundHelper
+  require 'pathname'
+  SPEC_ROOT = Pathname.new(__FILE__).dirname.expand_path
+  PROJECT_ROOT =  (SPEC_ROOT + '../').expand_path
+  CONF_ROOT = SPEC_ROOT + 'conf'
+  def self.config_file(name)
+    (CONF_ROOT + name).to_s
+  end
+end
+
+require 'simplecov'
+SimpleCov.start
+
+
+SimpleCov.start do
+  project_root = RSpec::Core::RubyProject.root
+  add_filter UnboundHelper::PROJECT_ROOT.join('spec').to_s
+  add_filter UnboundHelper::PROJECT_ROOT.join('.gem').to_s
+end 
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: unbound
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Unbound DNS resolver bindings for Ruby
+email: falter@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/unbound.rb
+- lib/unbound/bindings.rb
+- lib/unbound/context.rb
+- lib/unbound/exceptions.rb
+- lib/unbound/resolver.rb
+- lib/unbound/result.rb
+- spec/conf/local_zone.conf
+- spec/conf/test_config.conf
+- spec/context_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/justfalter/unbound-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Unbound DNS resolver bindings for Ruby
+test_files: []