epp-client-secdns 0.11.0

data/ChangeLog

@@ -0,0 +1,5 @@
+2010-05-14 mat
+	* first release
+
+2010-05-04 mat
+	* Initial commit

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in epp-client.gemspec
+Dir['*.gemspec'].each do |i|
+  gemspec :name => i.sub(/\.gemspec$/, '')
+end

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2010 Mathieu Arnold, Absolight
+
+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

@@ -0,0 +1,5 @@
+An extensible EPP client library
+
+When possible, the objects that are received via EPP are translated to their
+equivalent in ruby, that is, dates in Date object, timestamps in DateTime
+objects.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+require 'rake'
+require 'rdoc/task'
+require 'rubygems/package_task'
+require "bundler/gem_helper"
+
+MY_GEMS = Dir['*.gemspec'].map {|g| g.sub(/.*-(.*)\.gemspec/, '\1')}
+
+MY_GEMS.each do |g|
+  namespace g do
+    Bundler::GemHelper.new(Dir.pwd, "epp-client-#{g}").install
+  end
+end
+
+namespace :all do
+  task :build   => MY_GEMS.map { |f| "#{f}:build"   }
+  task :install => MY_GEMS.map { |f| "#{f}:install" }
+  task :release => MY_GEMS.map { |f| "#{f}:release" }
+end
+
+task :build   => 'all:build'
+task :install => 'all:install'
+task :release => 'all:release'
+
+desc "Generate documentation for the Rails framework"
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Documentation"
+
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('ChangeLog')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/epp-client-secdns.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/epp-client/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'epp-client-secdns'
+  gem.version       = EPPClient::VERSION
+  gem.date          = '2010-05-14'
+  gem.authors       = ['Mathieu Arnold']
+  gem.email         = ['m@absolight.fr']
+  gem.description   = 'SecDNS EPP client library.'
+  gem.summary       = 'SecDNS EPP client library'
+  gem.homepage       = "https://github.com/Absolight/epp-client"
+
+  gem.required_ruby_version = '>= 1.8.7'
+  gem.required_rubygems_version = ">= 1.3.6"
+
+  gem.files         = [
+    'ChangeLog',
+    'Gemfile',
+    'MIT-LICENSE',
+    'README',
+    'Rakefile',
+    'epp-client-secdns.gemspec',
+    'lib/epp-client/secdns.rb',
+    'vendor/ietf/rfc4310.txt',
+    'vendor/ietf/rfc5910.txt',
+    'vendor/ietf/secDNS-1.0.xsd',
+    'vendor/ietf/secDNS-1.1.xsd',
+  ]
+
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_dependency('nokogiri', '~> 1.4')
+  gem.add_dependency('builder',  '>= 2.1.2')
+end

data/lib/epp-client/secdns.rb

