Allow dyndnsd to use address from X-Real-IP

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,14 @@ 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
+
 ### 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.

lib/dyndnsd.rb

@@ -78,19 +78,26 @@ module Dyndnsd
         return @responder.response_for_error(:host_forbidden) if not @users[user]['hosts'].include? hostname
       end
 
-      # no myip?
+      # fallback value, always present
-      if not params["myip"]
+      myip = env["REMOTE_ADDR"]
-        params["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
 
-      # malformed myip?
+      # check whether myip parameter has valid IPAddr
+      if params.has_key?("myip")
         begin
           IPAddr.new(params["myip"])
-      rescue ArgumentError
-        params["myip"] = env["REMOTE_ADDR"]
-      end
-      
           myip = params["myip"]
+        rescue ArgumentError
+        end
+      end
 
       Metriks.meter('requests.valid').mark
       Dyndnsd.logger.info "Request to update #{hostnames} to #{myip} for user #{user}"

spec/daemon_spec.rb

@@ -166,4 +166,11 @@ describe Dyndnsd::Daemon do
     last_response.should be_ok
     last_response.body.should == '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'
+    last_response.should be_ok
+    last_response.body.should == 'good 10.0.0.1'
+  end
 end

spec/spec_helper.rb

@@ -6,3 +6,7 @@ require 'rack/test'
 require 'dyndnsd'
 require 'support/dummy_database'
 require 'support/dummy_updater'
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+end