dnsruby 1.55 → 1.56.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bf240da7425f65b0de26f548c79285a79f4e50b
-  data.tar.gz: 4c14a8ede6896cbd22365ed0f8fddef5598ef49e
+  metadata.gz: 3d4002c20d43d7fa849e81970e596e8b191a9290
+  data.tar.gz: b1ebd40548471fd16a12616d3c834b9c30a8a26e
 SHA512:
-  metadata.gz: c6b77e8e70661df99d525009677064d530fa8e4e7565bf89f9215b51d90be6dda40f1df47dcaee9ff8e26ebefe5da3d0ab2448c3a5a80a95e8229ef32df5f31b
-  data.tar.gz: ed19bc67dbf0f470ad098758e19f61d927bb459692e40d6d5972353aa7ff544082f162423758abc0e2717f96892f41b08648ed43c78f3713e730c9b3fd4f1654
+  metadata.gz: 4f3f304b2f3ea1df07a0a24854e20a003f16964840800dae9ad574318369095ebec119ce7f074a3658564c530a84ec2f6a6a9a2b8fa2721aa4e6f329f982d6c3
+  data.tar.gz: ab251ceaffa37db6a13eb2b7064c8cf16babdf15d75ef79d91de1e2140a7552b1759cb34f6d051bc649242396bce9edeadc758f51231a02be69788e55b036b44

data/README.md

