X-Git-Url: http://git.ipfire.org/?p=ddns.git;a=blobdiff_plain;f=src%2Fddns%2Fproviders.py;h=0c735fc6a41c18fe49f487a0e394c87f31c277b1;hp=3d2d0c204fb48b1b758241e1e128b985ab440598;hb=31c95e4b7390cd9fec1ff91ffbe8adb3d3378a66;hpb=e3c7080797e8eb314fa2907ece752b978288790a diff --git a/src/ddns/providers.py b/src/ddns/providers.py index 3d2d0c2..0c735fc 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 @@ -146,6 +173,58 @@ 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 DDNSProviderAllInkl(DDNSProvider): handle = "all-inkl.com" name = "All-inkl.com" @@ -175,6 +254,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" @@ -183,6 +328,7 @@ class DDNSProviderDHS(DDNSProvider): # No information about the used update api provided on webpage, # grabed from source code of ez-ipudate. + url = "http://members.dhs.org/nic/hosts" def update(self): @@ -214,6 +360,7 @@ class DDNSProviderDNSpark(DDNSProvider): # Informations to the used api can be found here: # https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation + url = "https://control.dnspark.com/api/dynamic/update.php" def update(self): @@ -261,6 +408,7 @@ class DDNSProviderDtDNS(DDNSProvider): # Information about the format of the HTTPS request is to be found # http://www.dtdns.com/dtsite/updatespec + url = "https://www.dtdns.com/api/autodns.cfm" def update(self): @@ -306,7 +454,7 @@ class DDNSProviderDtDNS(DDNSProvider): raise DDNSUpdateError -class DDNSProviderDynDNS(DDNSProvider): +class DDNSProviderDynDNS(DDNSProtocolDynDNS2, DDNSProvider): handle = "dyndns.org" name = "Dyn" website = "http://dyn.com/dns/" @@ -315,49 +463,11 @@ class DDNSProviderDynDNS(DDNSProvider): # Information about the format of the request is to be found # http://http://dyn.com/support/developers/api/perform-update/ # http://dyn.com/support/developers/api/return-codes/ - 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) + url = "https://members.dyndns.org/nic/update" -class DDNSProviderDynU(DDNSProviderDynDNS): +class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider): handle = "dynu.com" name = "Dynu" website = "http://dynu.com/" @@ -380,10 +490,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. @@ -427,14 +538,18 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider): elif "is an invalid IP address" in output: raise DDNSRequestError(_("Invalid IP address has been sent.")) + # If we got here, some other update error happened. + raise DDNSUpdateError + class DDNSProviderLightningWireLabs(DDNSProvider): handle = "dns.lightningwirelabs.com" - name = "Lightning Wire Labs" + name = "Lightning Wire Labs DNS Service" website = "http://dns.lightningwirelabs.com/" # Information about the format of the HTTPS request is to be found # https://dns.lightningwirelabs.com/knowledge-base/api/ddns + url = "https://dns.lightningwirelabs.com/update" def update(self): @@ -539,10 +654,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 @@ -559,10 +675,53 @@ 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 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 @@ -573,7 +732,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", }) @@ -652,10 +811,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" @@ -668,10 +828,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 @@ -683,10 +844,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 @@ -694,10 +856,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 @@ -714,10 +877,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 @@ -725,7 +889,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/" @@ -749,10 +913,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: