X-Git-Url: http://git.ipfire.org/?p=ddns.git;a=blobdiff_plain;f=src%2Fddns%2Fproviders.py;h=6ac556444553fbf0d6e8b23854fe228ad6c81fc5;hp=28bdf41613cd0fd22649bbfa020fe5da82782510;hb=47ea9f414f25cb6e72d1958a2d09ed09e3c6b4e8;hpb=37e24fbf10596e13a5282207068722e5c3a347e8 diff --git a/src/ddns/providers.py b/src/ddns/providers.py index 28bdf41..6ac5564 100644 --- a/src/ddns/providers.py +++ b/src/ddns/providers.py @@ -21,6 +21,7 @@ import datetime import logging +import os import subprocess import urllib2 import xml.dom.minidom @@ -62,6 +63,14 @@ class DDNSProvider(object): # 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): @@ -80,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 @@ -136,14 +153,23 @@ class DDNSProvider(object): if force: logger.debug(_("Updating %s forced") % self.hostname) - # Do nothing if no update is required - elif not self.requires_update: + # 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. 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: @@ -158,19 +184,17 @@ class DDNSProvider(object): for protocol in self.protocols: if self.have_address(protocol): self.update_protocol(protocol) - else: + elif self.can_remove_records: self.remove_protocol(protocol) def update_protocol(self, proto): raise NotImplementedError def remove_protocol(self, proto): - logger.warning(_("%(hostname)s current resolves to an IP address" - " of the %(proto)s protocol which could not be removed by ddns") % \ - { "hostname" : self.hostname, "proto" : proto }) + if not self.can_remove_records: + raise RuntimeError, "can_remove_records is enabled, but remove_protocol() not implemented" - # Maybe this will raise NotImplementedError at some time - #raise NotImplementedError + raise NotImplementedError @property def requires_update(self): @@ -196,6 +220,49 @@ class DDNSProvider(object): 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 @@ -204,12 +271,17 @@ 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: @@ -227,7 +299,7 @@ class DDNSProvider(object): return False # Get the timestamp of the last successfull update - last_update = self.db.last_update(self.hostname) + 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. @@ -285,6 +357,9 @@ class DDNSProtocolDynDNS2(object): # http://dyn.com/support/developers/api/perform-update/ # http://dyn.com/support/developers/api/return-codes/ + # 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, @@ -371,6 +446,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 @@ -395,6 +471,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() @@ -459,6 +548,110 @@ 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 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" @@ -469,6 +662,7 @@ class DDNSProviderDHS(DDNSProvider): # grabed from source code of ez-ipudate. url = "http://members.dhs.org/nic/hosts" + can_remove_records = False def update_protocol(self, proto): data = { @@ -501,6 +695,7 @@ 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_protocol(self, proto): data = { @@ -549,6 +744,7 @@ class DDNSProviderDtDNS(DDNSProvider): # http://www.dtdns.com/dtsite/updatespec url = "https://www.dtdns.com/api/autodns.cfm" + can_remove_records = False def update_protocol(self, proto): data = { @@ -630,21 +826,57 @@ class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider): if myipv6: data["myipv6"] = myipv6 - self._send_request(data) + 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" @@ -662,6 +894,7 @@ class DDNSProviderDynsNet(DDNSProvider): 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) @@ -712,6 +945,7 @@ class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider): # http://www.enom.com/APICommandCatalog/ url = "https://dynamic.name-services.com/interface.asp" + can_remove_records = False def update_protocol(self, proto): data = { @@ -753,6 +987,7 @@ class DDNSProviderEntryDNS(DDNSProvider): # 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 = { @@ -792,6 +1027,7 @@ 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 def update_protocol(self, proto): data = { @@ -821,6 +1057,31 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider): 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" @@ -864,6 +1125,37 @@ class DDNSProviderLightningWireLabs(DDNSProvider): raise DDNSUpdateError +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" @@ -875,13 +1167,17 @@ class DDNSProviderNamecheap(DDNSResponseParserXML, 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 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(proto), + "ip" : address, "password" : self.password, "host" : host, "domain" : domain @@ -946,6 +1242,16 @@ class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider): # 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 @@ -954,17 +1260,7 @@ class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider): @property def password(self): - return self.get("secret") - - @property - def url(self): - # The update URL is different by the used protocol. - if self.proto == "ipv4": - return "https://ipv4.nsupdate.info/nic/update" - elif self.proto == "ipv6": - return "https://ipv6.nsupdate.info/nic/update" - else: - raise DDNSUpdateError(_("Invalid protocol has been given")) + return self.token or self.get("secret") def prepare_request_data(self, proto): data = { @@ -1027,6 +1323,7 @@ class DDNSProviderRegfish(DDNSProvider): # https://www.regfish.de/domains/dyndns/dokumentation url = "https://dyndns.regfish.de/" + can_remove_records = False def update(self): data = { @@ -1109,7 +1406,6 @@ class DDNSProviderSPDNS(DDNSProtocolDynDNS2, DDNSProvider): handle = "spdns.org" name = "SPDNS" website = "http://spdns.org/" - protocols = ("ipv4",) # Detailed information about request and response codes are provided # by the vendor. They are using almost the same mechanism and status @@ -1126,7 +1422,7 @@ class DDNSProviderSPDNS(DDNSProtocolDynDNS2, DDNSProvider): @property def password(self): - return self.get("username") or self.token + return self.get("password") or self.token class DDNSProviderStrato(DDNSProtocolDynDNS2, DDNSProvider): @@ -1140,6 +1436,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" @@ -1196,7 +1501,19 @@ class DDNSProviderVariomedia(DDNSProtocolDynDNS2, DDNSProvider): 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" @@ -1238,6 +1555,54 @@ class DDNSProviderZoneedit(DDNSProtocolDynDNS2, DDNSProvider): raise DDNSUpdateError +class DDNSProviderDNSmadeEasy(DDNSProvider): + handle = "dnsmadeeasy.com" + name = "DNSmadeEasy.com" + website = "http://www.dnsmadeeasy.com/" + protocols = ("ipv4",) + + # DNS Made Easy Nameserver Provider also offering Dynamic DNS + # Documentation can be found here: + # http://www.dnsmadeeasy.com/dynamic-dns/ + + url = "https://cp.dnsmadeeasy.com/servlet/updateip?" + can_remove_records = False + + def update_protocol(self, proto): + data = { + "ip" : self.get_address(proto), + "id" : 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("success") or output.startswith("error-record-ip-same"): + return + + # Handle error codes. + if output.startswith("error-auth-suspend"): + raise DDNSRequestError(_("Account has been suspended.")) + + elif output.startswith("error-auth-voided"): + raise DDNSRequestError(_("Account has been revoked.")) + + elif output.startswith("error-record-invalid"): + raise DDNSRequestError(_("Specified host does not exist.")) + + elif output.startswith("error-auth"): + raise DDNSAuthenticationError + + # If we got here, some other update error happened. + raise DDNSUpdateError(_("Server response: %s") % output) + + class DDNSProviderZZZZ(DDNSProvider): handle = "zzzz.io" name = "zzzz" @@ -1251,6 +1616,7 @@ class DDNSProviderZZZZ(DDNSProvider): # https://bugzilla.ipfire.org/show_bug.cgi?id=10584#c2 url = "https://zzzz.io/api/v1/update" + can_remove_records = False def update_protocol(self, proto): data = {