]> git.ipfire.org Git - oddments/ddns.git/blobdiff - src/ddns/providers.py
spdns.de: Add support for IPv6.
[oddments/ddns.git] / src / ddns / providers.py
index 00a3855bbffab6d61679ccc7614eaac0cef18352..2a89b5009bbb34b45589edbce2d4ddcb6e6a4a7e 100644 (file)
@@ -140,8 +140,23 @@ class DDNSProvider(object):
                        { "hostname" : self.hostname, "provider" : self.name })
 
        def update(self):
+               for protocol in self.protocols:
+                       if self.have_address(protocol):
+                               self.update_protocol(protocol)
+                       else:
+                               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 })
+
+               # Maybe this will raise NotImplementedError at some time
+               #raise NotImplementedError
+
        def is_uptodate(self, protos):
                """
                        Returns True if this host is already up to date
@@ -176,6 +191,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):
        """
@@ -189,19 +216,22 @@ class DDNSProtocolDynDNS2(object):
        # http://dyn.com/support/developers/api/perform-update/
        # http://dyn.com/support/developers/api/return-codes/
 
-       def _prepare_request_data(self):
+       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.
@@ -371,10 +401,10 @@ class DDNSProviderDHS(DDNSProvider):
 
        url = "http://members.dhs.org/nic/hosts"
 
-       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",
@@ -403,10 +433,10 @@ class DDNSProviderDNSpark(DDNSProvider):
 
        url = "https://control.dnspark.com/api/dynamic/update.php"
 
-       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.
@@ -451,9 +481,9 @@ class DDNSProviderDtDNS(DDNSProvider):
 
        url = "https://www.dtdns.com/api/autodns.cfm"
 
-       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
                }
@@ -519,8 +549,10 @@ class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider):
 
        url = "https://api.dynu.com/nic/update"
 
-       def _prepare_request_data(self):
-               data = DDNSProtocolDynDNS2._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
                myipv6 = self.get_address("ipv6")
@@ -529,7 +561,7 @@ class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider):
                if myipv6:
                        data["myipv6"] = myipv6
 
-               return data
+               self._send_request(data)
 
 
 class DDNSProviderEasyDNS(DDNSProtocolDynDNS2, DDNSProvider):
@@ -556,10 +588,55 @@ class DDNSProviderDomopoli(DDNSProtocolDynDNS2, DDNSProvider):
        url = "http://dyndns.domopoli.de/nic/update"
 
 
+class DDNSProviderDynsNet(DDNSProvider):
+       handle    = "dyns.net"
+       name      = "DyNS"
+       website   = "http://www.dyns.net/"
+       protocols = ("ipv4",)
+
+       # 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.
@@ -567,11 +644,11 @@ class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider):
 
        url = "https://dynamic.name-services.com/interface.asp"
 
-       def update(self):
+       def update_protocol(self, proto):
                data = {
                        "command"        : "setdnshost",
                        "responsetype"   : "xml",
-                       "address"        : self.get_address("ipv4"),
+                       "address"        : self.get_address(proto),
                        "domainpassword" : self.password,
                        "zone"           : self.hostname
                }
@@ -608,9 +685,9 @@ class DDNSProviderEntryDNS(DDNSProvider):
        # here: https://entrydns.net/help
        url = "https://entrydns.net/records/modify"
 
-       def update(self):
+       def update_protocol(self, proto):
                data = {
-                       "ip" : self.get_address("ipv4")
+                       "ip" : self.get_address(proto),
                }
 
                # Add auth token to the update url.
@@ -647,15 +724,9 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider):
        # page. All used values have been collected by testing.
        url = "https://freedns.afraid.org/dynamic/update.php"
 
-       @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.
@@ -736,12 +807,12 @@ class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
 
        url = "https://dynamicdns.park-your-domain.com/update"
 
