update docs after renames

[toast/tdyndns.git] / cgi-bin / dyndns.py

diff --git a/cgi-bin/dyndns.py b/cgi-bin/dyndns.py
index 04e18f99e19b6a76b017af59fba452b38f4d9ec8..5cbf1cee2d2ece5b71606fe3a94f0c478a111abf 100755 (executable)
--- a/cgi-bin/dyndns.py
+++ b/cgi-bin/dyndns.py
@@ -1,18 +1,18 @@
 #!/usr/bin/python2.7
 """Dynamic DNS script. Expects URLs from routers in the form
-http://dyndns.colgarra.priv.at/nic/update??username=<username>&password=<pass>&hostname=<domain>&myip=<ipaddr>
+http://dyndns.colgarra.priv.at/nic/update?username=<username>&password=<pass>&hostname=<domain>&myip=<ipaddr>
 """
-
+import os
 import re
 import cgi
 import pwd
+import base64
 from subprocess import call
 import ipaddr
 
 
 # Configuration
 PASSWORD = 'hygCithOrs5'
-ZONE = '.dyn.colgarra.priv.at'
 DEBUG = False
 
 
@@ -22,22 +22,6 @@ if DEBUG:
        cgitb.enable()
 
 
-fields = cgi.FieldStorage()
-
-# the following fields are supported by most dyndns providers
-# if a parameter is not provided, the .getvalue method returns None
-username = fields.getvalue('username')
-password = fields.getvalue('password')
-hostname = fields.getvalue('hostname')
-myip     = fields.getvalue('myip')
-wildcard = fields.getvalue('wildcard')
-mx       = fields.getvalue('mx')
-backmx   = fields.getvalue('backmx')
-offline  = fields.getvalue('offline')
-system   = fields.getvalue('system')
-url      = fields.getvalue('url')
-
-
 # Base class for our exceptions
 class DynDnsError(Exception):
        pass
@@ -45,6 +29,9 @@ class DynDnsError(Exception):
 class AuthError(DynDnsError):
        returncode = 'badauth'
 
+class CredentialsMissing(AuthError):
+       pass
+
 class UsernameMissing(AuthError):
        pass
 
@@ -57,6 +44,12 @@ class PasswordMissing(AuthError):
 class PasswordWrong(AuthError):
        pass
 
+class AuthWrongMethod(AuthError):
+       returncode = 'wrongauthmethod' # not documented at dyn.com
+
+class AuthBasicError(AuthError):
+       returncode = 'authbasicerror' # not documented at dyn.com
+
 class HostnameError(DynDnsError):
        returncode = 'notfqdn'
 
@@ -78,7 +71,47 @@ class MyipInvalid(MyipError):
 class OfflineInvalid(DynDnsError):
        returncode = 'badparam' # not documented at dyn.com
 
+class NsupdateError(DynDnsError):
+       returncode = 'nohost'
+
+
+fields = cgi.FieldStorage()
+
+# the following fields are supported by most dyndns providers
+# if a parameter is not provided, the .getvalue method returns None
+username = fields.getvalue('username')
+password = fields.getvalue('password')
+hostname = fields.getvalue('hostname')
+myip     = fields.getvalue('myip')
+wildcard = fields.getvalue('wildcard')
+mx       = fields.getvalue('mx')
+backmx   = fields.getvalue('backmx')
+offline  = fields.getvalue('offline')
+system   = fields.getvalue('system')
+url      = fields.getvalue('url')
+
+
 try:
+       # Optional Auth Basic
+       auth = os.environ.get('HTTP_AUTHORIZATION') # auth == 'Basic cGhpbGlwcDpka2ZhamRrZg=='
+       if auth: # empty string if HTTP_AUTHORIZATION not present
+               auth_parts = auth.split(' ')
+               auth_method = 'Basic'
+               if len(auth_parts) != 2 or auth_parts[0] != auth_method:
+                       raise AuthWrongMethod()
+               try:
+                       auth_decoded = base64.b64decode(auth_parts[1]) # auth_decoded == 'philipp:dkfajdkf'
+               except TypeError:
+                       raise AuthBasicError()
+               auth_decoded_parts = auth_decoded.split(':')
+               if len(auth_decoded_parts) != 2:
+                       raise AuthBasicError()
+               username, password = auth_decoded_parts
+
+       # check username and password
+       if username is None and password is None:
+               raise CredentialsMissing()
+
        # check username
        if username is None:
                raise UsernameMissing()
@@ -103,8 +136,6 @@ try:
 
        # strip zone
        hostname = hostname.strip()
-       if hostname.endswith(ZONE):
-               hostname = hostname[:-len(ZONE)]
 
        # check offline
        if offline is None or offline.lower() == 'no':
@@ -117,24 +148,29 @@ try:
        # check IP address
        if not offline:
                if myip is None:
-                       raise MyipMissing()
+                       # try HTTP_X_FORWARDED_FOR
+                       myip = os.environ.get('HTTP_X_FORWARDED_FOR')
+                       if not myip: # empty string if not present
+                               # try REMOTE_ADDR
+                               myip = os.environ.get('REMOTE_ADDR')
+                               if not myip: # empty string if not present
+                                       raise MyipMissing()
+       if not myip is None:
                try:
-                       ip = ipaddr.IPAddress(myip) # throws an exception if the IP address is not valid
+                       ipaddr.IPAddress(myip) # throws an exception if the IP address is not valid
                except ValueError:
                        raise MyipInvalid()
-               if isinstance(ip, ipaddr.IPv4Address):
-                       iptype = 'A'
-               elif isinstance(ip, ipaddr.IPv6Address):
-                       iptype = 'AAAA'
-               else:
-                       raise MyipInvalid() # should never happen
 
        # update bind
+       call_params = ['sudo', 'nsupdate_dyndns']
        if offline:
-               call(['sudo', '/usr/local/bin/nsupdate_dyndns_del', hostname, 'A'])
-               call(['sudo', '/usr/local/bin/nsupdate_dyndns_del', hostname, 'AAAA'])
-       else:
-               call(['sudo', '/usr/local/bin/nsupdate_dyndns', hostname, myip, iptype])
+               call_params.append('--delete')
+       if myip is not None:
+               call_params.extend(['--ip', myip])
+       call_params.append(hostname)
+       retcode = call(call_params)
+       if retcode != 0:
+               raise NsupdateError()
 
        # return success
        print "Content-Type: text/html"
@@ -143,9 +179,15 @@ try:
        # Note: we should return 'nochg' in case the IP has not changed, however we don't know yet.
 
 
+except CredentialsMissing as error:
+       print "Content-Type: text/html"
+       print "Status: 401 Unauthorized"
+       print "WWW-Authenticate: Basic realm='tdyndns'"
+       print
+
 except DynDnsError as error:
        print "Content-Type: text/html"
-       print "Status: 200"
+       print "Status: 200 OK"
        print
        print error.returncode