Bump version

Support IPv6 addresses

.travis.yml

@@ -3,7 +3,9 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-  - 1.8.7
 
 gemfile:
   - Gemfile
+
+before_install:
+  - gem install bundler

README.md

@@ -6,11 +6,11 @@ A small, lightweight and extensible DynDNS server written with Ruby and Rack.
 
 ## Description
 
-dyndnsd.rb is aimed to implement a small [DynDNS-compliant](http://dyn.com/support/developers/api/) server in Ruby. It has an integrated user and hostname database in it's configuration file that is used for authentication and authorization. Besides talking the DynDNS protocol it is able to invoke an so-called *updater*, a small Ruby module that takes care of supplying the current host => ip mapping to a DNS server.
+dyndnsd.rb aims to implement a small [DynDNS-compliant](http://dyn.com/support/developers/api/) server in Ruby supporting IPv4 and IPv6 addresses. It has an integrated user and hostname database in it's configuration file that is used for authentication and authorization. Besides talking the DynDNS protocol it is able to invoke an so-called *updater*, a small Ruby module that takes care of supplying the current host => ip mapping to a DNS server.
 
-The is currently one updater shipped with dyndnsd.rb `command_with_bind_zone` that writes out a zone file in BIND syntax onto the current system and invokes a user-supplied command afterwards that is assumed to trigger the DNS server (not necessarily BIND since it's zone files are read by other DNS servers too) to reload it's zone configuration.
+There is currently one updater shipped with dyndnsd.rb `command_with_bind_zone` that writes out a zone file in BIND syntax onto the current system and invokes a user-supplied command afterwards that is assumed to trigger the DNS server (not necessarily BIND since it's zone files are read by other DNS servers too) to reload it's zone configuration.
 
-Because of the mechanisms used dyndnsd.rb is known to work only on *nix systems.
+Because of the mechanisms used dyndnsd.rb is known to work only on \*nix systems.
 
 ## General Usage
 
@@ -112,6 +112,16 @@ where:
 * HOSTNAMES is a required list of comma separated FQDNs (they all have to end with your config.yaml domain) the user wants to update
 * MYIP is optional and the HTTP client's address will be used if missing
 
+### IP address determination
+
+The following rules apply:
+
+* use any IP address provided via the myip parameter when present, or
+* use any IP address provided via the X-Real-IP header e.g. when used behind HTTP reverse proxy such as nginx, or
+* use any IP address used by the connecting HTTP client
+
+If you want to provide an additional IPv6 address as myip6 parameter the myip parameter containing an IPv4 address has to be present, too! No automatism is applied then.
+
 ### SSL, multiple listen ports
 
 Use a webserver as a proxy to handle SSL and/or multiple listen addresses and ports. DynDNS.com provides HTTP on port 80 and 8245 and HTTPS on port 443.

dyndnsd.gemspec

@@ -20,8 +20,8 @@ Gem::Specification.new do |s|
 
   s.executables = ['dyndnsd']
 
-  s.add_runtime_dependency 'rack'
-  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'rack', '~> 1.6'
+  s.add_runtime_dependency 'json', '~> 1.8'
   s.add_runtime_dependency 'metriks'
 
   s.add_development_dependency 'bundler', '~> 1.3'

lib/dyndnsd.rb

@@ -44,11 +44,11 @@ module Dyndnsd
       @db['hosts'] ||= {}
       (@db.save; update) if @db.changed?
     end
-    
+
     def update
       @updater.update(@db)
     end
-    
+
     def is_fqdn_valid?(hostname)
       return false if hostname.length < @domain.length + 2
       return false if not hostname.end_with?(@domain)
@@ -56,45 +56,68 @@ module Dyndnsd
       return false if not name.match(/^[a-zA-Z0-9_-]+\.$/)
       true
     end
-    
+
     def call(env)
       return @responder.response_for_error(:method_forbidden) if env["REQUEST_METHOD"] != "GET"
       return @responder.response_for_error(:not_found) if env["PATH_INFO"] != "/nic/update"
-      
+
       params = Rack::Utils.parse_query(env["QUERY_STRING"])
-      
+
       return @responder.response_for_error(:hostname_missing) if not params["hostname"]
-      
+
       hostnames = params["hostname"].split(',')
-      
+
       # Check if hostname match rules
       hostnames.each do |hostname|
         return @responder.response_for_error(:hostname_malformed) if not is_fqdn_valid?(hostname)
       end
-      
+
       user = env["REMOTE_USER"]
-      
+
       hostnames.each do |hostname|
         return @responder.response_for_error(:host_forbidden) if not @users[user]['hosts'].include? hostname
       end
 
-      # no myip?
-      if not params["myip"]
-        params["myip"] = env["REMOTE_ADDR"]
+      myip = nil
+
+      if params.has_key?("myip6")
+        # require presence of myip parameter as valid IPAddr (v4) and valid myip6
+        return @responder.response_for_error(:host_forbidden) if not params["myip"]
+        begin
+          IPAddr.new(params["myip"], Socket::AF_INET)
+          IPAddr.new(params["myip6"], Socket::AF_INET6)
+          
+          # myip will be an array
+          myip = [params["myip"], params["myip6"]]
+        rescue ArgumentError
+          return @responder.response_for_error(:host_forbidden)
+        end
+      else
+        # fallback value, always present
+        myip = env["REMOTE_ADDR"]
+
+        # check whether X-Real-IP header has valid IPAddr
+        if env.has_key?("HTTP_X_REAL_IP")
+          begin
+            IPAddr.new(env["HTTP_X_REAL_IP"])
+            myip = env["HTTP_X_REAL_IP"]
+          rescue ArgumentError
+          end
+        end
+
+        # check whether myip parameter has valid IPAddr
+        if params.has_key?("myip")
+          begin
+            IPAddr.new(params["myip"])
+            myip = params["myip"]
+          rescue ArgumentError
+          end
+        end
       end
-      
-      # malformed myip?
-      begin
-        IPAddr.new(params["myip"], Socket::AF_INET)
-      rescue ArgumentError
-        params["myip"] = env["REMOTE_ADDR"]
-      end
-      
-      myip = params["myip"]
-      
+
       Metriks.meter('requests.valid').mark
       Dyndnsd.logger.info "Request to update #{hostnames} to #{myip} for user #{user}"
-      
+
       changes = []
       hostnames.each do |hostname|
         if (not @db['hosts'].include? hostname) or (@db['hosts'][hostname] != myip)
@@ -106,7 +129,7 @@ module Dyndnsd
           Metriks.meter('requests.nochg').mark
         end
       end
-      
+
       if @db.changed?
         @db['serial'] += 1
         Dyndnsd.logger.info "Committing update ##{@db['serial']}"
@@ -114,7 +137,7 @@ module Dyndnsd
         update
         Metriks.meter('updates.committed').mark
       end
-      
+
       @responder.response_for_changes(changes, myip)
     end
 
@@ -130,23 +153,23 @@ module Dyndnsd
         puts "Config file not found!"
         exit 1
       end
-      
+
       puts "DynDNSd version #{Dyndnsd::VERSION}"
       puts "Using config file #{config_file}"
 
       config = YAML::load(File.open(config_file, 'r') { |f| f.read })
-      
+
       if config['logfile']
         Dyndnsd.logger = Logger.new(config['logfile'])
       else
         Dyndnsd.logger = Logger.new(STDOUT)
       end
-      
+
       Dyndnsd.logger.progname = "dyndnsd"
       Dyndnsd.logger.formatter = LogFormatter.new
 
       Dyndnsd.logger.info "Starting..."
-      
+
       # drop privs (first change group than user)
       Process::Sys.setgid(Etc.getgrnam(config['group']).gid) if config['group']
       Process::Sys.setuid(Etc.getpwnam(config['user']).uid) if config['user']
@@ -174,7 +197,7 @@ module Dyndnsd
       db = Database.new(config['db'])
       updater = Updater::CommandWithBindZone.new(config['domain'], config['updater']['params']) if config['updater']['name'] == 'command_with_bind_zone'
       responder = Responder::DynDNSStyle.new
-      
+
       # configure rack
       app = Daemon.new(config, db, updater, responder)
       app = Rack::Auth::Basic.new(app, "DynDNS") do |user,pass|

lib/dyndnsd/generator/bind.rb

@@ -18,9 +18,13 @@ module Dyndnsd
         out << "@ IN SOA #{@dns} #{@email_addr} ( #{zone['serial']} 3h 5m 1w 1h )"
         out << "@ IN NS #{@dns}"
         out << ""
-        zone['hosts'].each do |hostname,ip|
-          name = hostname.chomp('.' + @domain)
-          out << "#{name} IN A #{ip}"
+        zone['hosts'].each do |hostname,ips|
+          (ips.is_a?(Array) ? ips : [ips]).each do |ip|
+            ip = IPAddr.new(ip).native
+            type = ip.ipv6? ? "AAAA" : "A"
+            name = hostname.chomp('.' + @domain)
+            out << "#{name} IN #{type} #{ip}"
+          end
         end
         out << ""
         out << @additional_zone_content

lib/dyndnsd/responder/dyndns_style.rb

@@ -11,9 +11,9 @@ module Dyndnsd
         return [200, {"Content-Type" => "text/plain"}, ["nohost"]] if state == :host_forbidden
         return [200, {"Content-Type" => "text/plain"}, ["notfqdn"]] if state == :hostname_malformed
       end
-      
+
       def response_for_changes(states, ip)
-        body = states.map { |state| "#{state} #{ip}" }.join("\n")
+        body = states.map { |state| "#{state} #{ip.is_a?(Array) ? ip.join(' ') : ip}" }.join("\n")
         return [200, {"Content-Type" => "text/plain"}, [body]]
       end
     end

lib/dyndnsd/responder/rest_style.rb

@@ -11,9 +11,9 @@ module Dyndnsd
         return [403, {"Content-Type" => "text/plain"}, ["Forbidden"]] if state == :host_forbidden
         return [422, {"Content-Type" => "text/plain"}, ["Hostname malformed"]] if state == :hostname_malformed
       end
-      
+
       def response_for_changes(states, ip)
-        body = states.map { |state| state == :good ? "Changed to #{ip}" : "No change needed for #{ip}" }.join("\n")
+        body = states.map { |state| state == :good ? "Changed to #{ip.is_a?(Array) ? ip.join(' ') : ip}" : "No change needed for #{ip.is_a?(Array) ? ip.join(' ') : ip}" }.join("\n")
         return [200, {"Content-Type" => "text/plain"}, [body]]
       end
     end

lib/dyndnsd/version.rb

@@ -1,4 +1,4 @@
 
 module Dyndnsd
-  VERSION = "1.3.0"
+  VERSION = "1.6.0"
 end

spec/daemon_spec.rb

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe Dyndnsd::Daemon do
   include Rack::Test::Methods
-  
+
   def app
     Dyndnsd.logger = Logger.new(STDOUT)
     Dyndnsd.logger.level = Logger::UNKNOWN
-    
+
     config = {
       'domain' => 'example.org',
       'users' => {
@@ -20,123 +20,187 @@ describe Dyndnsd::Daemon do
     updater = Dyndnsd::Updater::Dummy.new
     responder = Dyndnsd::Responder::DynDNSStyle.new
     app = Dyndnsd::Daemon.new(config, db, updater, responder)
-    
+
     Rack::Auth::Basic.new(app, "DynDNS") do |user,pass|
       (config['users'].has_key? user) and (config['users'][user]['password'] == pass)
     end
   end
-  
+
   it 'requires authentication' do
     get '/'
-    last_response.status.should == 401
-    
+    expect(last_response.status).to eq(401)
+
     pending 'Need to find a way to add custom body on 401 responses'
-    last_response.should be_ok 'badauth'
+    expect(last_response).not_to be_ok
+    expect(last_response.body).to eq('badauth')
   end
-  
+
   it 'only supports GET requests' do
     authorize 'test', 'secret'
     post '/nic/update'
-    last_response.status.should == 405
+    expect(last_response.status).to eq(405)
   end
-  
+
   it 'provides only the /nic/update URL' do
     authorize 'test', 'secret'
     get '/other/url'
-    last_response.status.should == 404
+    expect(last_response.status).to eq(404)
   end
-  
+
   it 'requires the hostname query parameter' do
     authorize 'test', 'secret'
     get '/nic/update'
-    last_response.should be_ok
-    last_response.body.should == 'notfqdn'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('notfqdn')
   end
 
   it 'supports multiple hostnames in request' do
     authorize 'test', 'secret'
+
     get '/nic/update?hostname=foo.example.org,bar.example.org&myip=1.2.3.4'
-    last_response.should be_ok
-    last_response.body.should == "good 1.2.3.4\ngood 1.2.3.4"
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq("good 1.2.3.4\ngood 1.2.3.4")
+
+    get '/nic/update?hostname=foo.example.org,bar.example.org&myip=2001:db8::1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq("good 2001:db8::1\ngood 2001:db8::1")
   end
 
   it 'rejects request if one hostname is invalid' do
     authorize 'test', 'secret'
-    
+
     get '/nic/update?hostname=test'
-    last_response.should be_ok
-    last_response.body.should == 'notfqdn'
-    
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('notfqdn')
+
     get '/nic/update?hostname=test.example.com'
-    last_response.should be_ok
-    last_response.body.should == 'notfqdn'
-    
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('notfqdn')
+
     get '/nic/update?hostname=test.example.org.me'
-    last_response.should be_ok
-    last_response.body.should == 'notfqdn'
-    
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('notfqdn')
+
     get '/nic/update?hostname=foo.test.example.org'
-    last_response.should be_ok
-    last_response.body.should == 'notfqdn'
-    
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('notfqdn')
+
     get '/nic/update?hostname=in%20valid.example.org'
-    last_response.should be_ok
-    last_response.body.should == 'notfqdn'
-    
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('notfqdn')
+
     get '/nic/update?hostname=valid.example.org,in.valid.example.org'
-    last_response.should be_ok
-    last_response.body.should == 'notfqdn'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('notfqdn')
   end
-  
+
   it 'rejects request if user does not own one hostname' do
     authorize 'test', 'secret'
     get '/nic/update?hostname=notmyhost.example.org'
-    last_response.should be_ok
-    last_response.body.should == 'nohost'
-    
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('nohost')
+
     get '/nic/update?hostname=foo.example.org,notmyhost.example.org'
-    last_response.should be_ok
-    last_response.body.should == 'nohost'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('nohost')
   end
-  
-  it 'updates a host on IPv4 change' do
-    authorize 'test', 'secret'
-    
-    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4'
-    last_response.should be_ok
-    
-    get '/nic/update?hostname=foo.example.org&myip=1.2.3.40'
-    last_response.should be_ok
-    last_response.body.should == 'good 1.2.3.40'
-  end
-  
-  it 'returns IPv4 no change' do
-    authorize 'test', 'secret'
-    
-    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4'
-    last_response.should be_ok
-    
-    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4'
-    last_response.should be_ok
-    last_response.body.should == 'nochg 1.2.3.4'
-  end
-  
-  it 'outputs IPv4 status per hostname' do
+
+  it 'updates a host on IP change' do
     authorize 'test', 'secret'
 
     get '/nic/update?hostname=foo.example.org&myip=1.2.3.4'
-    last_response.should be_ok
-    last_response.body.should == 'good 1.2.3.4'
-    
-    get '/nic/update?hostname=foo.example.org,bar.example.org&myip=1.2.3.4'
-    last_response.should be_ok
-    last_response.body.should == "nochg 1.2.3.4\ngood 1.2.3.4"
+    expect(last_response).to be_ok
+
+    get '/nic/update?hostname=foo.example.org&myip=1.2.3.40'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 1.2.3.40')
+
+    get '/nic/update?hostname=foo.example.org&myip=2001:db8::1'
+    expect(last_response).to be_ok
+
+    get '/nic/update?hostname=foo.example.org&myip=2001:db8::10'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 2001:db8::10')
   end
-  
-  it 'uses clients remote IPv4 address if myip not specified' do
+
+  it 'returns IP no change' do
+    authorize 'test', 'secret'
+
+    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4'
+    expect(last_response).to be_ok
+
+    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('nochg 1.2.3.4')
+
+    get '/nic/update?hostname=foo.example.org&myip=2001:db8::1'
+    expect(last_response).to be_ok
+
+    get '/nic/update?hostname=foo.example.org&myip=2001:db8::1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('nochg 2001:db8::1')
+  end
+
+  it 'outputs IP status per hostname' do
+    authorize 'test', 'secret'
+
+    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 1.2.3.4')
+
+    get '/nic/update?hostname=foo.example.org,bar.example.org&myip=1.2.3.4'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq("nochg 1.2.3.4\ngood 1.2.3.4")
+
+    get '/nic/update?hostname=foo.example.org&myip=2001:db8::1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 2001:db8::1')
+
+    get '/nic/update?hostname=foo.example.org,bar.example.org&myip=2001:db8::1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq("nochg 2001:db8::1\ngood 2001:db8::1")
+  end
+
+  it 'uses clients remote IP address if myip not specified' do
     authorize 'test', 'secret'
     get '/nic/update?hostname=foo.example.org'
-    last_response.should be_ok
-    last_response.body.should == 'good 127.0.0.1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 127.0.0.1')
+  end
+
+  it 'uses clients remote IP address from X-Real-IP header if behind proxy' do
+    authorize 'test', 'secret'
+
+    get '/nic/update?hostname=foo.example.org', '', 'HTTP_X_REAL_IP' => '10.0.0.1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 10.0.0.1')
+
+    get '/nic/update?hostname=foo.example.org', '', 'HTTP_X_REAL_IP' => '2001:db8::1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 2001:db8::1')
+  end
+
+  it 'supports an IPv4 and an IPv6 address in one request' do
+    authorize 'test', 'secret'
+
+    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4&myip6=2001:db8::1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq("good 1.2.3.4 2001:db8::1")
+
+    get '/nic/update?hostname=foo.example.org&myip=BROKENIP&myip6=2001:db8::1'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('nohost')
+
+    get '/nic/update?hostname=foo.example.org&myip=1.2.3.4&myip6=BROKENIP'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('nohost')
+
+    get '/nic/update?hostname=foo.example.org&myip6=2001:db8::10'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('nohost')
+
+    get '/nic/update?hostname=foo.example.org&myip=1.2.3.40'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('good 1.2.3.40')
   end
 end