client-scripts/dyn-ns-client

   1 #!/usr/bin/python3
   2 # Copyright (c) 2014, Ralf Jung <post@ralfj.de>
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are met:
   7 #
   8 # 1. Redistributions of source code must retain the above copyright notice, this
   9 #    list of conditions and the following disclaimer.
  10 # 2. Redistributions in binary form must reproduce the above copyright notice,
  11 #    this list of conditions and the following disclaimer in the documentation
  12 #    and/or other materials provided with the distribution.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  15 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  16 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  17 # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
  18 # ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  19 # (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  20 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  21 # ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  23 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 #==============================================================================
  25
  26 import urllib.request, socket, sys, argparse, os, configparser, itertools
  27
  28 def readConfig(fname, defSection = 'DEFAULT'):
  29     config = configparser.ConfigParser()
  30     with open(fname) as file:
  31         stream = itertools.chain(("["+defSection+"]\n",), file)
  32         config.read_file(stream)
  33     return config
  34
  35 def getConfigDir():
  36     try:
  37         from xdg import BaseDirectory
  38         return os.path.join(BaseDirectory.xdg_config_home, "dyn-nsupdate")
  39     except ImportError:
  40         return os.path.expanduser("~/.config/dyn-nsupdate")
  41
  42 def urlopen(url):
  43     return urllib.request.urlopen(url).read().decode('utf-8').strip()
  44
  45 def getMyIP(family, config, methods = {}, verbose = False):
  46     '''Returns our current IP address (<family> can be "IPv4" or "IPv6"), detected as given by the configuration.
  47        Additional detection methods can be supplied via <methods>.'''
  48     method = config[family]['method']
  49     if method == 'none':
  50         return None
  51     elif method == 'web':
  52         server = config[family].get('server', config['DEFAULT']['server'])
  53         ip = urlopen('https://'+server+'/checkip')
  54         if verbose:
  55             print("Server",server,"says my",family,"is",ip)
  56         return ip
  57     elif method in 'methods':
  58         return methods[method]()
  59     else:
  60         raise Exception("Unsupported "+family+" detection method: "+method)
  61
  62 def getMyIPv4(config, verbose = False):
  63     '''Returns our current IPv4 address, detected as given by the configuration'''
  64     return getMyIP("IPv4", config, verbose=verbose)
  65
  66 def getMyIPv6(config, verbose = False):
  67     '''Returns our current IPv6 address, detected as given by the configuration'''
  68     return getMyIP("IPv6", config, verbose=verbose)
  69
  70 def getCurIP(domain, family):
  71     '''Return the current IP of the given <domain>. <family> can be socket.AF_INET or socket.AF_INET6.'''
  72     try:
  73         addr = socket.getaddrinfo(domain, None, family=family)
  74         return addr[0][4][0]
  75     except socket.gaierror: # domain not found
  76         return ""
  77
  78 def getCurIPv4(domain):
  79     '''Returns the current IPv4 address of the given domain'''
  80     return getCurIP(domain, socket.AF_INET)
  81
  82 def getCurIPv6(domain):
  83     '''Returns the current IPv6 address of the given domain'''
  84     return getCurIP(domain, socket.AF_INET6)
  85
  86 def updateDomain(server, domain, ipv4, ipv6, password, verbose):
  87     '''Update the given domain, using the server, password. ipv4 or ipv6 can be None to not update that record, or strings with the respective addresses.
  88        Updates ae only performed if necessary.
  89        Returns True on success, False on failure.'''
  90     assert ipv4 is not None or ipv6 is not None
  91
  92     # check what the domain is currently mapped to
  93     curIPv4 = getCurIPv4(domain)
  94     curIPv6 = getCurIPv6(domain)
  95     if verbose:
  96         print("Current status of domain {0} is: IPv4 address '{1}', IPv6 address '{2}'".format(domain, curIPv4, curIPv6))
  97
  98     # check if there's something to do
  99     needUpdate = (ipv4 is not None and curIPv4 != ipv4) or (ipv6 is not None and curIPv6 != ipv6)
 100     if not needUpdate:
 101         if verbose:
 102             print("Everything already up-to-date, nothing to do")
 103         return True
 104
 105     # we need to update the IP
 106     url = 'https://'+server+'/update?password='+urllib.parse.quote(password)+'&domain='+urllib.parse.quote(domain)
 107     expected = "good"
 108     if ipv4 is not None:
 109         url += '&ip='+urllib.parse.quote(ipv4)
 110         expected += " "+ipv4
 111     if ipv6 is not None:
 112         url += '&ipv6='+urllib.parse.quote(ipv6)
 113         expected += " "+ipv6
 114     result = urlopen(url)
 115
 116     # did everything go as planned?
 117     if result == expected:
 118         if verbose:
 119             print("Successfully updated domain",domain,"on",server)
 120         # all went all right
 121         return True
 122     else:
 123         # Something went wrong
 124         print("Unexpected answer from server",server,"while updating",domain)
 125         print(result)
 126         return False
 127
 128 if __name__ == "__main__":
 129     # allow overwriting some values on the command-line
 130     parser = argparse.ArgumentParser(description='Update a domain managed by a dyn-nsupdate server')
 131     parser.add_argument("-c", "--config",
 132                         dest="config", default=os.path.join(getConfigDir(), "dyn-ns-client.conf"),
 133                         help="The configuration file")
 134     parser.add_argument("-v", "--verbose",
 135                         action="store_true", dest="verbose",
 136                         help="Be more verbose")
 137     args = parser.parse_args()
 138
 139     # read config
 140     if not os.path.isfile(args.config):
 141         raise Exception("The config file does not exist: "+args.config)
 142     config = readConfig(args.config)
 143
 144     # get our own addresses
 145     myIPv4 = getMyIPv4(config, args.verbose)
 146     myIPv6 = getMyIPv6(config, args.verbose)
 147
 148     # update all the domains
 149     exitcode = 0
 150     domains = map(str.strip, config['DEFAULT']['domains'].split(','))
 151     if not domains:
 152         raise Exception("No domain given to update!")
 153     for domain in domains:
 154         if not updateDomain(config['DEFAULT']['server'], domain, myIPv4, myIPv6, config['DEFAULT']['password'], verbose=args.verbose):
 155             exitcode = 1
 156     sys.exit(exitcode)