X-Git-Url: http://git.ipfire.org/?p=ddns.git;a=blobdiff_plain;f=src%2Fddns%2Fproviders.py;h=828787872c185f50dd4766f17c7f1a41dfc3f91b;hp=bc16c4c849913dfb75b4f709fe6c1b2540ba3d0e;hb=9db9ea2539cfdeac4d12efad06156d34cf87bba1;hpb=a892c5946a07cb8f94ce1c39918859c37cfaeb21 diff --git a/src/ddns/providers.py b/src/ddns/providers.py index bc16c4c..8287878 100644 --- a/src/ddns/providers.py +++ b/src/ddns/providers.py @@ -2,7 +2,7 @@ ############################################################################### # # # ddns - A dynamic DNS client for IPFire # -# Copyright (C) 2012 IPFire development team # +# Copyright (C) 2012-2017 IPFire development team # # # # This program is free software: you can redistribute it and/or modify # # it under the terms of the GNU General Public License as published by # @@ -19,7 +19,9 @@ # # ############################################################################### +import datetime import logging +import os import subprocess import urllib2 import xml.dom.minidom @@ -57,6 +59,18 @@ class DDNSProvider(object): DEFAULT_SETTINGS = {} + # holdoff time - Number of days no update is performed unless + # the IP address has changed. + holdoff_days = 30 + + # holdoff time for update failures - Number of days no update + # is tried after the last one has failed. + holdoff_failure_days = 0.5 + + # True if the provider is able to remove records, too. + # Required to remove AAAA records if IPv6 is absent again. + can_remove_records = True + # Automatically register all providers. class __metaclass__(type): def __init__(provider, name, bases, dict): @@ -75,6 +89,14 @@ class DDNSProvider(object): _providers[provider.handle] = provider + @staticmethod + def supported(): + """ + Should be overwritten to check if the system the code is running + on has all the required tools to support this provider. + """ + return True + def __init__(self, core, **settings): self.core = core @@ -89,6 +111,10 @@ class DDNSProvider(object): def __cmp__(self, other): return cmp(self.hostname, other.hostname) + @property + def db(self): + return self.core.db + def get(self, key, default=None): """ Get a setting from the settings dictionary. @@ -127,18 +153,117 @@ class DDNSProvider(object): if force: logger.debug(_("Updating %s forced") % self.hostname) - # Check if we actually need to update this host. - elif self.is_uptodate(self.protocols): - logger.debug(_("%s is already up to date") % self.hostname) + # Do nothing if the last update has failed or no update is required + elif self.has_failure or not self.requires_update: return # Execute the update. - self.update() + try: + self.update() + + # 1) Catch network errors early, because we do not want to log + # them to the database. They are usually temporary and caused + # by the client side, so that we will retry quickly. + # 2) If there is an internet server error (HTTP code 500) on the + # provider's site, we will not log a failure and try again + # shortly. + except (DDNSNetworkError, DDNSInternalServerError): + raise + + # In case of any errors, log the failed request and + # raise the exception. + except DDNSError as e: + self.core.db.log_failure(self.hostname, e) + raise + + logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \ + { "hostname" : self.hostname, "provider" : self.name }) + self.core.db.log_success(self.hostname) def update(self): + for protocol in self.protocols: + if self.have_address(protocol): + self.update_protocol(protocol) + elif self.can_remove_records: + self.remove_protocol(protocol) + + def update_protocol(self, proto): raise NotImplementedError - def is_uptodate(self, protos): + def remove_protocol(self, proto): + if not self.can_remove_records: + raise RuntimeError, "can_remove_records is enabled, but remove_protocol() not implemented" + + raise NotImplementedError + + @property + def requires_update(self): + # If the IP addresses have changed, an update is required + if self.ip_address_changed(self.protocols): + logger.debug(_("An update for %(hostname)s (%(provider)s)" + " is performed because of an IP address change") % \ + { "hostname" : self.hostname, "provider" : self.name }) + + return True + + # If the holdoff time has expired, an update is required, too + if self.holdoff_time_expired(): + logger.debug(_("An update for %(hostname)s (%(provider)s)" + " is performed because the holdoff time has expired") % \ + { "hostname" : self.hostname, "provider" : self.name }) + + return True + + # Otherwise, we don't need to perform an update + logger.debug(_("No update required for %(hostname)s (%(provider)s)") % \ + { "hostname" : self.hostname, "provider" : self.name }) + + return False + + @property + def has_failure(self): + """ + Returns True when the last update has failed and no retry + should be performed, yet. + """ + last_status = self.db.last_update_status(self.hostname) + + # Return False if the last update has not failed. + if not last_status == "failure": + return False + + # If there is no holdoff time, we won't update ever again. + if self.holdoff_failure_days is None: + logger.warning(_("An update has not been performed because earlier updates failed for %s") \ + % self.hostname) + logger.warning(_("There will be no retries")) + + return True + + # Determine when the holdoff time ends + last_update = self.db.last_update(self.hostname, status=last_status) + holdoff_end = last_update + datetime.timedelta(days=self.holdoff_failure_days) + + now = datetime.datetime.utcnow() + if now < holdoff_end: + failure_message = self.db.last_update_failure_message(self.hostname) + + logger.warning(_("An update has not been performed because earlier updates failed for %s") \ + % self.hostname) + + if failure_message: + logger.warning(_("Last failure message:")) + + for line in failure_message.splitlines(): + logger.warning(" %s" % line) + + logger.warning(_("Further updates will be withheld until %s") % holdoff_end) + + return True + + return False + + def ip_address_changed(self, protos): """ Returns True if this host is already up to date and does not need to change the IP address on the @@ -146,18 +271,53 @@ class DDNSProvider(object): """ for proto in protos: addresses = self.core.system.resolve(self.hostname, proto) - current_address = self.get_address(proto) - # If no addresses for the given protocol exist, we - # are fine... - if current_address is None and not addresses: + # Handle if the system has not got any IP address from a protocol + # (i.e. had full dual-stack connectivity which it has not any more) + if current_address is None: + # If addresses still exists in the DNS system and if this provider + # is able to remove records, we will do that. + if addresses and self.can_remove_records: + return True + + # Otherwise, we cannot go on... continue if not current_address in addresses: - return False + return True - return True + return False + + def holdoff_time_expired(self): + """ + Returns true if the holdoff time has expired + and the host requires an update + """ + # If no holdoff days is defined, we cannot go on + if not self.holdoff_days: + return False + + # Get the timestamp of the last successfull update + last_update = self.db.last_update(self.hostname, status="success") + + # If no timestamp has been recorded, no update has been + # performed. An update should be performed now. + if not last_update: + return True + + # Determine when the holdoff time ends + holdoff_end = last_update + datetime.timedelta(days=self.holdoff_days) + + now = datetime.datetime.utcnow() + + if now >= holdoff_end: + logger.debug("The holdoff time has expired for %s" % self.hostname) + return True + else: + logger.debug("Updates for %s are held off until %s" % \ + (self.hostname, holdoff_end)) + return False def send_request(self, *args, **kwargs): """ @@ -172,6 +332,18 @@ class DDNSProvider(object): """ return self.core.system.get_address(proto) or default + def have_address(self, proto): + """ + Returns True if an IP address for the given protocol + is known and usable. + """ + address = self.get_address(proto) + + if address: + return True + + return False + class DDNSProtocolDynDNS2(object): """ @@ -185,19 +357,25 @@ class DDNSProtocolDynDNS2(object): # http://dyn.com/support/developers/api/perform-update/ # http://dyn.com/support/developers/api/return-codes/ - def _prepare_request_data(self): + # The DynDNS protocol version 2 does not allow to remove records + can_remove_records = False + + def prepare_request_data(self, proto): data = { "hostname" : self.hostname, - "myip" : self.get_address("ipv4"), + "myip" : self.get_address(proto), } return data - def update(self): - data = self._prepare_request_data() + def update_protocol(self, proto): + data = self.prepare_request_data(proto) + + return self.send_request(data) + def send_request(self, data): # Send update to the server. - response = self.send_request(self.url, data=data, + response = DDNSProvider.send_request(self, self.url, data=data, username=self.username, password=self.password) # Get the full response message. @@ -210,21 +388,54 @@ class DDNSProtocolDynDNS2(object): # Handle error codes. if output == "badauth": raise DDNSAuthenticationError - elif output == "aduse": + elif output == "abuse": raise DDNSAbuseError elif output == "notfqdn": - raise DDNSRequestError(_("No valid FQDN was given.")) + raise DDNSRequestError(_("No valid FQDN was given")) elif output == "nohost": - raise DDNSRequestError(_("Specified host does not exist.")) + raise DDNSRequestError(_("Specified host does not exist")) elif output == "911": raise DDNSInternalServerError elif output == "dnserr": - raise DDNSInternalServerError(_("DNS error encountered.")) + raise DDNSInternalServerError(_("DNS error encountered")) + elif output == "badagent": + raise DDNSBlockedError + elif output == "badip": + raise DDNSBlockedError # If we got here, some other update error happened. raise DDNSUpdateError(_("Server response: %s") % output) +class DDNSResponseParserXML(object): + """ + This class provides a parser for XML responses which + will be sent by various providers. This class uses the python + shipped XML minidom module to walk through the XML tree and return + a requested element. + """ + + def get_xml_tag_value(self, document, content): + # Send input to the parser. + xmldoc = xml.dom.minidom.parseString(document) + + # Get XML elements by the given content. + element = xmldoc.getElementsByTagName(content) + + # If no element has been found, we directly can return None. + if not element: + return None + + # Only get the first child from an element, even there are more than one. + firstchild = element[0].firstChild + + # Get the value of the child. + value = firstchild.nodeValue + + # Return the value. + return value + + class DDNSProviderAllInkl(DDNSProvider): handle = "all-inkl.com" name = "All-inkl.com" @@ -237,6 +448,7 @@ class DDNSProviderAllInkl(DDNSProvider): # http://all-inkl.goetze.it/v01/ddns-mit-einfachen-mitteln/ url = "http://dyndns.kasserver.com" + can_remove_records = False def update(self): # There is no additional data required so we directly can @@ -261,6 +473,19 @@ class DDNSProviderBindNsupdate(DDNSProvider): DEFAULT_TTL = 60 + @staticmethod + def supported(): + # Search if the nsupdate utility is available + paths = os.environ.get("PATH") + + for path in paths.split(":"): + executable = os.path.join(path, "nsupdate") + + if os.path.exists(executable): + return True + + return False + def update(self): scriptlet = self.__make_scriptlet() @@ -287,6 +512,11 @@ class DDNSProviderBindNsupdate(DDNSProvider): if server: scriptlet.append("server %s" % server) + # Set the DNS zone the host should be added to. + zone = self.get("zone", None) + if zone: + scriptlet.append("zone %s" % zone) + key = self.get("key", None) if key: secret = self.get("secret") @@ -320,6 +550,137 @@ class DDNSProviderBindNsupdate(DDNSProvider): return "\n".join(scriptlet) +class DDNSProviderChangeIP(DDNSProvider): + handle = "changeip.com" + name = "ChangeIP.com" + website = "https://changeip.com" + protocols = ("ipv4",) + + # Detailed information about the update api can be found here. + # http://www.changeip.com/accounts/knowledgebase.php?action=displayarticle&id=34 + + url = "https://nic.changeip.com/nic/update" + can_remove_records = False + + def update_protocol(self, proto): + data = { + "hostname" : self.hostname, + "myip" : self.get_address(proto), + } + + # Send update to the server. + try: + response = self.send_request(self.url, username=self.username, password=self.password, + data=data) + + # Handle error codes. + except urllib2.HTTPError, e: + if e.code == 422: + raise DDNSRequestError(_("Domain not found.")) + + raise + + # Handle success message. + if response.code == 200: + return + + # If we got here, some other update error happened. + raise DDNSUpdateError(_("Server response: %s") % output) + + +class DDNSProviderDesecIO(DDNSProtocolDynDNS2, DDNSProvider): + handle = "desec.io" + name = "desec.io" + website = "https://www.desec.io" + protocols = ("ipv6", "ipv4",) + + # ipv4 / ipv6 records are automatically removed when the update + # request originates from the respectively other protocol and no + # address is explicitly provided for the unused protocol. + + url = "https://update.dedyn.io" + + # desec.io sends the IPv6 and IPv4 address in one request + + def update(self): + data = DDNSProtocolDynDNS2.prepare_request_data(self, "ipv4") + + # This one supports IPv6 + myipv6 = self.get_address("ipv6") + + # Add update information if we have an IPv6 address. + if myipv6: + data["myipv6"] = myipv6 + + self.send_request(data) + + +class DDNSProviderDDNSS(DDNSProvider): + handle = "ddnss.de" + name = "DDNSS" + website = "http://www.ddnss.de" + protocols = ("ipv4",) + + # Detailed information about how to send the update request and possible response + # codes can be obtained from here. + # http://www.ddnss.de/info.php + # http://www.megacomputing.de/2014/08/dyndns-service-response-time/#more-919 + + url = "http://www.ddnss.de/upd.php" + can_remove_records = False + + def update_protocol(self, proto): + data = { + "ip" : self.get_address(proto), + "host" : self.hostname, + } + + # Check if a token has been set. + if self.token: + data["key"] = self.token + + # Check if username and hostname are given. + elif self.username and self.password: + data.update({ + "user" : self.username, + "pwd" : self.password, + }) + + # Raise an error if no auth details are given. + else: + raise DDNSConfigurationError + + # Send update to the server. + response = self.send_request(self.url, data=data) + + # This provider sends the response code as part of the header. + header = response.info() + + # Get status information from the header. + output = header.getheader('ddnss-response') + + # Handle success messages. + if output == "good" or output == "nochg": + return + + # Handle error codes. + if output == "badauth": + raise DDNSAuthenticationError + elif output == "notfqdn": + raise DDNSRequestError(_("No valid FQDN was given")) + elif output == "nohost": + raise DDNSRequestError(_("Specified host does not exist")) + elif output == "911": + raise DDNSInternalServerError + elif output == "dnserr": + raise DDNSInternalServerError(_("DNS error encountered")) + elif output == "disabled": + raise DDNSRequestError(_("Account disabled or locked")) + + # If we got here, some other update error happened. + raise DDNSUpdateError + + class DDNSProviderDHS(DDNSProvider): handle = "dhs.org" name = "DHS International" @@ -330,11 +691,12 @@ class DDNSProviderDHS(DDNSProvider): # grabed from source code of ez-ipudate. url = "http://members.dhs.org/nic/hosts" + can_remove_records = False - def update(self): + def update_protocol(self, proto): data = { "domain" : self.hostname, - "ip" : self.get_address("ipv4"), + "ip" : self.get_address(proto), "hostcmd" : "edit", "hostcmdstage" : "2", "type" : "4", @@ -362,11 +724,12 @@ class DDNSProviderDNSpark(DDNSProvider): # https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation url = "https://control.dnspark.com/api/dynamic/update.php" + can_remove_records = False - def update(self): + def update_protocol(self, proto): data = { "domain" : self.hostname, - "ip" : self.get_address("ipv4"), + "ip" : self.get_address(proto), } # Send update to the server. @@ -388,13 +751,13 @@ class DDNSProviderDNSpark(DDNSProvider): elif output == "blocked": raise DDNSBlockedError elif output == "nofqdn": - raise DDNSRequestError(_("No valid FQDN was given.")) + raise DDNSRequestError(_("No valid FQDN was given")) elif output == "nohost": - raise DDNSRequestError(_("Invalid hostname specified.")) + raise DDNSRequestError(_("Invalid hostname specified")) elif output == "notdyn": - raise DDNSRequestError(_("Hostname not marked as a dynamic host.")) + raise DDNSRequestError(_("Hostname not marked as a dynamic host")) elif output == "invalid": - raise DDNSRequestError(_("Invalid IP address has been sent.")) + raise DDNSRequestError(_("Invalid IP address has been sent")) # If we got here, some other update error happened. raise DDNSUpdateError @@ -410,10 +773,11 @@ class DDNSProviderDtDNS(DDNSProvider): # http://www.dtdns.com/dtsite/updatespec url = "https://www.dtdns.com/api/autodns.cfm" + can_remove_records = False - def update(self): + def update_protocol(self, proto): data = { - "ip" : self.get_address("ipv4"), + "ip" : self.get_address(proto), "id" : self.hostname, "pw" : self.password } @@ -433,27 +797,57 @@ class DDNSProviderDtDNS(DDNSProvider): # Handle error codes. if output == "No hostname to update was supplied.": - raise DDNSRequestError(_("No hostname specified.")) + raise DDNSRequestError(_("No hostname specified")) elif output == "The hostname you supplied is not valid.": - raise DDNSRequestError(_("Invalid hostname specified.")) + raise DDNSRequestError(_("Invalid hostname specified")) elif output == "The password you supplied is not valid.": raise DDNSAuthenticationError elif output == "Administration has disabled this account.": - raise DDNSRequestError(_("Account has been disabled.")) + raise DDNSRequestError(_("Account has been disabled")) elif output == "Illegal character in IP.": - raise DDNSRequestError(_("Invalid IP address has been sent.")) + raise DDNSRequestError(_("Invalid IP address has been sent")) elif output == "Too many failed requests.": - raise DDNSRequestError(_("Too many failed requests.")) + raise DDNSRequestError(_("Too many failed requests")) # If we got here, some other update error happened. raise DDNSUpdateError +class DDNSProviderDuckDNS(DDNSProtocolDynDNS2, DDNSProvider): + handle = "duckdns.org" + name = "Duck DNS" + website = "http://www.duckdns.org/" + protocols = ("ipv4",) + + # Information about the format of the request is to be found + # https://www.duckdns.org/install.jsp + + url = "https://www.duckdns.org/nic/update" + + +class DDNSProviderDyFi(DDNSProtocolDynDNS2, DDNSProvider): + handle = "dy.fi" + name = "dy.fi" + website = "https://www.dy.fi/" + protocols = ("ipv4",) + + # Information about the format of the request is to be found + # https://www.dy.fi/page/clients?lang=en + # https://www.dy.fi/page/specification?lang=en + + url = "http://www.dy.fi/nic/update" + + # Please only send automatic updates when your IP address changes, + # or once per 5 to 6 days to refresh the address mapping (they will + # expire if not refreshed within 7 days). + holdoff_days = 6 + + class DDNSProviderDynDNS(DDNSProtocolDynDNS2, DDNSProvider): handle = "dyndns.org" name = "Dyn" @@ -467,6 +861,19 @@ class DDNSProviderDynDNS(DDNSProtocolDynDNS2, DDNSProvider): url = "https://members.dyndns.org/nic/update" +class DDNSProviderDomainOffensive(DDNSProtocolDynDNS2, DDNSProvider): + handle = "do.de" + name = "Domain-Offensive" + website = "https://www.do.de/" + protocols = ("ipv6", "ipv4") + + # Detailed information about the request and response codes + # are available on the providers webpage. + # https://www.do.de/wiki/FlexDNS_-_Entwickler + + url = "https://ddns.do.de/" + + class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider): handle = "dynu.com" name = "Dynu" @@ -479,29 +886,210 @@ class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider): url = "https://api.dynu.com/nic/update" - def _prepare_request_data(self): - data = DDNSProviderDynDNS._prepare_request_data(self) + # DynU sends the IPv6 and IPv4 address in one request + + def update(self): + data = DDNSProtocolDynDNS2.prepare_request_data(self, "ipv4") # This one supports IPv6 - data.update({ - "myipv6" : self.get_address("ipv6"), - }) + myipv6 = self.get_address("ipv6") - return data + # Add update information if we have an IPv6 address. + if myipv6: + data["myipv6"] = myipv6 + + self.send_request(data) -class DDNSProviderEasyDNS(DDNSProtocolDynDNS2, DDNSProvider): +class DDNSProviderEasyDNS(DDNSProvider): handle = "easydns.com" name = "EasyDNS" website = "http://www.easydns.com/" protocols = ("ipv4",) - # There is only some basic documentation provided by the vendor, - # also searching the web gain very poor results. - # http://mediawiki.easydns.com/index.php/Dynamic_DNS + # Detailed information about the request and response codes + # (API 1.3) are available on the providers webpage. + # https://fusion.easydns.com/index.php?/Knowledgebase/Article/View/102/7/dynamic-dns url = "http://api.cp.easydns.com/dyn/tomato.php" + def update_protocol(self, proto): + data = { + "myip" : self.get_address(proto, "-"), + "hostname" : self.hostname, + } + + # Send update to the server. + response = self.send_request(self.url, data=data, + username=self.username, password=self.password) + + # Get the full response message. + output = response.read() + + # Remove all leading and trailing whitespace. + output = output.strip() + + # Handle success messages. + if output.startswith("NOERROR"): + return + + # Handle error codes. + if output.startswith("NOACCESS"): + raise DDNSAuthenticationError + + elif output.startswith("NOSERVICE"): + raise DDNSRequestError(_("Dynamic DNS is not turned on for this domain")) + + elif output.startswith("ILLEGAL INPUT"): + raise DDNSRequestError(_("Invalid data has been sent")) + + elif output.startswith("TOOSOON"): + raise DDNSRequestError(_("Too frequent update requests have been sent")) + + # If we got here, some other update error happened. + raise DDNSUpdateError + + +class DDNSProviderDomopoli(DDNSProtocolDynDNS2, DDNSProvider): + handle = "domopoli.de" + name = "domopoli.de" + website = "http://domopoli.de/" + protocols = ("ipv4",) + + # https://www.domopoli.de/?page=howto#DynDns_start + + url = "http://dyndns.domopoli.de/nic/update" + + +class DDNSProviderDynsNet(DDNSProvider): + handle = "dyns.net" + name = "DyNS" + website = "http://www.dyns.net/" + protocols = ("ipv4",) + can_remove_records = False + + # There is very detailed informatio about how to send the update request and + # the possible response codes. (Currently we are using the v1.1 proto) + # http://www.dyns.net/documentation/technical/protocol/ + + url = "http://www.dyns.net/postscript011.php" + + def update_protocol(self, proto): + data = { + "ip" : self.get_address(proto), + "host" : self.hostname, + "username" : self.username, + "password" : self.password, + } + + # Send update to the server. + response = self.send_request(self.url, data=data) + + # Get the full response message. + output = response.read() + + # Handle success messages. + if output.startswith("200"): + return + + # Handle error codes. + if output.startswith("400"): + raise DDNSRequestError(_("Malformed request has been sent")) + elif output.startswith("401"): + raise DDNSAuthenticationError + elif output.startswith("402"): + raise DDNSRequestError(_("Too frequent update requests have been sent")) + elif output.startswith("403"): + raise DDNSInternalServerError + + # If we got here, some other update error happened. + raise DDNSUpdateError(_("Server response: %s") % output) + + +class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider): + handle = "enom.com" + name = "eNom Inc." + website = "http://www.enom.com/" + protocols = ("ipv4",) + + # There are very detailed information about how to send an update request and + # the respone codes. + # http://www.enom.com/APICommandCatalog/ + + url = "https://dynamic.name-services.com/interface.asp" + can_remove_records = False + + def update_protocol(self, proto): + data = { + "command" : "setdnshost", + "responsetype" : "xml", + "address" : self.get_address(proto), + "domainpassword" : self.password, + "zone" : self.hostname + } + + # Send update to the server. + response = self.send_request(self.url, data=data) + + # Get the full response message. + output = response.read() + + # Handle success messages. + if self.get_xml_tag_value(output, "ErrCount") == "0": + return + + # Handle error codes. + errorcode = self.get_xml_tag_value(output, "ResponseNumber") + + if errorcode == "304155": + raise DDNSAuthenticationError + elif errorcode == "304153": + raise DDNSRequestError(_("Domain not found")) + + # If we got here, some other update error happened. + raise DDNSUpdateError + + +class DDNSProviderEntryDNS(DDNSProvider): + handle = "entrydns.net" + name = "EntryDNS" + website = "http://entrydns.net/" + protocols = ("ipv4",) + + # Some very tiny details about their so called "Simple API" can be found + # here: https://entrydns.net/help + url = "https://entrydns.net/records/modify" + can_remove_records = False + + def update_protocol(self, proto): + data = { + "ip" : self.get_address(proto), + } + + # Add auth token to the update url. + url = "%s/%s" % (self.url, self.token) + + # Send update to the server. + try: + response = self.send_request(url, data=data) + + # Handle error codes + except urllib2.HTTPError, e: + if e.code == 404: + raise DDNSAuthenticationError + + elif e.code == 422: + raise DDNSRequestError(_("An invalid IP address was submitted")) + + raise + + # Handle success messages. + if response.code == 200: + return + + # If we got here, some other update error happened. + raise DDNSUpdateError + class DDNSProviderFreeDNSAfraidOrg(DDNSProvider): handle = "freedns.afraid.org" @@ -511,16 +1099,11 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider): # No information about the request or response could be found on the vendor # page. All used values have been collected by testing. url = "https://freedns.afraid.org/dynamic/update.php" + can_remove_records = False - @property - def proto(self): - return self.get("proto") - - def update(self): - address = self.get_address(self.proto) - + def update_protocol(self, proto): data = { - "address" : address, + "address" : self.get_address(proto), } # Add auth token to the update url. @@ -529,6 +1112,10 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider): # Send update to the server. response = self.send_request(url, data=data) + # Get the full response message. + output = response.read() + + # Handle success messages. if output.startswith("Updated") or "has not changed" in output: return @@ -536,12 +1123,37 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider): if output == "ERROR: Unable to locate this record": raise DDNSAuthenticationError elif "is an invalid IP address" in output: - raise DDNSRequestError(_("Invalid IP address has been sent.")) + raise DDNSRequestError(_("Invalid IP address has been sent")) # If we got here, some other update error happened. raise DDNSUpdateError +class DDNSProviderJoker(DDNSProtocolDynDNS2, DDNSProvider): + handle = "joker.com" + name = "Joker.com Dynamic DNS" + website = "https://joker.com/" + protocols = ("ipv4",) + + # Information about the request can be found here: + # https://joker.com/faq/content/11/427/en/what-is-dynamic-dns-dyndns.html + # Using DynDNS V2 protocol over HTTPS here + + url = "https://svc.joker.com/nic/update" + + +class DDNSProviderGoogle(DDNSProtocolDynDNS2, DDNSProvider): + handle = "domains.google.com" + name = "Google Domains" + website = "https://domains.google.com/" + protocols = ("ipv4",) + + # Information about the format of the HTTP request is to be found + # here: https://support.google.com/domains/answer/6147083?hl=en + + url = "https://domains.google.com/nic/update" + + class DDNSProviderLightningWireLabs(DDNSProvider): handle = "dns.lightningwirelabs.com" name = "Lightning Wire Labs DNS Service" @@ -585,7 +1197,38 @@ class DDNSProviderLightningWireLabs(DDNSProvider): raise DDNSUpdateError -class DDNSProviderNamecheap(DDNSProvider): +class DDNSProviderLoopia(DDNSProtocolDynDNS2, DDNSProvider): + handle = "loopia.se" + name = "Loopia AB" + website = "https://www.loopia.com" + protocols = ("ipv4",) + + # Information about the format of the HTTP request is to be found + # here: https://support.loopia.com/wiki/About_the_DynDNS_support + + url = "https://dns.loopia.se/XDynDNSServer/XDynDNS.php" + + +class DDNSProviderMyOnlinePortal(DDNSProtocolDynDNS2, DDNSProvider): + handle = "myonlineportal.net" + name = "myonlineportal.net" + website = "https:/myonlineportal.net/" + + # Information about the request and response can be obtained here: + # https://myonlineportal.net/howto_dyndns + + url = "https://myonlineportal.net/updateddns" + + def prepare_request_data(self, proto): + data = { + "hostname" : self.hostname, + "ip" : self.get_address(proto), + } + + return data + + +class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider): handle = "namecheap.com" name = "Namecheap" website = "http://namecheap.com" @@ -596,33 +1239,17 @@ class DDNSProviderNamecheap(DDNSProvider): # https://community.namecheap.com/forums/viewtopic.php?f=6&t=6772 url = "https://dynamicdns.park-your-domain.com/update" + can_remove_records = False - def parse_xml(self, document, content): - # Send input to the parser. - xmldoc = xml.dom.minidom.parseString(document) - - # Get XML elements by the given content. - element = xmldoc.getElementsByTagName(content) - - # If no element has been found, we directly can return None. - if not element: - return None - - # Only get the first child from an element, even there are more than one. - firstchild = element[0].firstChild - - # Get the value of the child. - value = firstchild.nodeValue - - # Return the value. - return value - - def update(self): + def update_protocol(self, proto): # Namecheap requires the hostname splitted into a host and domain part. host, domain = self.hostname.split(".", 1) + # Get and store curent IP address. + address = self.get_address(proto) + data = { - "ip" : self.get_address("ipv4"), + "ip" : address, "password" : self.password, "host" : host, "domain" : domain @@ -635,18 +1262,18 @@ class DDNSProviderNamecheap(DDNSProvider): output = response.read() # Handle success messages. - if self.parse_xml(output, "IP") == self.get_address("ipv4"): + if self.get_xml_tag_value(output, "IP") == address: return # Handle error codes. - errorcode = self.parse_xml(output, "ResponseNumber") + errorcode = self.get_xml_tag_value(output, "ResponseNumber") if errorcode == "304156": raise DDNSAuthenticationError elif errorcode == "316153": - raise DDNSRequestError(_("Domain not found.")) + raise DDNSRequestError(_("Domain not found")) elif errorcode == "316154": - raise DDNSRequestError(_("Domain not active.")) + raise DDNSRequestError(_("Domain not active")) elif errorcode in ("380098", "380099"): raise DDNSInternalServerError @@ -666,10 +1293,83 @@ class DDNSProviderNOIP(DDNSProtocolDynDNS2, DDNSProvider): url = "http://dynupdate.no-ip.com/nic/update" - def _prepare_request_data(self): + def prepare_request_data(self, proto): + assert proto == "ipv4" + data = { "hostname" : self.hostname, - "address" : self.get_address("ipv4"), + "address" : self.get_address(proto), + } + + return data + + +class DDNSProviderNowDNS(DDNSProtocolDynDNS2, DDNSProvider): + handle = "now-dns.com" + name = "NOW-DNS" + website = "http://now-dns.com/" + protocols = ("ipv6", "ipv4") + + # Information about the format of the request is to be found + # but only can be accessed by register an account and login + # https://now-dns.com/?m=api + + url = "https://now-dns.com/update" + + +class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider): + handle = "nsupdate.info" + name = "nsupdate.info" + website = "http://nsupdate.info/" + protocols = ("ipv6", "ipv4",) + + # Information about the format of the HTTP request can be found + # after login on the provider user interface and here: + # http://nsupdateinfo.readthedocs.org/en/latest/user.html + + url = "https://nsupdate.info/nic/update" + + # TODO nsupdate.info can actually do this, but the functionality + # has not been implemented here, yet. + can_remove_records = False + + # After a failed update, there will be no retries + # https://bugzilla.ipfire.org/show_bug.cgi?id=10603 + holdoff_failure_days = None + + # Nsupdate.info uses the hostname as user part for the HTTP basic auth, + # and for the password a so called secret. + @property + def username(self): + return self.get("hostname") + + @property + def password(self): + return self.token or self.get("secret") + + def prepare_request_data(self, proto): + data = { + "myip" : self.get_address(proto), + } + + return data + + +class DDNSProviderOpenDNS(DDNSProtocolDynDNS2, DDNSProvider): + handle = "opendns.com" + name = "OpenDNS" + website = "http://www.opendns.com" + + # Detailed information about the update request and possible + # response codes can be obtained from here: + # https://support.opendns.com/entries/23891440 + + url = "https://updates.opendns.com/nic/update" + + def prepare_request_data(self, proto): + data = { + "hostname" : self.hostname, + "myip" : self.get_address(proto), } return data @@ -689,8 +1389,8 @@ class DDNSProviderOVH(DDNSProtocolDynDNS2, DDNSProvider): url = "https://www.ovh.com/nic/update" - def _prepare_request_data(self): - data = DDNSProtocolDynDNS2._prepare_request_data(self) + def prepare_request_data(self, proto): + data = DDNSProtocolDynDNS2.prepare_request_data(self, proto) data.update({ "system" : "dyndns", }) @@ -708,6 +1408,7 @@ class DDNSProviderRegfish(DDNSProvider): # https://www.regfish.de/domains/dyndns/dokumentation url = "https://dyndns.regfish.de/" + can_remove_records = False def update(self): data = { @@ -735,7 +1436,7 @@ class DDNSProviderRegfish(DDNSProvider): # Raise an error if no token and no useranem and password # are given. elif not self.username and not self.password: - raise DDNSConfigurationError(_("No Auth details specified.")) + raise DDNSConfigurationError(_("No Auth details specified")) # HTTP Basic Auth is only allowed if no token is used. if self.token: @@ -757,11 +1458,11 @@ class DDNSProviderRegfish(DDNSProvider): if "401" or "402" in output: raise DDNSAuthenticationError elif "408" in output: - raise DDNSRequestError(_("Invalid IPv4 address has been sent.")) + raise DDNSRequestError(_("Invalid IPv4 address has been sent")) elif "409" in output: - raise DDNSRequestError(_("Invalid IPv6 address has been sent.")) + raise DDNSRequestError(_("Invalid IPv6 address has been sent")) elif "412" in output: - raise DDNSRequestError(_("No valid FQDN was given.")) + raise DDNSRequestError(_("No valid FQDN was given")) elif "414" in output: raise DDNSInternalServerError @@ -769,6 +1470,17 @@ class DDNSProviderRegfish(DDNSProvider): raise DDNSUpdateError +class DDNSProviderSchokokeksDNS(DDNSProtocolDynDNS2, DDNSProvider): + handle = "schokokeks.org" + name = "Schokokeks" + website = "http://www.schokokeks.org/" + protocols = ("ipv4",) + + # Information about the format of the request is to be found + # https://wiki.schokokeks.org/DynDNS + url = "https://dyndns.schokokeks.org/nic/update" + + class DDNSProviderSelfhost(DDNSProtocolDynDNS2, DDNSProvider): handle = "selfhost.de" name = "Selfhost.de" @@ -777,8 +1489,8 @@ class DDNSProviderSelfhost(DDNSProtocolDynDNS2, DDNSProvider): url = "https://carol.selfhost.de/nic/update" - def _prepare_request_data(self): - data = DDNSProviderDynDNS._prepare_request_data(self) + def prepare_request_data(self, proto): + data = DDNSProtocolDynDNS2.prepare_request_data(self, proto) data.update({ "hostname" : "1", }) @@ -786,11 +1498,45 @@ class DDNSProviderSelfhost(DDNSProtocolDynDNS2, DDNSProvider): return data +class DDNSProviderServercow(DDNSProvider): + handle = "servercow.de" + name = "servercow.de" + website = "https://servercow.de/" + protocols = ("ipv4", "ipv6") + + url = "https://www.servercow.de/dnsupdate/update.php" + can_remove_records = False + + def update_protocol(self, proto): + data = { + "ipaddr" : self.get_address(proto), + "hostname" : self.hostname, + "username" : self.username, + "pass" : self.password, + } + + # Send request to provider + response = self.send_request(self.url, data=data) + + # Read response + output = response.read() + + # Server responds with OK if update was successful + if output.startswith("OK"): + return + + # Catch any errors + elif output.startswith("FAILED - Authentication failed"): + raise DDNSAuthenticationError + + # If we got here, some other update error happened + raise DDNSUpdateError(output) + + class DDNSProviderSPDNS(DDNSProtocolDynDNS2, DDNSProvider): handle = "spdns.org" - name = "SPDNS" - website = "http://spdns.org/" - protocols = ("ipv4",) + name = "SPDYN" + website = "https://www.spdyn.de/" # Detailed information about request and response codes are provided # by the vendor. They are using almost the same mechanism and status @@ -799,7 +1545,15 @@ class DDNSProviderSPDNS(DDNSProtocolDynDNS2, DDNSProvider): # http://wiki.securepoint.de/index.php/SPDNS_FAQ # http://wiki.securepoint.de/index.php/SPDNS_Update-Tokens - url = "https://update.spdns.de/nic/update" + url = "https://update.spdyn.de/nic/update" + + @property + def username(self): + return self.get("username") or self.hostname + + @property + def password(self): + return self.get("password") or self.token class DDNSProviderStrato(DDNSProtocolDynDNS2, DDNSProvider): @@ -813,6 +1567,15 @@ class DDNSProviderStrato(DDNSProtocolDynDNS2, DDNSProvider): url = "https://dyndns.strato.com/nic/update" + def prepare_request_data(self, proto): + data = DDNSProtocolDynDNS2.prepare_request_data(self, proto) + data.update({ + "mx" : "NOCHG", + "backupmx" : "NOCHG" + }) + + return data + class DDNSProviderTwoDNS(DDNSProtocolDynDNS2, DDNSProvider): handle = "twodns.de" @@ -826,9 +1589,11 @@ class DDNSProviderTwoDNS(DDNSProtocolDynDNS2, DDNSProvider): url = "https://update.twodns.de/update" - def _prepare_request_data(self): + def prepare_request_data(self, proto): + assert proto == "ipv4" + data = { - "ip" : self.get_address("ipv4"), + "ip" : self.get_address(proto), "hostname" : self.hostname } @@ -858,20 +1623,28 @@ class DDNSProviderVariomedia(DDNSProtocolDynDNS2, DDNSProvider): url = "https://dyndns.variomedia.de/nic/update" - @property - def proto(self): - return self.get("proto") - - def _prepare_request_data(self): + def prepare_request_data(self, proto): data = { "hostname" : self.hostname, - "myip" : self.get_address(self.proto) + "myip" : self.get_address(proto), } return data -class DDNSProviderZoneedit(DDNSProtocolDynDNS2, DDNSProvider): +class DDNSProviderXLhost(DDNSProtocolDynDNS2, DDNSProvider): + handle = "xlhost.de" + name = "XLhost" + website = "http://xlhost.de/" + protocols = ("ipv4",) + + # Information about the format of the HTTP request is to be found + # here: https://xlhost.de/faq/index_html?topicId=CQA2ELIPO4SQ + + url = "https://nsupdate.xlhost.de/" + + +class DDNSProviderZoneedit(DDNSProvider): handle = "zoneedit.com" name = "Zoneedit" website = "http://www.zoneedit.com" @@ -884,13 +1657,9 @@ class DDNSProviderZoneedit(DDNSProtocolDynDNS2, DDNSProvider): url = "https://dynamic.zoneedit.com/auth/dynamic.html" - @property - def proto(self): - return self.get("proto") - - def update(self): + def update_protocol(self, proto): data = { - "dnsto" : self.get_address(self.proto), + "dnsto" : self.get_address(proto), "host" : self.hostname } @@ -909,9 +1678,104 @@ class DDNSProviderZoneedit(DDNSProtocolDynDNS2, DDNSProvider): if output.startswith("invalid login"): raise DDNSAuthenticationError elif output.startswith("