providers.py: Proper encode string.

[ddns.git] / src / ddns / providers.py

diff --git a/src/ddns/providers.py b/src/ddns/providers.py
index dcdc5daa21200837cf7f489568b78cf41b01f4ac..56e6620c78ab3d9de1c945147f86e70a8d8614d7 100644 (file)
--- a/src/ddns/providers.py
+++ b/src/ddns/providers.py
@@ -73,6 +73,10 @@ class DDNSProvider(object):
        # Required to remove AAAA records if IPv6 is absent again.
        can_remove_records = True
 
+       # True if the provider supports authentication via a random
+       # generated token instead of username and password.
+       supports_token_auth = True
+
        @staticmethod
        def supported():
                """
@@ -352,6 +356,10 @@ class DDNSProtocolDynDNS2(object):
        # The DynDNS protocol version 2 does not allow to remove records
        can_remove_records = False
 
+       # The DynDNS protocol version 2 only supports authentication via
+       # username and password.
+       supports_token_auth = False
+
        def prepare_request_data(self, proto):
                data = {
                        "hostname" : self.hostname,
@@ -440,6 +448,7 @@ class DDNSProviderAllInkl(DDNSProvider):
 
        url = "http://dyndns.kasserver.com"
        can_remove_records = False
+       supports_token_auth = False
 
        def update(self):
                # There is no additional data required so we directly can
@@ -464,6 +473,8 @@ class DDNSProviderBindNsupdate(DDNSProvider):
 
        DEFAULT_TTL = 60
 
+       supports_token_auth = False
+
        @staticmethod
        def supported():
                # Search if the nsupdate utility is available
@@ -536,7 +547,7 @@ class DDNSProviderBindNsupdate(DDNSProvider):
 
                        logger.debug("  %s" % line)
 
-               return "\n".join(scriptlet)
+               return "\n".join(scriptlet).encode()
 
 
 class DDNSProviderChangeIP(DDNSProvider):
@@ -550,6 +561,7 @@ class DDNSProviderChangeIP(DDNSProvider):
 
        url = "https://nic.changeip.com/nic/update"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -616,6 +628,7 @@ class DDNSProviderDDNSS(DDNSProvider):
 
        url = "http://www.ddnss.de/upd.php"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -642,10 +655,8 @@ class DDNSProviderDDNSS(DDNSProvider):
                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')
+               output = response.getheader('ddnss-response')
 
                # Handle success messages.
                if output == "good" or output == "nochg":
@@ -680,6 +691,7 @@ class DDNSProviderDHS(DDNSProvider):
 
        url = "http://members.dhs.org/nic/hosts"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -712,6 +724,7 @@ class DDNSProviderDNSpark(DDNSProvider):
 
        url = "https://control.dnspark.com/api/dynamic/update.php"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -760,6 +773,7 @@ class DDNSProviderDtDNS(DDNSProvider):
 
        url = "https://www.dtdns.com/api/autodns.cfm"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -804,16 +818,63 @@ class DDNSProviderDtDNS(DDNSProvider):
                raise DDNSUpdateError
 
 
-class DDNSProviderDuckDNS(DDNSProtocolDynDNS2, DDNSProvider):
+class DDNSProviderDuckDNS(DDNSProvider):
        handle    = "duckdns.org"
        name      = "Duck DNS"
        website   = "http://www.duckdns.org/"
-       protocols = ("ipv4",)
+       protocols = ("ipv6", "ipv4",)
 
        # Information about the format of the request is to be found
-       # https://www.duckdns.org/install.jsp
+       # https://www.duckdns.org/spec.jsp
+
+       url = "https://www.duckdns.org/update"
+       can_remove_records = False
+       supports_token_auth = True
+
+       def update(self):
+               # Raise an error if no auth details are given.
+               if not self.token:
+                       raise DDNSConfigurationError
+
+               data =  {
+                       "domains" : self.hostname,
+                       "token"    : self.token,
+               }
+
+               # Check if we update an IPv4 address.
+               address4 = self.get_address("ipv4")
+               if address4:
+                       data["ip"] = address4
+
+               # Check if we update an IPv6 address.
+               address6 = self.get_address("ipv6")
+               if address6:
+                       data["ipv6"] = address6
+
+               # Raise an error if no address is given.
+               if "ip" not in data and "ipv6" not in data:
+                       raise DDNSConfigurationError
+
+               # Send update to the server.
+               response = self.send_request(self.url, data=data)
+
+               # Get the full response message.
+               output = response.read().decode()
+
+               # Remove all leading and trailing whitespace.
+               output = output.strip()
+
+               # Handle success messages.
+               if output == "OK":
+                       return
+
+               # The provider does not give detailed information
+               # if the update fails. Only a "KO" will be sent back.
+               if output == "KO":
+                       raise DDNSUpdateError
 
-       url = "https://www.duckdns.org/nic/update"
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError
 
 
 class DDNSProviderDyFi(DDNSProtocolDynDNS2, DDNSProvider):
@@ -826,7 +887,7 @@ class DDNSProviderDyFi(DDNSProtocolDynDNS2, DDNSProvider):
        # https://www.dy.fi/page/clients?lang=en
        # https://www.dy.fi/page/specification?lang=en
 
-       url = "http://www.dy.fi/nic/update"
+       url = "https://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
@@ -870,6 +931,7 @@ class DDNSProviderDynUp(DDNSProvider):
 
        url = "https://dynup.de/dyn.php"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -935,6 +997,8 @@ class DDNSProviderEasyDNS(DDNSProvider):
 
        url = "http://api.cp.easydns.com/dyn/tomato.php"
 
+       supports_token_auth = False
+
        def update_protocol(self, proto):
                data = {
                        "myip"     : self.get_address(proto, "-"),
@@ -988,6 +1052,7 @@ class DDNSProviderDynsNet(DDNSProvider):
        website   = "http://www.dyns.net/"
        protocols = ("ipv4",)
        can_remove_records = False
+       supports_token_auth = 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)
@@ -1039,6 +1104,7 @@ class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider):
 
        url = "https://dynamic.name-services.com/interface.asp"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -1081,6 +1147,7 @@ class DDNSProviderEntryDNS(DDNSProvider):
        # here: https://entrydns.net/help
        url = "https://entrydns.net/records/modify"
        can_remove_records = False
+       supports_token_auth = True
 
        def update_protocol(self, proto):
                data = {
@@ -1121,6 +1188,7 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider):
        # page. All used values have been collected by testing.
        url = "https://freedns.afraid.org/dynamic/update.php"
        can_remove_records = False
+       supports_token_auth = True
 
        def update_protocol(self, proto):
                data = {
@@ -1202,6 +1270,7 @@ class DDNSProviderKEYSYSTEMS(DDNSProvider):
 
        url = "https://dynamicdns.key-systems.net/update.php"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                address = self.get_address(proto)
@@ -1253,6 +1322,8 @@ class DDNSProviderLightningWireLabs(DDNSProvider):
        # Information about the format of the HTTPS request is to be found
        # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
 
+       supports_token_auth = True
+
        url = "https://dns.lightningwirelabs.com/update"
 
        def update(self):
@@ -1321,6 +1392,7 @@ class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
 
        url = "https://dynamicdns.park-your-domain.com/update"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                # Namecheap requires the hostname splitted into a host and domain part.
@@ -1414,6 +1486,8 @@ class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider):
        # has not been implemented here, yet.
        can_remove_records = False
 
+       supports_token_auth = True
+
        # After a failed update, there will be no retries
        # https://bugzilla.ipfire.org/show_bug.cgi?id=10603
        holdoff_failure_days = None
@@ -1490,6 +1564,7 @@ class DDNSProviderRegfish(DDNSProvider):
 
        url = "https://dyndns.regfish.de/"
        can_remove_records = False
+       supports_token_auth = True
 
        def update(self):
                data = {
@@ -1586,6 +1661,7 @@ class DDNSProviderServercow(DDNSProvider):
 
        url = "https://www.servercow.de/dnsupdate/update.php"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -1627,6 +1703,8 @@ class DDNSProviderSPDNS(DDNSProtocolDynDNS2, DDNSProvider):
 
        url = "https://update.spdyn.de/nic/update"
 
+       supports_token_auth = True
+
        @property
        def username(self):
                return self.get("username") or self.hostname
@@ -1730,6 +1808,8 @@ class DDNSProviderZoneedit(DDNSProvider):
        website   = "http://www.zoneedit.com"
        protocols = ("ipv4",)
 
+       supports_token_auth = False
+
        # Detailed information about the request and the response codes can be
        # obtained here:
        # http://www.zoneedit.com/doc/api/other.html
@@ -1777,6 +1857,7 @@ class DDNSProviderDNSmadeEasy(DDNSProvider):
 
        url = "https://cp.dnsmadeeasy.com/servlet/updateip?"
        can_remove_records = False
+       supports_token_auth = False
 
        def update_protocol(self, proto):
                data = {
@@ -1827,6 +1908,7 @@ class DDNSProviderZZZZ(DDNSProvider):
 
        url = "https://zzzz.io/api/v1/update"
        can_remove_records = False
+       supports_token_auth = True
 
        def update_protocol(self, proto):
                data = {