fix typo in README
[dyn-nsupdate.git] / client-scripts / dyn-ns-client
1 #!/usr/bin/env 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, subprocess, re, ssl
27
28 VERBOSE_CHANGE = 1
29 VERBOSE_FULL   = 2
30
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)
34         return context
35     else:
36         return None
37
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)
43     return config
44
45 def getConfigDir():
46     try:
47         from xdg import BaseDirectory
48         return os.path.join(BaseDirectory.xdg_config_home, "dyn-nsupdate")
49     except ImportError:
50         return os.path.expanduser("~/.config/dyn-nsupdate")
51
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()
55     else:
56         return urllib.request.urlopen(url).read().decode('utf-8').strip()
57
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']
62     if method == 'none':
63         return None
64     elif method == 'web':
65         server = config[family].get('server', config['DEFAULT']['server'])
66         url = 'https://'+server+'/checkip'
67         try:
68             ip = urlopen(url, config)
69         except urllib.error.URLError:
70             raise Exception("Error fetching {}, make sure the URL is correct and the internet connection actually works.".format(url))
71         if verbose >= VERBOSE_FULL:
72             print("Server",server,"says my",family,"is",ip)
73         return ip
74     elif method in methods:
75         return methods[method]()
76     else:
77         raise Exception("Unsupported "+family+" detection method: "+method)
78
79 def getMyIPv4(config, verbose = 0):
80     '''Returns our current IPv4 address, detected as given by the configuration'''
81     return getMyIP("IPv4", config, verbose=verbose)
82
83 def getMyIPv6(config, verbose = 0):
84     '''Returns our current IPv6 address, detected as given by the configuration'''
85     def local():
86         out = subprocess.check_output(["ip", "addr"])
87         for line in out.decode('utf-8').split('\n'):
88             m = re.search('inet6 ([a-fA-F0-9:]+)/64 ([a-zA-Z0-9 ]*)', line)
89             if m is not None:
90                 ip = m.group(1)
91                 flags = m.group(2).split()
92                 if not 'temporary' in flags and not 'deprecated' in flags and not "link" in flags:
93                     if verbose >= VERBOSE_FULL:
94                         print("Local IPv6 detected to be",ip)
95                     return ip
96         raise Exception("Unable to detect correct local IPv6 address")
97     return getMyIP("IPv6", config, methods={'local': local}, verbose=verbose)
98
99 def getCurIP(domain, family):
100     '''Return the current IP of the given <domain>. <family> can be socket.AF_INET or socket.AF_INET6.'''
101     try:
102         addr = socket.getaddrinfo(domain, None, family=family)
103         return addr[0][4][0]
104     except socket.gaierror: # domain not found
105         return ""
106
107 def getCurIPv4(domain):
108     '''Returns the current IPv4 address of the given domain'''
109     return getCurIP(domain, socket.AF_INET)
110
111 def getCurIPv6(domain):
112     '''Returns the current IPv6 address of the given domain'''
113     return getCurIP(domain, socket.AF_INET6)
114
115 def updateDomain(server, domain, ipv4, ipv6, password, config, verbose):
116     '''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.
117        Updates ae only performed if necessary.
118        Returns True on success, False on failure.'''
119     assert ipv4 is not None or ipv6 is not None
120     
121     # check what the domain is currently mapped to
122     curIPv4 = getCurIPv4(domain)
123     curIPv6 = getCurIPv6(domain)
124     if verbose >= VERBOSE_FULL:
125         print("Current status of domain {} is: IPv4 address '{}', IPv6 address '{}'".format(domain, curIPv4, curIPv6))
126     
127     # check if there's something to do
128     needUpdate = (ipv4 is not None and curIPv4 != ipv4) or (ipv6 is not None and curIPv6 != ipv6)
129     if not needUpdate:
130         if verbose >= VERBOSE_FULL:
131             print("Everything already up-to-date, nothing to do")
132         return True
133
134     # we need to update the IP
135     url = 'https://'+server+'/update?password='+urllib.parse.quote(password)+'&domain='+urllib.parse.quote(domain)
136     expected = "good"
137     if ipv4 is not None:
138         url += '&ip='+urllib.parse.quote(ipv4)
139         expected += " "+ipv4
140     if ipv6 is not None:
141         url += '&ipv6='+urllib.parse.quote(ipv6)
142         expected += " "+ipv6
143     result = urlopen(url, config)
144     
145     # did everything go as planned?
146     if result == expected:
147         if verbose >= VERBOSE_CHANGE:
148             msg = "Successfully updated domain {} on {}:".format(domain, server)
149             if ipv4 is not None:
150                 if curIPv4 == ipv4:
151                     msg += " IPv4={} (unchanged)".format(curIPv4)
152                 else:
153                     msg += " IPv4={} -> {}".format(curIPv4, ipv4)
154             if ipv6 is not None:
155                 if curIPv6 == ipv6:
156                     msg += " IPv6={} (unchanged)".format(curIPv6)
157                 else:
158                     msg += " IPv6={} -> {}".format(curIPv6, ipv6)
159             print(msg)
160         # all went all right
161         return True
162     else:
163         # Something went wrong
164         print("Unexpected answer from server",server,"while updating",domain)
165         print(result)
166         return False
167
168 if __name__ == "__main__":
169     # allow overwriting some values on the command-line
170     parser = argparse.ArgumentParser(description='Update a domain managed by a dyn-nsupdate server')
171     parser.add_argument("-c", "--config",
172                         dest="config", default=os.path.join(getConfigDir(), "dyn-ns-client.conf"),
173                         help="The configuration file")
174     parser.add_argument("-v", "--verbose",
175                         action="count", dest="verbose", default=0,
176                         help="Be more verbose")
177     args = parser.parse_args()
178     
179     # read config
180     if not os.path.isfile(args.config):
181         raise Exception("The config file does not exist: "+args.config)
182     config = readConfig(args.config)
183
184     # get our own addresses
185     myIPv4 = getMyIPv4(config, args.verbose)
186     myIPv6 = getMyIPv6(config, args.verbose)
187
188     # update all the domains
189     exitcode = 0
190     domains = map(str.strip, config['DEFAULT']['domains'].split(','))
191     if not domains:
192         raise Exception("No domain given to update!")
193     for domain in domains:
194         if not updateDomain(config['DEFAULT']['server'], domain, myIPv4, myIPv6, config['DEFAULT']['password'], config, verbose=args.verbose):
195             exitcode = 1
196     sys.exit(exitcode)