-       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)
 
                data = {
-                       "ip"       : self.get_address("ipv4"),
+                       "ip"       : self.get_address(proto),
                        "password" : self.password,
                        "host"     : host,
                        "domain"   : domain
@@ -754,7 +825,7 @@ class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
                output = response.read()
 
                # Handle success messages.
-               if self.get_xml_tag_value(output, "IP") == self.get_address("ipv4"):
+               if self.get_xml_tag_value(output, "IP") == address:
                        return
 
                # Handle error codes.
@@ -785,10 +856,12 @@ 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
@@ -797,11 +870,11 @@ class DDNSProviderNOIP(DDNSProtocolDynDNS2, DDNSProvider):
 class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider):
        handle    = "nsupdate.info"
        name      = "nsupdate.info"
-       website   = "http://www.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 intrface and here:
+       # after login on the provider user interface and here:
        # http://nsupdateinfo.readthedocs.org/en/latest/user.html
 
        # Nsupdate.info uses the hostname as user part for the HTTP basic auth,
@@ -814,10 +887,6 @@ class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider):
        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.
@@ -828,9 +897,9 @@ class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider):
                else:
                        raise DDNSUpdateError(_("Invalid protocol has been given"))
 
-       def _prepare_request_data(self):
+       def prepare_request_data(self, proto):
                data = {
-                       "myip" : self.get_address(self.proto),
+                       "myip" : self.get_address(proto),
                }
 
                return data
@@ -847,14 +916,10 @@ class DDNSProviderOpenDNS(DDNSProtocolDynDNS2, DDNSProvider):
 
        url = "https://updates.opendns.com/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
@@ -874,8 +939,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",
                })
@@ -962,8 +1027,8 @@ class DDNSProviderSelfhost(DDNSProtocolDynDNS2, DDNSProvider):
 
        url = "https://carol.selfhost.de/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({
                        "hostname" : "1",
                })
@@ -975,7 +1040,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
@@ -986,6 +1050,14 @@ class DDNSProviderSPDNS(DDNSProtocolDynDNS2, DDNSProvider):
 
        url = "https://update.spdns.de/nic/update"
 
+       @property
+       def username(self):
+               return self.get("username") or self.hostname
+
+       @property
+       def password(self):
+               return self.get("username") or self.token
+
 
 class DDNSProviderStrato(DDNSProtocolDynDNS2, DDNSProvider):
        handle    = "strato.com"
@@ -1011,9 +1083,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
                }
 
@@ -1043,14 +1117,10 @@ 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
@@ -1069,13 +1139,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
                }
 
@@ -1100,3 +1166,49 @@ class DDNSProviderZoneedit(DDNSProtocolDynDNS2, DDNSProvider):
 
                # If we got here, some other update error happened.
                raise DDNSUpdateError
+
+
+class DDNSProviderZZZZ(DDNSProvider):
+       handle    = "zzzz.io"
+       name      = "zzzz"
+       website   = "https://zzzz.io"
+       protocols = ("ipv6", "ipv4",)
+
+       # Detailed information about the update request can be found here:
+       # https://zzzz.io/faq/
+
+       # Details about the possible response codes have been provided in the bugtracker:
+       # https://bugzilla.ipfire.org/show_bug.cgi?id=10584#c2
+
+       url = "https://zzzz.io/api/v1/update"
+
+       def update_protocol(self, proto):
+               data = {
+                       "ip"    : self.get_address(proto),
+                       "token" : self.token,
+               }
+
+               if proto == "ipv6":
+                       data["type"] = "aaaa"
+
+               # zzzz uses the host from the full hostname as part
+               # of the update url.
+               host, domain = self.hostname.split(".", 1)
+
+               # Add host value to the update url.
+               url = "%s/%s" % (self.url, host)
+
+               # Send update to the server.
+               try:
+                       response = self.send_request(url, data=data)
+
+               # Handle error codes.
+               except DDNSNotFound:
+                       raise DDNSRequestError(_("Invalid hostname specified"))
+
+               # Handle success messages.
+               if response.code == 200:
+                       return
+
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError