From 6259a980d722ebbf8a9f0b3f7ca1e9461b7caac9 Mon Sep 17 00:00:00 2001 From: Ralf Jung Date: Tue, 6 Jan 2015 21:05:59 +0100 Subject: [PATCH] introduce a configuration file for dyn-ns-client --- client-scripts/dyn-ns-client | 99 ++++++++++++++++++++++-------------- dyn-ns-client.conf.dist | 30 +++++++++++ 2 files changed, 92 insertions(+), 37 deletions(-) create mode 100644 dyn-ns-client.conf.dist diff --git a/client-scripts/dyn-ns-client b/client-scripts/dyn-ns-client index 2a5dc21..af263b7 100755 --- a/client-scripts/dyn-ns-client +++ b/client-scripts/dyn-ns-client @@ -22,27 +22,53 @@ # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #============================================================================== -# configuration variables -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 -#============================================================================== +import urllib.request, socket, sys, argparse, os, configparser, itertools + +def readConfig(fname, defSection = 'DEFAULT'): + config = configparser.ConfigParser() + with open(fname) as file: + stream = itertools.chain(("["+defSection+"]\n",), file) + config.read_file(stream) + return config -import urllib.request, socket, sys, argparse +def getConfigDir(): + try: + from xdg import BaseDirectory + return os.path.join(BaseDirectory.xdg_config_home, "dyn-nsupdate") + except ImportError: + return os.path.expanduser("~/.config/dyn-nsupdate") def urlopen(url): return urllib.request.urlopen(url).read().decode('utf-8').strip() -def getMyIP(server): - return urlopen('https://'+server+'/checkip') +def getMyIP(family, config, methods = {}, verbose = False): + '''Returns our current IP address ( can be "IPv4" or "IPv6"), detected as given by the configuration. + Additional detection methods can be supplied via .''' + method = config[family]['method'] + if method == 'none': + return None + elif method == 'web': + server = config[family].get('server', config['DEFAULT']['server']) + ip = urlopen('https://'+server+'/checkip') + if verbose: + print("Server",server,"says my",family,"is",ip) + return ip + elif method in 'methods': + return methods[method]() + else: + raise Exception("Unsupported "+family+" detection method: "+method) + +def getMyIPv4(config, verbose = False): + '''Returns our current IPv4 address, detected as given by the configuration''' + return getMyIP("IPv4", config, verbose=verbose) + +def getMyIPv6(config, verbose = False): + '''Returns our current IPv6 address, detected as given by the configuration''' + return getMyIP("IPv6", config, verbose=verbose) def getCurIP(domain, family): + '''Return the current IP of the given . can be socket.AF_INET or socket.AF_INET6.''' try: addr = socket.getaddrinfo(domain, None, family=family) return addr[0][4][0] @@ -50,13 +76,17 @@ def getCurIP(domain, family): return "" def getCurIPv4(domain): + '''Returns the current IPv4 address of the given domain''' return getCurIP(domain, socket.AF_INET) def getCurIPv6(domain): + '''Returns the current IPv6 address of the given 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.''' +def updateDomain(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, or strings with the respective addresses. + Updates ae only performed if necessary. + 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 @@ -86,7 +116,7 @@ def update_domain(server, domain, ipv4, ipv6, password, verbose): # did everything go as planned? if result == expected: if verbose: - print("Successfully updated domain",domain) + print("Successfully updated domain",domain,"on",server) # all went all right return True else: @@ -98,34 +128,29 @@ def update_domain(server, domain, ipv4, ipv6, password, verbose): 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("-c", "--config", + dest="config", default=os.path.join(getConfigDir(), "dyn-ns-client.conf"), + help="The configuration file") 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() + + # read config + if not os.path.isfile(args.config): + raise Exception("The config file does not exist: "+args.config) + config = readConfig(args.config) - # 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 + # get our own addresses + myIPv4 = getMyIPv4(config, args.verbose) + myIPv6 = getMyIPv6(config, args.verbose) # update all the domains exitcode = 0 - for domain in args.domains: - if not update_domain(server, domain, myIPv4, myIPv6, args.password, verbose=args.verbose): + domains = map(str.strip, config['DEFAULT']['domains'].split(',')) + if not domains: + raise Exception("No domain given to update!") + for domain in domains: + if not updateDomain(config['DEFAULT']['server'], domain, myIPv4, myIPv6, config['DEFAULT']['password'], verbose=args.verbose): exitcode = 1 sys.exit(exitcode) diff --git a/dyn-ns-client.conf.dist b/dyn-ns-client.conf.dist new file mode 100644 index 0000000..076287c --- /dev/null +++ b/dyn-ns-client.conf.dist @@ -0,0 +1,30 @@ +# The server to send the update requests to +server = ns.example.com +# Domains to update (multiple domains are possible, separated by comma) +domains = test.dyn.example.com +# Password to be sent to the server-side scripts +password = some_secure_password + +[IPv4] +# Possible IPv4 detection methods are +# none: Don't set IPv4 address (leaves the domain's A record untouched). +# web: Call a website to detect the current, external IPv4 address. +method = web + +# The server to query for web-basd IPv4 detection (if enabled). +# Default: same as the global server in the default section. +# This server should NOT have an AAAA record, or it may return the IPv6 address instead! +server = ipv4.ns.example.com + +[IPv6] +# Possible IPv6 detection methods are +# none: Don't set IPv6 address (leaves the domain's AAAA record untouched). +# web: Call a website to detect the current, external IPv6 address. +# local: Try to detect the global IPv6 address based on the configuration of the local network interfaces. +method = none + +# The server to query for web-basd IPv6 detection. +# Default: same as the global server in the default section. +# This server should NOT have an A record, or it may return the IPv4 address instead! +server = ipv6.ns.example.com + -- 2.30.2