X-Git-Url: http://git.ipfire.org/?p=oddments%2Fddns.git;a=blobdiff_plain;f=src%2Fddns%2Fproviders.py;h=59ccd728cd1f7e26f30a4054e6d13c6abff33895;hp=6945423690517603484b0ceab53dfba593ab0ec6;hb=12b3818bd9a9097931dd547e3f85e535ebba1e1b;hpb=b2b05ef364b9b6cec97af2cd14d3dd64f4841478 diff --git a/src/ddns/providers.py b/src/ddns/providers.py index 6945423..59ccd72 100644 --- a/src/ddns/providers.py +++ b/src/ddns/providers.py @@ -20,6 +20,7 @@ ############################################################################### import logging +import subprocess import urllib2 import xml.dom.minidom @@ -31,6 +32,14 @@ from .errors import * logger = logging.getLogger("ddns.providers") logger.propagate = 1 +_providers = {} + +def get(): + """ + Returns a dict with all automatically registered providers. + """ + return _providers.copy() + class DDNSProvider(object): # A short string that uniquely identifies # this provider. @@ -48,6 +57,24 @@ class DDNSProvider(object): DEFAULT_SETTINGS = {} + # Automatically register all providers. + class __metaclass__(type): + def __init__(provider, name, bases, dict): + type.__init__(provider, name, bases, dict) + + # The main class from which is inherited is not registered + # as a provider. + if name == "DDNSProvider": + return + + if not all((provider.handle, provider.name, provider.website)): + raise DDNSError(_("Provider is not properly configured")) + + assert not _providers.has_key(provider.handle), \ + "Provider '%s' has already been registered" % provider.handle + + _providers[provider.handle] = provider + def __init__(self, core, **settings): self.core = core @@ -102,12 +129,16 @@ class DDNSProvider(object): # 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) + logger.info(_("The dynamic host %(hostname)s (%(provider)s) is already up to date") % \ + { "hostname" : self.hostname, "provider" : self.name }) return # Execute the update. self.update() + logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \ + { "hostname" : self.hostname, "provider" : self.name }) + def update(self): raise NotImplementedError @@ -146,6 +177,87 @@ class DDNSProvider(object): return self.core.system.get_address(proto) or default +class DDNSProtocolDynDNS2(object): + """ + This is an abstract class that implements the DynDNS updater + protocol version 2. As this is a popular way to update dynamic + DNS records, this class is supposed make the provider classes + shorter and simpler. + """ + + # Information about the format of the request is to be found + # http://dyn.com/support/developers/api/perform-update/ + # http://dyn.com/support/developers/api/return-codes/ + + def _prepare_request_data(self): + data = { + "hostname" : self.hostname, + "myip" : self.get_address("ipv4"), + } + + return data + + def update(self): + data = self._prepare_request_data() + + # 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() + + # Handle success messages. + if output.startswith("good") or output.startswith("nochg"): + return + + # Handle error codes. + if output == "badauth": + raise DDNSAuthenticationError + elif output == "aduse": + raise DDNSAbuseError + 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.")) + + # 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" @@ -175,6 +287,72 @@ class DDNSProviderAllInkl(DDNSProvider): raise DDNSUpdateError +class DDNSProviderBindNsupdate(DDNSProvider): + handle = "nsupdate" + name = "BIND nsupdate utility" + website = "http://en.wikipedia.org/wiki/Nsupdate" + + DEFAULT_TTL = 60 + + def update(self): + scriptlet = self.__make_scriptlet() + + # -v enables TCP hence we transfer keys and other data that may + # exceed the size of one packet. + # -t sets the timeout + command = ["nsupdate", "-v", "-t", "60"] + + p = subprocess.Popen(command, shell=True, + stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, + ) + stdout, stderr = p.communicate(scriptlet) + + if p.returncode == 0: + return + + raise DDNSError("nsupdate terminated with error code: %s\n %s" % (p.returncode, stderr)) + + def __make_scriptlet(self): + scriptlet = [] + + # Set a different server the update is sent to. + server = self.get("server", None) + if server: + scriptlet.append("server %s" % server) + + key = self.get("key", None) + if key: + secret = self.get("secret") + + scriptlet.append("key %s %s" % (key, secret)) + + ttl = self.get("ttl", self.DEFAULT_TTL) + + # Perform an update for each supported protocol. + for rrtype, proto in (("AAAA", "ipv6"), ("A", "ipv4")): + address = self.get_address(proto) + if not address: + continue + + scriptlet.append("update delete %s. %s" % (self.hostname, rrtype)) + scriptlet.append("update add %s. %s %s %s" % \ + (self.hostname, ttl, rrtype, address)) + + # Send the actions to the server. + scriptlet.append("send") + scriptlet.append("quit") + + logger.debug(_("Scriptlet:")) + for line in scriptlet: + # Masquerade the line with the secret key. + if line.startswith("key"): + line = "key **** ****" + + logger.debug(" %s" % line) + + return "\n".join(scriptlet) + + class DDNSProviderDHS(DDNSProvider): handle = "dhs.org" name = "DHS International" @@ -309,7 +487,7 @@ class DDNSProviderDtDNS(DDNSProvider): raise DDNSUpdateError -class DDNSProviderDynDNS(DDNSProvider): +class DDNSProviderDynDNS(DDNSProtocolDynDNS2, DDNSProvider): handle = "dyndns.org" name = "Dyn" website = "http://dyn.com/dns/" @@ -321,47 +499,8 @@ class DDNSProviderDynDNS(DDNSProvider): url = "https://members.dyndns.org/nic/update" - def _prepare_request_data(self): - data = { - "hostname" : self.hostname, - "myip" : self.get_address("ipv4"), - } - - return data - - def update(self): - data = self._prepare_request_data() - - # 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() - # Handle success messages. - if output.startswith("good") or output.startswith("nochg"): - return - - # Handle error codes. - if output == "badauth": - raise DDNSAuthenticationError - elif output == "aduse": - raise DDNSAbuseError - 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.")) - - # If we got here, some other update error happened. - raise DDNSUpdateError(_("Server response: %s") % output) - - -class DDNSProviderDynU(DDNSProviderDynDNS): +class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider): handle = "dynu.com" name = "Dynu" website = "http://dynu.com/" @@ -384,10 +523,11 @@ class DDNSProviderDynU(DDNSProviderDynDNS): return data -class DDNSProviderEasyDNS(DDNSProviderDynDNS): - handle = "easydns.com" - name = "EasyDNS" - website = "http://www.easydns.com/" +class DDNSProviderEasyDNS(DDNSProtocolDynDNS2, 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. @@ -396,6 +536,88 @@ class DDNSProviderEasyDNS(DDNSProviderDynDNS): url = "http://api.cp.easydns.com/dyn/tomato.php" +class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider): + handle = "enom.com" + name = "eNom Inc." + website = "http://www.enom.com/" + + # 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" + + def update(self): + data = { + "command" : "setdnshost", + "responsetype" : "xml", + "address" : self.get_address("ipv4"), + "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" + + def update(self): + data = { + "ip" : self.get_address("ipv4") + } + + # 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, method="PUT", 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" name = "freedns.afraid.org" @@ -422,6 +644,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 @@ -478,7 +704,7 @@ class DDNSProviderLightningWireLabs(DDNSProvider): raise DDNSUpdateError -class DDNSProviderNamecheap(DDNSProvider): +class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider): handle = "namecheap.com" name = "Namecheap" website = "http://namecheap.com" @@ -490,26 +716,6 @@ class DDNSProviderNamecheap(DDNSProvider): url = "https://dynamicdns.park-your-domain.com/update" - 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): # Namecheap requires the hostname splitted into a host and domain part. host, domain = self.hostname.split(".", 1) @@ -528,11 +734,11 @@ 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") == self.get_address("ipv4"): return # Handle error codes. - errorcode = self.parse_xml(output, "ResponseNumber") + errorcode = self.get_xml_tag_value(output, "ResponseNumber") if errorcode == "304156": raise DDNSAuthenticationError @@ -547,10 +753,11 @@ class DDNSProviderNamecheap(DDNSProvider): raise DDNSUpdateError -class DDNSProviderNOIP(DDNSProviderDynDNS): - handle = "no-ip.com" - name = "No-IP" - website = "http://www.no-ip.com/" +class DDNSProviderNOIP(DDNSProtocolDynDNS2, DDNSProvider): + handle = "no-ip.com" + name = "No-IP" + website = "http://www.no-ip.com/" + protocols = ("ipv4",) # Information about the format of the HTTP request is to be found # here: http://www.no-ip.com/integrate/request and @@ -567,10 +774,77 @@ class DDNSProviderNOIP(DDNSProviderDynDNS): return data -class DDNSProviderOVH(DDNSProviderDynDNS): - handle = "ovh.com" - name = "OVH" - website = "http://www.ovh.com/" +class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider): + handle = "nsupdate.info" + name = "nsupdate.info" + website = "http://www.nsupdate.info/" + protocols = ("ipv6", "ipv4",) + + # Information about the format of the HTTP request can be found + # after login on the provider user intrface and here: + # http://nsupdateinfo.readthedocs.org/en/latest/user.html + + # 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.get("secret") + + @property + def proto(self): + return self.get("proto") + + @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")) + + def _prepare_request_data(self): + data = { + "myip" : self.get_address(self.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" + + @property + def proto(self): + return self.get("proto") + + def _prepare_request_data(self): + data = { + "hostname" : self.hostname, + "myip" : self.get_address(self.proto) + } + + return data + + +class DDNSProviderOVH(DDNSProtocolDynDNS2, DDNSProvider): + handle = "ovh.com" + name = "OVH" + website = "http://www.ovh.com/" + protocols = ("ipv4",) # OVH only provides very limited information about how to # update a DynDNS host. They only provide the update url @@ -581,7 +855,7 @@ class DDNSProviderOVH(DDNSProviderDynDNS): url = "https://www.ovh.com/nic/update" def _prepare_request_data(self): - data = DDNSProviderDynDNS._prepare_request_data(self) + data = DDNSProtocolDynDNS2._prepare_request_data(self) data.update({ "system" : "dyndns", }) @@ -660,10 +934,11 @@ class DDNSProviderRegfish(DDNSProvider): raise DDNSUpdateError -class DDNSProviderSelfhost(DDNSProviderDynDNS): +class DDNSProviderSelfhost(DDNSProtocolDynDNS2, DDNSProvider): handle = "selfhost.de" name = "Selfhost.de" website = "http://www.selfhost.de/" + protocols = ("ipv4",) url = "https://carol.selfhost.de/nic/update" @@ -676,10 +951,11 @@ class DDNSProviderSelfhost(DDNSProviderDynDNS): return data -class DDNSProviderSPDNS(DDNSProviderDynDNS): - handle = "spdns.org" - name = "SPDNS" - website = "http://spdns.org/" +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 @@ -691,10 +967,11 @@ class DDNSProviderSPDNS(DDNSProviderDynDNS): url = "https://update.spdns.de/nic/update" -class DDNSProviderStrato(DDNSProviderDynDNS): - handle = "strato.com" - name = "Strato AG" - website = "http:/www.strato.com/" +class DDNSProviderStrato(DDNSProtocolDynDNS2, DDNSProvider): + handle = "strato.com" + name = "Strato AG" + website = "http:/www.strato.com/" + protocols = ("ipv4",) # Information about the request and response can be obtained here: # http://www.strato-faq.de/article/671/So-einfach-richten-Sie-DynDNS-f%C3%BCr-Ihre-Domains-ein.html @@ -702,10 +979,11 @@ class DDNSProviderStrato(DDNSProviderDynDNS): url = "https://dyndns.strato.com/nic/update" -class DDNSProviderTwoDNS(DDNSProviderDynDNS): - handle = "twodns.de" - name = "TwoDNS" - website = "http://www.twodns.de" +class DDNSProviderTwoDNS(DDNSProtocolDynDNS2, DDNSProvider): + handle = "twodns.de" + name = "TwoDNS" + website = "http://www.twodns.de" + protocols = ("ipv4",) # Detailed information about the request can be found here # http://twodns.de/en/faqs @@ -722,10 +1000,11 @@ class DDNSProviderTwoDNS(DDNSProviderDynDNS): return data -class DDNSProviderUdmedia(DDNSProviderDynDNS): - handle = "udmedia.de" - name = "Udmedia GmbH" - website = "http://www.udmedia.de" +class DDNSProviderUdmedia(DDNSProtocolDynDNS2, DDNSProvider): + handle = "udmedia.de" + name = "Udmedia GmbH" + website = "http://www.udmedia.de" + protocols = ("ipv4",) # Information about the request can be found here # http://www.udmedia.de/faq/content/47/288/de/wie-lege-ich-einen-dyndns_eintrag-an.html @@ -733,7 +1012,7 @@ class DDNSProviderUdmedia(DDNSProviderDynDNS): url = "https://www.udmedia.de/nic/update" -class DDNSProviderVariomedia(DDNSProviderDynDNS): +class DDNSProviderVariomedia(DDNSProtocolDynDNS2, DDNSProvider): handle = "variomedia.de" name = "Variomedia" website = "http://www.variomedia.de/" @@ -757,10 +1036,11 @@ class DDNSProviderVariomedia(DDNSProviderDynDNS): return data -class DDNSProviderZoneedit(DDNSProvider): - handle = "zoneedit.com" - name = "Zoneedit" - website = "http://www.zoneedit.com" +class DDNSProviderZoneedit(DDNSProtocolDynDNS2, DDNSProvider): + handle = "zoneedit.com" + name = "Zoneedit" + website = "http://www.zoneedit.com" + protocols = ("ipv4",) # Detailed information about the request and the response codes can be # obtained here: