2 # Copyright (c) 2014, Ralf Jung <post@ralfj.de>
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions are met:
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.
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 #==============================================================================
26 import urllib.request, socket, sys, argparse, os, configparser, itertools, subprocess, re, ssl
31 def sslContext(config):
32 if config['DEFAULT'].get('ssl_check_cert', 'yes').lower() in ('0', 'false', 'no'):
33 context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
38 def readConfig(fname, defSection = 'DEFAULT'):
39 config = configparser.ConfigParser()
40 with open(fname) as file:
41 stream = itertools.chain(("["+defSection+"]\n",), file)
42 config.read_file(stream)
47 from xdg import BaseDirectory
48 return os.path.join(BaseDirectory.xdg_config_home, "dyn-nsupdate")
50 return os.path.expanduser("~/.config/dyn-nsupdate")
52 def urlopen(url, config):
53 if sys.version_info >= (3, 4, 3):
54 return urllib.request.urlopen(url, context=sslContext(config)).read().decode('utf-8').strip()
56 return urllib.request.urlopen(url).read().decode('utf-8').strip()
58 def getMyIP(family, config, methods = {}, verbose = 0):
59 '''Returns our current IP address (<family> can be "IPv4" or "IPv6"), detected as given by the configuration.
60 Additional detection methods can be supplied via <methods>.'''
61 method = config[family]['method']
65 server = config[family].get('server', config['DEFAULT']['server'])
66 ip = urlopen('https://'+server+'/checkip', config)
67 if verbose >= VERBOSE_FULL:
68 print("Server",server,"says my",family,"is",ip)
70 elif method in methods:
71 return methods[method]()
73 raise Exception("Unsupported "+family+" detection method: "+method)
75 def getMyIPv4(config, verbose = 0):
76 '''Returns our current IPv4 address, detected as given by the configuration'''
77 return getMyIP("IPv4", config, verbose=verbose)
79 def getMyIPv6(config, verbose = 0):
80 '''Returns our current IPv6 address, detected as given by the configuration'''
82 out = subprocess.check_output(["ip", "addr"])
83 for line in out.decode('utf-8').split('\n'):
84 m = re.search('inet6 ([a-fA-F0-9:]+)/64 ([a-zA-Z0-9 ]*)', line)
87 flags = m.group(2).split()
88 if not 'temporary' in flags and not 'deprecated' in flags and not "link" in flags:
89 if verbose >= VERBOSE_FULL:
90 print("Local IPv6 detected to be",ip)
92 raise Exception("Unable to detect correct local IPv6 address")
93 return getMyIP("IPv6", config, methods={'local': local}, verbose=verbose)
95 def getCurIP(domain, family):
96 '''Return the current IP of the given <domain>. <family> can be socket.AF_INET or socket.AF_INET6.'''
98 addr = socket.getaddrinfo(domain, None, family=family)
100 except socket.gaierror: # domain not found
103 def getCurIPv4(domain):
104 '''Returns the current IPv4 address of the given domain'''
105 return getCurIP(domain, socket.AF_INET)
107 def getCurIPv6(domain):
108 '''Returns the current IPv6 address of the given domain'''
109 return getCurIP(domain, socket.AF_INET6)
111 def updateDomain(server, domain, ipv4, ipv6, password, config, verbose):
112 '''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.
113 Updates ae only performed if necessary.
114 Returns True on success, False on failure.'''
115 assert ipv4 is not None or ipv6 is not None
117 # check what the domain is currently mapped to
118 curIPv4 = getCurIPv4(domain)
119 curIPv6 = getCurIPv6(domain)
120 if verbose >= VERBOSE_FULL:
121 print("Current status of domain {} is: IPv4 address '{}', IPv6 address '{}'".format(domain, curIPv4, curIPv6))
123 # check if there's something to do
124 needUpdate = (ipv4 is not None and curIPv4 != ipv4) or (ipv6 is not None and curIPv6 != ipv6)
126 if verbose >= VERBOSE_FULL:
127 print("Everything already up-to-date, nothing to do")
130 # we need to update the IP
131 url = 'https://'+server+'/update?password='+urllib.parse.quote(password)+'&domain='+urllib.parse.quote(domain)
134 url += '&ip='+urllib.parse.quote(ipv4)
137 url += '&ipv6='+urllib.parse.quote(ipv6)
139 result = urlopen(url, config)
141 # did everything go as planned?
142 if result == expected:
143 if verbose >= VERBOSE_CHANGE:
144 msg = "Successfully updated domain {} on {}:".format(domain, server)
146 msg += " IPv4={} -> {}".format(curIPv4, ipv4)
148 msg += " IPv6={} -> {}".format(curIPv6, ipv6)
153 # Something went wrong
154 print("Unexpected answer from server",server,"while updating",domain)
158 if __name__ == "__main__":
159 # allow overwriting some values on the command-line
160 parser = argparse.ArgumentParser(description='Update a domain managed by a dyn-nsupdate server')
161 parser.add_argument("-c", "--config",
162 dest="config", default=os.path.join(getConfigDir(), "dyn-ns-client.conf"),
163 help="The configuration file")
164 parser.add_argument("-v", "--verbose",
165 action="count", dest="verbose",
166 help="Be more verbose")
167 args = parser.parse_args()
170 if not os.path.isfile(args.config):
171 raise Exception("The config file does not exist: "+args.config)
172 config = readConfig(args.config)
174 # get our own addresses
175 myIPv4 = getMyIPv4(config, args.verbose)
176 myIPv6 = getMyIPv6(config, args.verbose)
178 # update all the domains
180 domains = map(str.strip, config['DEFAULT']['domains'].split(','))
182 raise Exception("No domain given to update!")
183 for domain in domains:
184 if not updateDomain(config['DEFAULT']['server'], domain, myIPv4, myIPv6, config['DEFAULT']['password'], config, verbose=args.verbose):