@@ -0,0 +1,96 @@
+[![Build Status](https://travis-ci.org/alexdalitz/dnsruby.svg?branch=master)](https://travis-ci.org/alexdalitz/dnsruby)
+[![Coverage Status](https://img.shields.io/coveralls/alexdalitz/dnsruby.svg)](https://coveralls.io/r/alexdalitz/dnsruby?branch=master)
+
+Dnsruby
+=======
+
+Dnsruby is a pure Ruby DNS client library which implements a
+stub resolver. It aims to comply with all DNS RFCs, including
+DNSSEC NSEC3 support.
+
+Dnsruby presents an enhanced API for DNS. It is based on Ruby's core
+resolv.rb Resolv API, but has been much extended to provide a
+complete DNS implementation.
+
+Dnsruby runs a single I/O thread to handle all concurrent
+queries. It is therefore suitable for high volume DNS applications.
+
+The following is a (non-exhaustive) list of features :
+
+- Implemented RRs :  A, AAAA, AFSDB, ANY, CERT, CNAME, DNAME,
+     HINFO, ISDN, LOC, MB, MG, MINFO, MR, MX, NAPTR, NS, NSAP,
+     OPT, PTR, PX, RP, RT, SOA, SPF, SRV, TKEY, TSIG, TXT, WKS,
+     X25, DNSKEY, RRSIG, NSEC, NSEC3, NSEC3PARAM, DS, DLV
+
+- Generic RR types supported (RFC3597)
+
+- (Signed) Zone transfer (AXFR and IXFR) supported
+
+- (Signed) Dynamic updates supported
+
+- DNSSEC validation supported
+
+Dependencies
+------------
+
+Dnsruby can run with no dependencies. However, if you wish to
+use TSIG or DNSSEC then the OpenSSL library must be available.
+This is a part of the Ruby standard library, but appears not to
+be present on all Ruby platforms. If it is not available, then 
+the test code will not run the tests which require it. Code which
+attempts to use the library (if it is not present) will raise an
+exception.
+
+Demo Code
+---------
+
+The demo folder contains some example programs using Dnsruby.
+These examples include a basic dig tool (rubydig) and a tool to
+concurrently resolve many names, amongst others.
+
+Unit Tests
+----------
+
+Tests require a current version of minitest (see the .gemspec file
+for which version is required).  In order for the tests to run
+successfully you may need to have the bundler gem installed and
+run `bundle` or `bundle install` from the project root to install
+a suitable version of minitest.
+
+There are "online" and "offline" tests.  You can use rake to
+conveniently run the tests.  From the project root you can run:
+```
+rake test          # run all tests
+rake test_offline  # run only offline tests
+rake test_online   # run only online tests
+```
+If you get the following error when running rake test tasks,
+then you may need to preface the command with bundle exec to
+ensure that the gem versions specified in Gemfile.lock are used
+at runtime:
+
+```
+bundle exec rake test
+```
+
+Nominet operates a test server which the Dnsruby test code queries.
+If this server is not available then some of the online tests will 
+not be run.
+
+
+Usage Help
+----------
+
+There are a couple of blog articles that might be helpful
+in understanding how to use Dnsruby:
+
+* http://blog.nominet.org.uk/tech/2009/05/19/some-examples-of-dnsruby-in-action/
+* http://blog.nominet.org.uk/tech/2009/05/21/examples-of-using-dnsruby-with-dnssec/
+
+
+Contact
+-------
+
+alex@caerkettontech.com
+https://github.com/alexdalitz/dnsruby
+

data/Rakefile

@@ -1,29 +1,30 @@
-require 'rake/testtask'
-require 'rdoc/task'
-
-Rake::RDocTask.new do |rd|
-  rd.rdoc_files.include("lib/**/*.rb")
-  rd.rdoc_files.exclude("lib/Dnsruby/iana_ports.rb")
-  rd.main = "Dnsruby"
-#  rd.options << "--ri"
-end
-  
-task :test => :install do 
-#  require 'rake/runtest'
-#  Rake.run_tests 'test/ts_dnsruby.rb'
-  require 'rake/testtask'
-
-  Rake::TestTask.new do |t|
-    t.libs << "test"
-    t.test_files = FileList['test/ts_dnsruby.rb']
-    t.verbose = true
-  end
-end
-
-task :default => :install do
-end
-
-task :install do
-  sh "ruby setup.rb"
-end
-
+require 'rake/testtask'
+
+ENV['RUN_EXTRA_TASK'] = 'TRUE' if
+  RUBY_VERSION >= "1.9.3" && defined?(RUBY_ENGINE) && RUBY_ENGINE == 'ruby'
+
+if ENV['RUN_EXTRA_TASK'] == 'TRUE'
+  require 'rdoc/task'
+
+  Rake::RDocTask.new do |rd|
+    rd.rdoc_files.include("lib/**/*.rb")
+    rd.rdoc_files.exclude("lib/Dnsruby/iana_ports.rb")
+    rd.main = "Dnsruby"
+    #  rd.options << "--ri"
+  end
+
+  require 'coveralls/rake/task'
+  Coveralls::RakeTask.new
+end
+
+def create_task(task_name, test_suite_filespec)
+  Rake::TestTask.new do |t|
+    t.name = task_name
+    t.test_files = FileList[test_suite_filespec]
+    t.verbose = true
+  end
+end
+
+create_task(:test,         'test/ts_dnsruby.rb')
+create_task(:test_offline, 'test/ts_offline.rb')
+create_task(:test_online,  'test/ts_online.rb')

data/demo/axfr.rb

@@ -1,80 +1,80 @@
-#--
-#Copyright 2007 Nominet UK
-#
-#Licensed under the Apache License, Version 2.0 (the "License");
-#you may not use this file except in compliance with the License.
-#You may obtain a copy of the License at
-#
+# --
+# Copyright 2007 Nominet UK
+# 
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
 #     http://www.apache.org/licenses/LICENSE-2.0
-#
-#Unless required by applicable law or agreed to in writing, software
-#distributed under the License is distributed on an "AS IS" BASIS,
-#WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#See the License for the specific language governing permissions and
-#limitations under the License.
-#++
-
-#= NAME
-#
-#axfr - Perform a DNS zone transfer
-#
-#= SYNOPSIS
-#
-#axfr [ -fqs ] [ -D directory ] [ @nameserver ] zone
-#
-#= DESCRIPTION
-#
-#axfr performs a DNS zone transfer, prints each record to the standard
-#output, and stores the zone to a file.  If the zone has already been
-#stored in a file, axfr will read the file instead of performing a
-#zone transfer.
-#
-#Zones will be stored in a directory hierarchy.  For example, the
-#zone transfer for foo.bar.com will be stored in the file
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ++
+
+# = NAME
+# 
+# axfr - Perform a DNS zone transfer
+# 
+# = SYNOPSIS
+# 
+# axfr [ -fqs ] [ -D directory ] [ @nameserver ] zone
+# 
+# = DESCRIPTION
+# 
+# axfr performs a DNS zone transfer, prints each record to the standard
+# output, and stores the zone to a file.  If the zone has already been
+# stored in a file, axfr will read the file instead of performing a
+# zone transfer.
+# 
+# Zones will be stored in a directory hierarchy.  For example, the
+# zone transfer for foo.bar.com will be stored in the file
 #  HOME/.dns-zones/com/bar/foo/axfr.  The directory can be changed
 #  with the B<-D> option.
-#  
+# 
 #  This programs requires that the Storable module be installed.
-#    
-#= OPTIONS
-#    
+# 
+# = OPTIONS
+# 
 #    * -f     Force a zone transfer, even if the zone has already been stored
 #    in a file.
-#    
+# 
 #    * -q    Be quiet -- don't print the records from the zone.
-#    
+# 
 #    * -s    Perform a zone transfer if the SOA serial number on the nameserver
 #    is different than the serial number in the zone file.
-#    
+# 
 #    * -D directory   Store zone files under I<directory> instead of the default directory (see "FILES")
-#    
+# 
 #    * nameserver    Query nameserver instead of the default nameserver.
-#    
-#= FILES
-#    
+# 
+# = FILES
+# 
 #  * ${HOME}/.dns-zones   Default directory for storing zone files.
-#      
-#= AUTHOR
-#      
+# 
+# = AUTHOR
+# 
 #      Michael Fuhr <mike@fuhr.org>
-#      
+# 
 
 require 'getoptLong'
 require 'dnsruby'
 
-#------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
 # Read any command-line options and check syntax.
-#------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
 
-#getopts("fqsD:");
+# getopts("fqsD:");
 opts = GetoptLong.new(["-f", GetoptLong::NO_ARGUMENT],
   ["-q", GetoptLong::NO_ARGUMENT],
   ["-D", GetoptLong::REQUIRED_ARGUMENT],
   ["-s", GetoptLong::NO_ARGUMENT])
 
 opt_q = false
-opt_f = false 
-opt_s = false 
+opt_f = false
+opt_s = false
 opt_d = nil
 opts.each do |opt, arg|
   case opt
@@ -90,13 +90,13 @@ opts.each do |opt, arg|
 end
 
 if (ARGV.length < 1) || (ARGV.length > 2)
-  print "Usage: #{$0} [ -fqs ] [ -D directory ] [ @nameserver ] zone\n" 
+  print "Usage: #{$0} [ -fqs ] [ -D directory ] [ @nameserver ] zone\n"
 else
-  #------------------------------------------------------------------------------
-  # Get the nameserver (if specified) and set up the zone transfer directory
-  # hierarchy.
-  #------------------------------------------------------------------------------
-  
+  # ------------------------------------------------------------------------------
+  #  Get the nameserver (if specified) and set up the zone transfer directory
+  #  hierarchy.
+  # ------------------------------------------------------------------------------
+
   nameserver = (ARGV[0] =~ /^@/) ? ARGV.shift : ""
   nameserver = nameserver.sub(/^@/, "")
   res = nil
@@ -105,18 +105,18 @@ else
   else
     res = Dnsruby::Resolver.new
   end
-  
-  zone = ARGV.shift 
+
+  zone = ARGV.shift
   basedir = opt_d!=nil ? opt_d : (ENV["HOME"]!=nil ? ENV["HOME"] : "") + "/.dns-zones"
   zonedir = zone.split(/\./).reverse.join("/")
   zonefile = basedir + "/" + zonedir + "/axfr"
-  
-  # Don't worry about the 0777 permissions here - the current umask setting
-  # will be applied.
-  if !(FileTest.directory?basedir) 
+
+  #  Don't worry about the 0777 permissions here - the current umask setting
+  #  will be applied.
+  if !(FileTest.directory?basedir)
     Dir.mkdir(basedir, 0777) or raise RuntimeError, "can't mkdir #{basedir}: #{$!}\n"
   end
-  
+
   dir = basedir
   zonedir.split("/").each do |subdir|
     dir += "/" + subdir
@@ -124,26 +124,26 @@ else
       Dir.mkdir(dir, 0777) or raise RuntimeError, "can't mkdir #{dir}: #{$!}\n"
     end
   end
-  
-  #------------------------------------------------------------------------------
-  # Get the zone.
-  #------------------------------------------------------------------------------
-  
+
+  # ------------------------------------------------------------------------------
+  #  Get the zone.
+  # ------------------------------------------------------------------------------
+
   zonearray = nil
-  
+
   if (FileTest.exist?(zonefile) && !opt_f)
     zoneref = Marshal.load(File.open(zonefile))
     if (zoneref==nil)
       raise RuntimeError, "couldn't retrieve zone from #{zonefile}: #{$!}\n"
     end
-    
-    #----------------------------------------------------------------------
-    # Check the SOA serial number if desired.
-    #----------------------------------------------------------------------
-    
+
+    # ----------------------------------------------------------------------
+    #  Check the SOA serial number if desired.
+    # ----------------------------------------------------------------------
+
     if (opt_s)
       serial_file, serial_zone = nil
-      
+
       zoneref.each do |rr|
         if (rr.type == "SOA")
           serial_file = rr.serial
@@ -151,48 +151,48 @@ else
         end
       end
       if serial_file==nil
-        raise RuntimeError,  "no SOA in #{zonefile}\n" 
+        raise RuntimeError,  "no SOA in #{zonefile}\n"
       end
-      
+
       soa = res.query(zone, "SOA")
       if soa==nil
-        raise RuntimeError, "couldn't get SOA for #{zone}: " + res.errorstring + "\n" 
+        raise RuntimeError, "couldn't get SOA for #{zone}: " + res.errorstring + "\n"
       end
-      
+
       soa.answer.each do |rr|
         if (rr.type == "SOA")
           serial_zone = rr.serial
           break
         end
       end
-      
+
       if (serial_zone != serial_file)
         opt_f = true
       end
-    end 
+    end
   else
     opt_f = true
   end
-  
+
   if (opt_f)
     print "nameserver = #{nameserver}, zone=#{zone}"
     zt = Dnsruby::ZoneTransfer.new
     zt.server=(nameserver) if nameserver!=""
-    
+
     zoneref = zt.transfer(zone)
     if zoneref==nil
       raise RuntimeError,  "couldn't transfer zone\n"
     end
     Marshal.dump(zoneref, File.open(zonefile, File::CREAT|File::RDWR))
   end
-  
-  #------------------------------------------------------------------------------
-  # Print the records in the zone.
-  #------------------------------------------------------------------------------
-  
-  if (!opt_q) 
+
+  # ------------------------------------------------------------------------------
+  #  Print the records in the zone.
+  # ------------------------------------------------------------------------------
+
+  if (!opt_q)
     zoneref.each do |z|
       print z.to_s + "\n"
     end
-  end  
-end  
+  end
+end