pdns-remotebackend 0.0.4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pdns_remotebackend.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aki Tuomi
+
+MIT License
+
+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,72 @@
+# Pdns/Remotebackend
+
+This is a helper for PowerDNS remotebackend. It lets you create a backend with less hassle. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pdns-remotebackend'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdns-remotebackend
+
+## Usage
+
+Please see contrib/example.rb for example script. All methods and their arguments are described in detail at http://doc.powerdns.com/remotebackend.html. When your script
+is called, the Handler class needs to have method with name do\_<name-of-method;gt;(args). Such as do\_lookup(args). Any arguments are passed as hash to your handler. 
+
+To get starting, subclass Pdns::Remotebackend::Handler. You need to override at least 'do\_lookup(args)' method. You are passed in arguments as
+
+    args = { "qname" => "www.example.com", "qtype" => "ANY|SOA", .. + other stuff }
+
+You are expected to modify object attribute 'result' to contain an array of records. The easiest way is to do 
+
+    result = [ record("www.example.com","A","127.0.01") ]
+
+This will construct a reply array with one resource record. 
+
+Some methods expect non-array output, you can provide
+
+    result = true
+    result = { :foo => :bar } 
+
+If you wish to log something, use 
+
+    log << "something I want logged".  
+
+Should you need some parameters passed to the remotebackend connection string, you can always have a look at @parameters, which contains them.  
+
+To start a pipe or unix server, do
+
+    Pdns::Remotebackend::Pipe.new(MyHandlerClass).run
+    Pdns::Remotebackend::Unix(MyHandlerClass, { :path => "/path/to/socket"} ).run
+
+## Reference
+
+In addition to stubs for remotebackend, the Pdns::Remotebackend::Handler has following helpers for making records
+
+    def record_prio_ttl(qtype,qname,content,prio,ttl,auth=1)
+      {:qtype => qtype, :qname => qname, :content => content, :priority => prio, :ttl => ttl, :auth => auth}
+    end
+
+    def record_prio(qtype,qname,content,prio,auth=1)
+      record_prio_ttl(qtype,qname,content,prio,@ttl,auth)
+    end
+
+    def record(qtype,qname,content,auth=1)
+      record_prio_ttl(qtype,qname,content,0,@ttl,auth)
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/contrib/example.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'pdns/remotebackend'
+
+## this is an example stub for remote backend
+## to add more methods, just write
+## def do_<methodname>(args)
+## end
+## look at the existing methods to find out 
+## how to customize this. 
+
+## WARNING: this contains some code that 
+## should never be used in production, but 
+## is provided to give a more comperehensive
+## example code. 
+
+## Code provided only as example, not suitable
+## for production. 
+
+## Usage: 
+##  launch=remote
+##  remote-dnssec=yes
+##  remote-connection-string=pipe:command=/path/to/remote.rb,timeout=2000
+
+class RequestHandler < Pdns::Remotebackend::Handler
+  ## used to tell that we do NSEC3 NARROW
+  def do_getdomainmetadata(args)
+     if args["name"] == "example.com"
+       if args["kind"] == "NSEC3NARROW"
+           result = "1"
+       elsif args["kind"] == "NSEC3PARAM"
+           result = "1 1 1 fe"
+       end
+     end
+  end
+
+  ## returns keys, do not use in production
+  ## you can use 'pdnssec generate-zone-key' to 
+  ## generate these
+  def do_getdomainkeys(args)
+     if args["name"] == "example.com"
+        result = [ 
+          {
+             "id" => 1,
+             "flags" => 257,
+             "active" => true,
+             "content" => "Private-key-format: v1.2
+Algorithm: 8 (RSASHA256)
+Modulus: ovvzf1fHdptdXsBrBLSqmGqdEKwR2B9st/KBgh8xQKoQzTGUG00CsPjF/J59IBU+EU/IIInMn0MxLLTyUKa2DJUkR6i7UKif5jKX1c7yvWzrFKLGOHjugUX2++r+o789biUte1qpWp3Kc2RYL18oPco4zpo6JcsPmhOK3aUCDJXmuWgHl1KudCQIiPkISArXVn4oOp+skQq+mUBl1Pysc4D+6sl77ERR2fW6xJ4ZRPOIKr445RJJmKgoMG8yRrR3it1RmV49hZlvMosQjBUoNcqhqOI0n4l8HOLyna7KIzoNKG62GtUCZh8uy8IjdUiWPYGEtkZ9zE0bnnF+R7HGvQ==
+PublicExponent: AQAB
+PrivateExponent: Lp/c3IUD7o4re7uX4dS9KLT3EZnn0OfMdiLNoafCszjzbX/NWrIBHxdLrCS6rr7k7pbgLU6+VqEmJB/vYdsPITJZGpbOXxieBYBbpzJ4hm/uIA0gn28Y66pUKWTkS3ud2zCPfkZFREL3c2M1Rvf1zxdWgOPl1oHsiKsmgpl9qJOSKHMWFC+m/pUMJ7iOMgyDRV+PNeb/8P1jVOAYyQMEnu+enw2ro2NiWXNikbnaWrIv3IxVZAyZG4/H8+1vfQFPDWztosOy7OhV3WyMJkfwcXrlGoyLlxyAgkh/jeCnmPllxlJZGTgCtoVYd/n8osMXCDKxpAhsfdfCPeNOcjocgQ==
+Prime1: +T+s7wv+zVqONJqkAKw4OCVzxBc5FWrmDPcjPCUeKIK/K/3+XjmIqTlbvBKf+7rm+AGVnXAbqk90+jzE3mKI8HMG/rM2cx01986xNQsIqwi2VAt25huPhEyrtNzos6lmrCYaioaQnNpMvMLun3DvcaygkDUXxH7Dg+6BTHeUfnk=
+Prime2: p2YbBveBK3XyGMuVrDH9CvvpgKEoko+mPwLoKNpBoHrGxeOdCQmlPbnr0GrtZpy4sBNc5+shz2c6c1J3GlgPndT7zi2+MFGfWIGV48SAknVLfOU4iUpaGllnxcbjZeytG6WHdy2RaR3ReeGvdWxmxeuv084c2zC/7/vkcmgOqWU=
+Exponent1: EdVFeUEBdQ3imM7rpwSrbRD47HHA6tBgL1NLWRVKyBk6tloQ5gr1xS3Oa3FlsuwXdG0gmEgaIqBWvUS1zTd9lr6UJIsL/UZ8wwMt2J62ew4/hVngouwb45pcuq8HkzsulmiPg5PHKwHPdb34tr2s1BRG1KqHzc5IDNt2stLnc/k=
+Exponent2: oT+Iv1BAu7WUa/AHj+RjJGZ+iaozo+H9uOq66Uc8OjKqMErNpLwG0Qu7rHqjjdlfSjSMpNXpLpj4Q8fm9JhpCpbzq6qCbpbhUGcbFFjfpLSZ74f5yr21R3ZhsLChsTenlF8Bu3pIfKH9e1M7KXgvE22xY+xB/Z3a9XeFmfLEVMU=
+Coefficient: vG8tLZBE4s3bftN5INv2/o3knEcaoUAPfakSsjM2uLwQCGiUbBOOlp3QSdTU4MiLjDsza3fKIptdwYP9PvSkhGhtLPjBpKjRk1J1+sct3dfT66JPClJc1A8bLQPj4ZpO/BkJe6ji4HYfOp7Rjn9z8rTqwEfbP64CZV3/frUzIkQ="
+          },
+          {
+             "id" => 2,
+             "flags" => 256,
+             "active" => true,
+             "content" => "Private-key-format: v1.2
+Algorithm: 8 (RSASHA256)
+Modulus: wKPNcDwkCd2DKxfdkMqTFOV2ITdgxIDaOd4vQ2QtphMBY9yYwmEkNsVdVFz7VVuQHdls20JUe+brFUhs1zEMMbokulFP/qVAItAeEWcqtkPULT+mmX5HsexpFVAZ5+UXuerObk/HMiIMt1CvkIWhmjSIkAI6dFRlf/93zTjy0+vwrNWZPXSzLccK5TfJmxdYdGPcsHkg6UmqEFPQuyZpmlmpg3IwjL5YddTDobAoABz/BrH7WsW0q/PyVubITo8JuFiBI5Fmw+3ef3PVUt1jtUCGASvtqNXW4wtWrgqvQKg/odthpceQ4QagV9XSlOdml527thnf9cMpm0Gh4Ox5HQ==
+PublicExponent: AQAB
+PrivateExponent: f+M+26fRdQstrUomuZ0Cj/jVt69/+nRga9JpJiA3fe1YGue0MjczR3k3QG6KHFyxDF/vuJAMbkUbBAIU37ecFNcy0s5wgOlL7tCjZYJMBLx6+58qBvSivCfqi0+mIyEf4zlS2kD0SP/52SkjpJpScoE1uAUCsX/l8lezPPb1nmH3RDwJwX1NVhsErHCAmxGDoj4nPCEhKgHkdbR0i8geXGdWR4slyq1EhuGJal4p5sNvzDQTYRy6r49rpbNHw9F7ojomIhTUCUjOXAX0X1HB5UTXRMpgpCNEjRG1a+aqxp/ZSMHSEGCv67fua5Qrd/qX1Ppns/oqZfCfTpTD3v/sMQ==
+Prime1: +0zQuFi7rZDTMGMIKiF6UOG5+pKwGxHmgKPOGF6fk3tIuSomgiVD3DLz5Y6kYk0kKls6IiA6X2esYwNXAaLe0dyMzpAnU4URXhFW7fUnHP0zA7NmaFRYPHstPeU59/JS+zmVlj4Ok1oeGocSGAFYGxXa+Sot0fyCXpAjZboDWg8=
+Prime2: xD4hprQmcn5gmLqYO9+nEEJTNyNccbAciiKjRJxIE7w6muuKESx0uUn5XdnzSxhbVkK16kkEqW3s+Y+VoLxwRj2fuvoPfx8nTQXY1esgcIZCG8ubvHW5T0bzee5gyX3cMvaxkoeM7euYgvh0UwR/FG910SwAlmMZjSwXay2YlhM=
+Exponent1: 6vcWzNcCnDWmkT53WtU0hb2Y4+YVzSm+iRcf039d20rRY3g6y0NGoPPvQftOTi9smkH0KAZULfJEp8tupbQAfN6ntVfpvVjVNUwnKJUo/hzsfxBVt0Ttv5c4ZQAYZHHqDsX3zKO3gyUmso0KaPGQzLpxpLlAYG+mAf7paeszyRc=
+Exponent2: ouvWMjk0Bi/ncETRqDuYzkXSIl+oGvaT6xawp4B70m6d1QohWPqoeT/x2Dne44R4J9hAgR5X0XXinJnZJlXrfFUi7C84eFhb33UwPQD0sJa2Aa97Pu4Zh7im4J7IGd/01Ra7+6Ovm8LRnkI5CMcd3dBfZuX6IuBpUSu+0YtMN6M=
+Coefficient: 5lP9IFknvFgaXKCs8MproehHSFhFTWac4557HIn03KrnlGOKDcY6DC/vgu1e42bEZ4J0RU0EELp5u4tAEYcumIaIVhfzRsajYRGln2mHe6o6nTO+FbANKuhyVmBEvTVczPOcYLrFXKVTglKAs+8W96dYIMDhiAwxi9zijLKKQ1k="
+          }
+        ]
+     end
+  end
+
+  ## Example lookup
+  ## Returns SOA, MX, NS and A records for example.com
+  ## also static A record for test.example.com
+  ## and dynamic A record for anything else in example.com domain 
+  def do_lookup(args)
+     if args["qname"] == "example.com" and args["qtype"].downcase == "soa"
+       result = [
+          record("SOA","example.com", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
+              ]
+     elsif args["qname"] == "example.com" and args["qtype"].downcase == "any"
+       result = [ 
+          record("SOA","example.com", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
+          record("NS","example.com","sns.dns.icann.org"),
+          record_prio("MX","example.com","test.example.com",10)
+              ]
+     elsif args["qname"] == "test.example.com" and args["qtype"].downcase == "any"
+       result = [
+          record("A","test.example.com","127.0.0.1")
+       ]
+     elsif args["qname"] =~ /(.*)\.example\.com$/ and args["qtype"].downcase == "any"
+       ip = 0
+       $1.downcase.each_byte do |b| ip = ip + b end
+       ip_2 = ip/256
+       ip = ip%256
+       result = [
+          record("A",args["qname"], "127.0.#{ip_2}.#{ip}")
+       ]
+     end
+  end
+
+  ## AXFR support
+  ## Do note that having AXFR here is somewhat stupid since
+  ## we generate records above. But it is still included
+  ## for sake of having an example. Do not do ths in production.
+  def do_list(args)
+     if args["zonename"] == "example.com"
+       result = [
+          record("SOA","example.com", "sns.dns.icann.org noc.dns.icann.org 2013012485 7200 3600 1209600 3600"),
+          record("NS","example.com","sns.dns.icann.org"),
+          record_prio("MX","example.com","test.example.com",10),
+          record("A","test.example.com","127.0.0.1")
+       ]
+     end
+  end
+end
+
+Pdns::Remotebackend::Pipe.new(RequestHandler).run

data/lib/pdns/remotebackend/version.rb

@@ -0,0 +1,5 @@
+module Pdns
+ module Remotebackend
+  VERSION = "0.0.4"
+ end
+end

data/lib/pdns/remotebackend.rb

@@ -0,0 +1,184 @@
+require 'socket'
+require 'json'
+require 'pdns/remotebackend/version'
+
+module Pdns
+ module Remotebackend 
+  class Handler
+     attr_accessor :log, :result, :ttl
+
+     def initialize
+       @log = []
+       @result = false
+       @ttl = 300
+       @params = {}
+     end
+ 
+     def record_prio_ttl(qtype,qname,content,prio,ttl,auth=1)
+       {:qtype => qtype, :qname => qname, :content => content, :priority => prio, :ttl => ttl, :auth => auth}
+     end
+
+     def record_prio(qtype,qname,content,prio,auth=1)
+       record_prio_ttl(qtype,qname,content,prio,@ttl,auth)
+     end
+
+     def record(qtype,qname,content,auth=1)
+       record_prio_ttl(qtype,qname,content,0,@ttl,auth)
+     end
+  
+     def do_initialize(args)
+       @params = args
+       @log << "PowerDNS ruby remotebackend version #{Pdns::Remotebackend::VERSION} initialized"
+       @result = true
+     end
+  
+     def do_lookup(args) 
+     end
+  
+     def do_list(args)
+     end 
+  
+     def do_getdomainmetadata(args)
+     end
+  
+     def do_setdomainmetadata(args)
+     end
+  
+     def do_adddomainkey(args)
+     end
+  
+     def do_getdomainkeys(args) 
+     end 
+  
+     def do_activatedomainkey(args) 
+     end 
+  
+     def do_deactivatedomainkey(args)
+     end
+  
+     def do_removedomainkey(args)
+     end 
+  
+     def do_getbeforeandafternamesabsolute(args)
+     end
+  
+     def do_gettsigkey(args) 
+     end
+  
+     def do_setnotified(args) 
+     end
+  
+     def do_getdomaininfo(args) 
+     end
+  
+     def do_supermasterbackend(args) 
+     end
+  
+     def do_createslavedomain(args)
+     end
+  
+     def do_feedrecord(args)
+     end
+  
+     def do_replacerrset(args)
+     end 
+  
+     def do_feedents(args)
+     end
+  
+     def do_feedents3(args)
+     end
+  
+     def do_settsigkey(args) 
+     end
+  
+     def do_deletetsigkey(args)
+     end
+  
+     def do_gettsigkeys(*args)
+     end
+  
+     def do_starttransaction(args) 
+     end
+  
+     def do_committransaction(args)
+     end
+  
+     def do_aborttransaction(args)
+     end
+    
+     def do_calculatesoaserial(args)
+     end
+  end
+
+  class Connector 
+    def initialize(klass, options = {})
+      @handler = klass
+      @options = options
+    end
+
+    def open
+      [STDIN,STDOUT]
+    end
+
+    def close
+    end
+
+    def mainloop
+      h = @handler.new
+      reader,writer = self.open
+      
+      begin
+        reader.each_line do |line|
+          # expect json
+          input = {}
+          line = line.strip
+          next if line.empty?
+          begin
+            input = JSON.parse(line)
+            method = "do_#{input["method"].downcase}"
+            args = input["parameters"] || []
+
+            h.result = false
+            h.log = []
+ 
+            if h.respond_to?(method.to_sym) == false
+               res = false
+            elsif args.size > 0
+               h.send(method,args)
+            else
+               h.send(method)
+            end
+
+            writer.puts ({:result => h.result, :log => h.log}).to_json
+          rescue JSON::ParserError
+            writer.puts ({:result => false, :log => "Cannot parse input #{line}"}).to_json
+            next
+          end
+        end
+      rescue SystemExit, Interrupt
+      end 
+      self.close
+    end
+  end
+ end
+
+ class Pipe
+   def run
+     mainloop
+   end
+ end
+
+ class Unix 
+    def run
+      @path = options[:path] || "/tmp/remotebackend.sock"
+      Socket.unix_server_loop(@path) do |sock, client_addrinfo| 
+         begin 
+            mainloop sock, sock
+         ensure
+            sock.close
+         end
+      end
+    end
+ end
+end

data/pdns-remotebackend.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pdns/remotebackend/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Aki Tuomi"]
+  gem.email         = ["cmouse@desteem.org"]
+  gem.description   = %q{This gem provides a base class and helpers for writing remotebackend servers for pipe/unix/. It is intended to make using remotebackend easier. For http support, see pdns-remotebackend-http.}
+  gem.summary       = %q{This gem provides a base class and helpers for writing remotebackend servers for pipe/unix/http post/json modes}
+  gem.homepage      = "http://github.com/cmouse/pdns-remotebackend"
+  gem.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          = "pdns-remotebackend"
+  gem.require_paths = ["lib"]
+  gem.version       = Pdns::Remotebackend::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_runtime_dependency 'json'
+end

data/spec/lib/pdns_remotebackend_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Pdns::Remotebackend::Handler, "#do_initialize" do
+  it "should return true for initialize" do
+     h = Pdns::Remotebackend::Handler.new
+     h.do_initialize
+     h.result.should eq true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'pdns/remotebackend'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: pdns-remotebackend
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Aki Tuomi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &6278620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6278620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &6278200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6278200
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &6277780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *6277780
+description: This gem provides a base class and helpers for writing remotebackend
+  servers for pipe/unix/. It is intended to make using remotebackend easier. For http
+  support, see pdns-remotebackend-http.
+email:
+- cmouse@desteem.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- contrib/example.rb
+- lib/pdns/remotebackend.rb
+- lib/pdns/remotebackend/version.rb
+- pdns-remotebackend.gemspec
+- spec/lib/pdns_remotebackend_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cmouse/pdns-remotebackend
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: This gem provides a base class and helpers for writing remotebackend servers
+  for pipe/unix/http post/json modes
+test_files:
+- spec/lib/pdns_remotebackend_spec.rb
+- spec/spec_helper.rb