README: fix header line length

[dyn-nsupdate.git] / client-scripts / dyn-ns-client

diff --git a/client-scripts/dyn-ns-client b/client-scripts/dyn-ns-client
index ef0e9b85275782ab4f12df9b6eb09e5d51bcfaf2..0fc88e6fc978f3195f4c2d4b6b4e1740c930fd0d 100755 (executable)
--- a/client-scripts/dyn-ns-client
+++ b/client-scripts/dyn-ns-client
@@ -25,63 +25,111 @@
 # The views and conclusions contained in the software and documentation are those
 # of the authors and should not be interpreted as representing official policies, 
 # either expressed or implied, of the FreeBSD Project.
 # The views and conclusions contained in the software and documentation are those
 # of the authors and should not be interpreted as representing official policies, 
 # either expressed or implied, of the FreeBSD Project.

-
-import urllib.request, socket, sys, argparse
-
+#==============================================================================

 # configuration variables
 # configuration variables

-server = 'ipv4.ns.ralfj.de'
-domains = ['domain.dyn.ralfj.de'] # list of domains to update
-password = 'yourpassword'
+domains = ['test.dyn.example.com'] # list of domains to update
+password = 'some_secure_password'
+haveIPv4 = True
+haveIPv6 = False
+
+serverIPv4 = 'ipv4.ns.example.com' # Only needed if haveIPv4 is True. This server should NOT have an AAAA record!
+serverIPv6 = 'ipv6.ns.example.com' # Only needed if haveIPv6 is True. This server should NOT have an A record!
+server     = 'ns.example.com'

 # END of configuration variables
 # END of configuration variables

+#==============================================================================

 
 

-# allow overwriting some values on the command-line
-parser = argparse.ArgumentParser(description='Update a domain managed by a dyn-nsupdate server')
-parser.add_argument("-s", "--server",
-                    dest="server", default=server,
-                    help="The dyn-nsupdate server")
-parser.add_argument("-p", "--password",
-                    dest="password", default=password,
-                    help="The password used to update the domains")
-parser.add_argument("-v", "--verbose",
-                    action="store_true", dest="verbose",
-                    help="Be more verbose")
-parser.add_argument("domains",  metavar='DOMAIN', nargs='*', default=domains,
-                    help="The domains to update")
-args = parser.parse_args()
+import urllib.request, socket, sys, argparse

 
 def urlopen(url):
     return urllib.request.urlopen(url).read().decode('utf-8').strip()
 
 
 def urlopen(url):
     return urllib.request.urlopen(url).read().decode('utf-8').strip()
 

-myip = urlopen('https://'+args.server+'/checkip')
+def getMyIP(server):
+    return urlopen('https://'+server+'/checkip')

 
 

-def update_domain(domain):
-    '''Update the given domain, using the global server, user, password. Returns True on success, False on failure.'''
-    global myip, args
-    # check if the domain is already mapped to our current IP
+def getCurIP(domain, family):

     try:
     try:

-        domainip = socket.gethostbyname(domain)
-        if myip == domainip:
-            # nothing to do
-            if args.verbose:
-                print("Domain",domain,"already up-to-date, not doing anything")
-            return True
+        addr = socket.getaddrinfo(domain, None, family=family)
+        return addr[0][4][0]

     except socket.gaierror: # domain not found
     except socket.gaierror: # domain not found

-        pass
+        return ""
+
+def getCurIPv4(domain):
+    return getCurIP(domain, socket.AF_INET)
+
+def getCurIPv6(domain):
+    return getCurIP(domain, socket.AF_INET6)
+
+def update_domain(server, domain, ipv4, ipv6, password, verbose):
+    '''Update the given domain, using the server, password. ipv4 or ipv6 can be None to not update that record. Returns True on success, False on failure.'''
+    assert ipv4 is not None or ipv6 is not None
+    
+    # check what the domain is currently mapped to
+    curIPv4 = getCurIPv4(domain)
+    curIPv6 = getCurIPv6(domain)
+    if verbose:
+        print("Current status of domain {0} is: IPv4 address '{1}', IPv6 address '{2}'".format(domain, curIPv4, curIPv6))
+    
+    # check if there's something to do
+    needUpdate = (ipv4 is not None and curIPv4 != ipv4) or (ipv6 is not None and curIPv6 != ipv6)
+    if not needUpdate:
+        if verbose:
+            print("Everything alread up-to-date, nothing to do")
+        return True

 
     # we need to update the IP
 
     # we need to update the IP

-    result = urlopen('https://'+args.server+'/update?password='+urllib.parse.quote(args.password)+'&domain='+urllib.parse.quote(domain)+'&ip='+urllib.parse.quote(myip))
-    if 'good '+myip == result: 
-        print("Successfully updated domain",domain,"to",myip)
+    url = 'https://'+server+'/update?password='+urllib.parse.quote(password)+'&domain='+urllib.parse.quote(domain)
+    expected = "good"
+    if ipv4 is not None:
+        url += '&ip='+urllib.parse.quote(ipv4)
+        expected += " "+ipv4
+    if ipv6 is not None:
+        url += '&ipv6='+urllib.parse.quote(ipv6)
+        expected += " "+ipv6
+    result = urlopen(url)
+    
+    # did everything go as planned?
+    if result == expected:
+        if verbose:
+            print("Successfully updated domain",domain)

         # all went all right
         return True
     else:
         # Something went wrong
         # all went all right
         return True
     else:
         # Something went wrong

-        print("Unexpected answer from server",server,"while updating",domain,"to",myip)
+        print("Unexpected answer from server",server,"while updating",domain)

         print(result)
         return False
 
         print(result)
         return False
 

-exitcode = 0
-for domain in args.domains:
-    if not update_domain(domain):
-        exitcode = 1
-sys.exit(exitcode)
+if __name__ == "__main__":
+    # allow overwriting some values on the command-line
+    parser = argparse.ArgumentParser(description='Update a domain managed by a dyn-nsupdate server')
+    parser.add_argument("-p", "--password",
+                        dest="password", default=password,
+                        help="The password used to update the domains")
+    parser.add_argument("-v", "--verbose",
+                        action="store_true", dest="verbose",
+                        help="Be more verbose")
+    parser.add_argument("domains",  metavar='DOMAIN', nargs='*', default=domains,
+                        help="The domains to update")
+    args = parser.parse_args()
+
+    # get our own IPv4
+    if haveIPv4:
+        myIPv4 = getMyIP(serverIPv4)
+        if args.verbose:
+            print("My IPv4 is",myIPv4)
+    else:
+        myIPv4 = None
+    # and IPv6
+    if haveIPv6:
+        myIPv6 = getMyIP(serverIPv6)
+        if args.verbose:
+            print("My IPv6 is",myIPv6)
+    else:
+        myIPv6 = None
+
+    # update all the domains
+    exitcode = 0
+    for domain in args.domains:
+        if not update_domain(server, domain, myIPv4, myIPv6, args.password, verbose=args.verbose):
+            exitcode = 1
+    sys.exit(exitcode)