@@ -0,0 +1,243 @@
+module EPPClient
+  module SecDNS
+    SCHEMAS_SECDNS = %w[
+      secDNS-1.1
+    ]
+
+    EPPClient::SCHEMAS_URL.merge!(SCHEMAS_SECDNS.inject({}) do |a,s|
+      a[s.sub(/-1\.1$/, '')] = "urn:ietf:params:xml:ns:#{s}" if s =~ /-1\.1$/
+      a[s] = "urn:ietf:params:xml:ns:#{s}"
+      a
+    end)
+
+    def initialize(args)
+      super
+      @extensions << EPPClient::SCHEMAS_URL['secDNS-1.1']
+    end
+
+    # Extends the base domain info so that the specific secDNS elements
+    # can be added.
+    #
+    # either:
+    # [<tt>:keyData</tt>]
+    #   containing an array of keyData objects with the following fields :
+    #   [<tt>:flags</tt>]
+    #     The flags field value as described in {section 2.1.1 of RFC
+    #     4034}[http://tools.ietf.org/html/rfc4034#section-2.1.1].
+    #   [<tt>:protocol</tt>]
+    #     The protocol field value as described in {section 2.1.2 of RFC
+    #     4034}[http://tools.ietf.org/html/rfc4034#section-2.1.2].
+    #   [<tt>:alg</tt>]
+    #     The algorithm number field value as described in {section 2.1.3 of RFC
+    #     4034}[http://tools.ietf.org/html/rfc4034#section-2.1.3].
+    #   [<tt>:pubKey</tt>]
+    #     The encoded public key field value as described in {Section 2.1.4 of
+    #     RFC 4034}[http://tools.ietf.org/html/rfc4034#section-2.1.4].
+    # [<tt>:dsData</tt>]
+    #   containing an array of dsData objects with the following fields :
+    #   [<tt>:keyTag</tt>]
+    #     The key tag value as described in {Section 5.1.1 of RFC
+    #     4034}[http://tools.ietf.org/html/rfc4034#section-5.1.1].
+    #   [<tt>:alg</tt>]
+    #     The algorithm value as described in {Section 5.1.2 of RFC
+    #     4034}[http://tools.ietf.org/html/rfc4034#section-5.1.2].
+    #   [<tt>:digestType</tt>]
+    #     The digest type value as described in {Section 5.1.3 of RFC
+    #     4034}[http://tools.ietf.org/html/rfc4034#section-5.1.3].
+    #   [<tt>:digest</tt>]
+    #     The digest value as described in {Section 5.1.1 of RFC
+    #     4034}[http://tools.ietf.org/html/rfc4034#section-5.1.1].
+    #   [<tt>:keyData</tt>]
+    #     An optional element that describes the key data used as input in the DS
+    #     hash calculation for use in server validation. The <tt>:keyData</tt>
+    #     element contains the child elements defined above.
+    #
+    # Optionnaly :
+    # [<tt>:maxSigLife</tt>]
+    #   An element that indicates a child's preference for the number of seconds
+    #   after signature generation when the parent's signature on the DS
+    #   information provided by the child will expire.
+    def domain_info(domain)
+      super # placeholder so that I can add some doc
+    end
+
+    def domain_info_process(xml) #:nodoc:
+      ret = super
+      ret_secdns = {}
+      if (maxSigLife = xml.xpath('epp:extension/secDNS:infData/secDNS:maxSigLife', EPPClient::SCHEMAS_URL)).size > 0
+	ret_secdns[:maxSigLife] = maxSigLife.text
+      end
+      ret_secdns[:dsData] = xml.xpath('epp:extension/secDNS:infData/secDNS:dsData', EPPClient::SCHEMAS_URL).map do |s|
+	parse_ds_data(s)
+      end
+      ret_secdns[:keyData] = xml.xpath('epp:extension/secDNS:infData/secDNS:keyData', EPPClient::SCHEMAS_URL).map do |s|
+	parse_key_data(s)
+      end
+
+      ret[:secDNS] = ret_secdns unless ret_secdns.values.reject {|v| v.nil?}.size == 0
+      ret
+    end
+
+    # Extends the base domain create so that the specific secDNS create
+    # informations can be sent, the additionnal informations are :
+    #
+    # either:
+    # [<tt>:keyData</tt>]
+    #   containing an array of keyData objects as described in the domain_info function.
+    # [<tt>:dsData</tt>]
+    #   containing an array of dsData objects as described in the domain_info function.
+    #
+    # Optionnaly :
+    # [<tt>:maxSigLife</tt>]
+    #   as described in the domain_info function.
+    def domain_create(domain)
+      super # placeholder so that I can add some doc
+    end
+
+    def domain_create_xml(domain) #:nodoc:
+      ret = super
+
+      if domain.key?(:maxSigLife) || domain.key?(:dsData) || domain.key?(:keyData)
+	ext = extension do |xml|
+	  xml.create( :xmlns => EPPClient::SCHEMAS_URL['secDNS']) do
+	    if domain.key?(:maxSigLife)
+	      xml.maxSigLife(domain[:maxSigLife])
+	    end
+	    if domain.key?(:dsData)
+	      domain[:dsData].each do |ds|
+		make_ds_data(xml, ds)
+	      end
+	    elsif domain.key?(:keyData)
+	      domain[:keyData].each do |key|
+		make_key_data(xml, key)
+	      end
+	    end
+	  end
+	end
+	return insert_extension(ret, ext)
+      else
+	return ret
+      end
+    end
+
+    # Extends the base domain update so that secDNS informations can be sent, the
+    # additionnal informations are contained in an <tt>:secDNS</tt> object :
+    #
+    # [:rem]
+    #   To remove keys or ds from the delegation, with possible attributes one of :
+    #
+    #   [<tt>:all</tt>]
+    #     used to remove all DS and key data with a value of boolean true.  A
+    #     value of boolean false will do nothing.  Removing all DS information
+    #     can remove the ability of the parent to secure the delegation to the
+    #     child zone.
+    #   [<tt>:dsData</tt>]
+    #     an array of dsData elements described in the domain_info function.
+    #   [<tt>:keyData</tt>]
+    #     an array of keyData elements as described in the domain_info function.
+    #
+    # [:add]
+    #   To add keys or DS from the delegation, with possible attributes one of :
+    #
+    #   [<tt>:dsData</tt>]
+    #     an array of dsData elements described in the domain_info function.
+    #   [<tt>:keyData</tt>]
+    #     an array of keyData elements as described in the domain_info function.
+    # [:chg]
+    #   contains security information to be changed, one of :
+    #
+    #   [:maxSigLife]
+    #     optional, as described in the domain_info function.
+    def domain_update(args)
+      super # placeholder so that I can add some doc
+    end
+
+    def domain_update_xml(domain)
+      ret = super
+
+      if domain.key?(:secDNS)
+	sd = domain[:secDNS]
+	ext = extension do |xml|
+	  xml.update(sd[:urgent] == true ? {:urgent => true}: {}, {:xmlns => EPPClient::SCHEMAS_URL['secDNS']}) do
+	    if sd.key?(:rem)
+	      xml.rem do
+		if sd[:rem].key?(:all) && sd[:rem][:all] == true
+		  xml.all true
+		elsif sd[:rem].key?(:dsData)
+		  sd[:rem][:dsData].each do |ds|
+		    make_ds_data(xml, ds)
+		  end
+		elsif sd[:rem].key?(:keyData)
+		  sd[:rem][:keyData].each do |key|
+		    make_key_data(xml, key)
+		  end
+		end
+	      end
+	    end
+	    if sd.key?(:add)
+	      xml.add do
+		if sd[:add].key?(:dsData)
+		  sd[:add][:dsData].each do |ds|
+		    make_ds_data(xml, ds)
+		  end
+		elsif sd[:add].key?(:keyData)
+		  sd[:add][:keyData].each do |key|
+		    make_key_data(xml, key)
+		  end
+		end
+	      end
+	    end
+	    if sd.key?(:chg) && sd[:chg].key?(:maxSigLife)
+	      xml.chg do
+		xml.maxSigLife sd[:chg][:maxSigLife]
+	      end
+	    end
+	  end
+	end
+	return insert_extension(ret, ext)
+      else
+	return ret
+      end
+    end
+
+    private
+    def make_key_data(xml, key)
+      xml.keyData do
+	xml.flags key[:flags]
+	xml.protocol key[:protocol]
+	xml.alg key[:alg]
+	xml.pubKey key[:pubKey]
+      end
+    end
+    def make_ds_data(xml, ds)
+      xml.dsData do
+	xml.keyTag ds[:keyTag]
+	xml.alg ds[:alg]
+	xml.digestType ds[:digestType]
+	xml.digest ds[:digest]
+	make_key_data(xml, ds[:keyData]) if ds.key?(:keyData)
+      end
+    end
+    def parse_key_data(xml)
+      {
+	:flags => xml.xpath("secDNS:flags", EPPClient::SCHEMAS_URL).text.to_i,
+	:protocol => xml.xpath("secDNS:protocol", EPPClient::SCHEMAS_URL).text.to_i,
+	:alg => xml.xpath("secDNS:alg", EPPClient::SCHEMAS_URL).text.to_i,
+	:pubKey => xml.xpath("secDNS:pubKey", EPPClient::SCHEMAS_URL).text,
+      }
+    end
+    def parse_ds_data(xml)
+      ret = {
+	:keyTag => xml.xpath("secDNS:keyTag", EPPClient::SCHEMAS_URL).text.to_i,
+	:alg => xml.xpath("secDNS:alg", EPPClient::SCHEMAS_URL).text.to_i,
+	:digestType => xml.xpath("secDNS:digestType", EPPClient::SCHEMAS_URL).text.to_i,
+	:digest => xml.xpath("secDNS:digest", EPPClient::SCHEMAS_URL).text
+      }
+      if (keyData = xml.xpath('secDNS:keyData', EPPClient::SCHEMAS_URL)).size > 0
+	ret[:keyData] = parse_key_data(keyData)
+      end
+      ret
+    end
+
+  end
+end