]> git.ipfire.org Git - oddments/ddns.git/blobdiff - src/ddns/providers.py
dy.fi: Use HTTPS to perform updates.
[oddments/ddns.git] / src / ddns / providers.py
index 47891074e035315d259790e2c99fdb3a5ad7f573..f1fed2265c6c62510f3207039cf26f007fa3deca 100644 (file)
@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/python3
 ###############################################################################
 #                                                                             #
 # ddns - A dynamic DNS client for IPFire                                      #
@@ -23,10 +23,12 @@ import datetime
 import logging
 import os
 import subprocess
-import urllib2
+import urllib.request
+import urllib.error
+import urllib.parse
 import xml.dom.minidom
 
-from i18n import _
+from .i18n import _
 
 # Import all possible exception types.
 from .errors import *
@@ -71,24 +73,6 @@ class DDNSProvider(object):
        # 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):
-                       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
-
        @staticmethod
        def supported():
                """
@@ -105,11 +89,23 @@ class DDNSProvider(object):
                self.settings = self.DEFAULT_SETTINGS.copy()
                self.settings.update(settings)
 
+       def __init_subclass__(cls, **kwargs):
+               super().__init_subclass__(**kwargs)
+
+               if not all((cls.handle, cls.name, cls.website)):
+                       raise DDNSError(_("Provider is not properly configured"))
+
+               assert cls.handle not in _providers, \
+                       "Provider '%s' has already been registered" % cls.handle
+
+               # Register class
+               _providers[cls.handle] = cls
+
        def __repr__(self):
                return "<DDNS Provider %s (%s)>" % (self.name, self.handle)
 
        def __cmp__(self, other):
-               return cmp(self.hostname, other.hostname)
+               return (lambda a, b: (a > b)-(a < b))(self.hostname, other.hostname)
 
        @property
        def db(self):
@@ -176,8 +172,8 @@ class DDNSProvider(object):
                        self.core.db.log_failure(self.hostname, e)
                        raise
 
-               logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
-                       { "hostname" : self.hostname, "provider" : self.name })
+               logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") %
+                                       {"hostname": self.hostname, "provider": self.name})
                self.core.db.log_success(self.hostname)
 
        def update(self):
@@ -192,7 +188,7 @@ class DDNSProvider(object):
 
        def remove_protocol(self, proto):
                if not self.can_remove_records:
-                       raise RuntimeError, "can_remove_records is enabled, but remove_protocol() not implemented"
+                       raise RuntimeError("can_remove_records is enabled, but remove_protocol() not implemented")
 
                raise NotImplementedError
 
@@ -200,23 +196,21 @@ class DDNSProvider(object):
        def requires_update(self):
                # If the IP addresses have changed, an update is required
                if self.ip_address_changed(self.protocols):
-                       logger.debug(_("An update for %(hostname)s (%(provider)s)"
-                               " is performed because of an IP address change") % \
-                               { "hostname" : self.hostname, "provider" : self.name })
+                       logger.debug(_("An update for %(hostname)s (%(provider)s) is performed because of an IP address change") %
+                       {"hostname": self.hostname, "provider": self.name})
 
                        return True
 
                # If the holdoff time has expired, an update is required, too
                if self.holdoff_time_expired():
-                       logger.debug(_("An update for %(hostname)s (%(provider)s)"
-                               " is performed because the holdoff time has expired") % \
-                               { "hostname" : self.hostname, "provider" : self.name })
+                       logger.debug(_("An update for %(hostname)s (%(provider)s) is performed because the holdoff time has expired") %
+                                                {"hostname": self.hostname, "provider": self.name})
 
                        return True
 
                # Otherwise, we don't need to perform an update
-               logger.debug(_("No update required for %(hostname)s (%(provider)s)") % \
-                       { "hostname" : self.hostname, "provider" : self.name })
+               logger.debug(_("No update required for %(hostname)s (%(provider)s)") %
+                                        {"hostname": self.hostname, "provider": self.name})
 
                return False
 
@@ -234,8 +228,7 @@ class DDNSProvider(object):
 
                # 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(_("An update has not been performed because earlier updates failed for %s") % self.hostname)
                        logger.warning(_("There will be no retries"))
 
                        return True
@@ -248,8 +241,7 @@ class DDNSProvider(object):
                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)
+                       logger.warning(_("An update has not been performed because earlier updates failed for %s") % self.hostname)
 
                        if failure_message:
                                logger.warning(_("Last failure message:"))
@@ -315,8 +307,8 @@ class DDNSProvider(object):
                        logger.debug("The holdoff time has expired for %s" % self.hostname)
                        return True
                else:
-                       logger.debug("Updates for %s are held off until %s" % \
-                               (self.hostname, holdoff_end))
+                       logger.debug("Updates for %s are held off until %s" %
+                                                (self.hostname, holdoff_end))
                        return False
 
        def send_request(self, *args, **kwargs):
@@ -375,11 +367,10 @@ class DDNSProtocolDynDNS2(object):
 
        def send_request(self, data):
                # Send update to the server.
-               response = DDNSProvider.send_request(self, self.url, data=data,
-                       username=self.username, password=self.password)
+               response = DDNSProvider.send_request(self, self.url, data=data, username=self.username, password=self.password)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if output.startswith("good") or output.startswith("nochg"):
@@ -413,7 +404,7 @@ class DDNSResponseParserXML(object):
                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.
@@ -456,7 +447,7 @@ class DDNSProviderAllInkl(DDNSProvider):
                response = self.send_request(self.url, username=self.username, password=self.password)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if output.startswith("good") or output.startswith("nochg"):
@@ -494,9 +485,7 @@ class DDNSProviderBindNsupdate(DDNSProvider):
                # -t sets the timeout
                command = ["nsupdate", "-v", "-t", "60"]
 
-               p = subprocess.Popen(command, shell=True,
-                       stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
-               )
+               p = subprocess.Popen(command, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
                stdout, stderr = p.communicate(scriptlet)
 
                if p.returncode == 0:
@@ -570,11 +559,10 @@ class DDNSProviderChangeIP(DDNSProvider):
 
                # Send update to the server.
                try:
-                       response = self.send_request(self.url, username=self.username, password=self.password,
-                               data=data)
+                       response = self.send_request(self.url, username=self.username, password=self.password, data=data)
 
                # Handle error codes.
-               except urllib2.HTTPError, e:
+               except urllib.error.HTTPError as e:
                        if e.code == 422:
                                raise DDNSRequestError(_("Domain not found."))
 
@@ -703,8 +691,7 @@ class DDNSProviderDHS(DDNSProvider):
                }
 
                # Send update to the server.
-               response = self.send_request(self.url, username=self.username, password=self.password,
-                       data=data)
+               response = self.send_request(self.url, username=self.username, password=self.password, data=data)
 
                # Handle success messages.
                if response.code == 200:
@@ -733,11 +720,10 @@ class DDNSProviderDNSpark(DDNSProvider):
                }
 
                # Send update to the server.
-               response = self.send_request(self.url, username=self.username, password=self.password,
-                       data=data)
+               response = self.send_request(self.url, username=self.username, password=self.password, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if output.startswith("ok") or output.startswith("nochange"):
@@ -786,7 +772,7 @@ class DDNSProviderDtDNS(DDNSProvider):
                response = self.send_request(self.url, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Remove all leading and trailing whitespace.
                output = output.strip()
@@ -840,7 +826,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
@@ -897,20 +883,19 @@ class DDNSProviderDynUp(DDNSProvider):
                response = self.send_request(self.url, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Remove all leading and trailing whitespace.
                output = output.strip()
 
                # Handle success messages.
-               if output.startswith("I:OK") :
+               if output.startswith("I:OK"):
                        return
 
                # If we got here, some other update error happened.
                raise DDNSUpdateError
 
 
-
 class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider):
        handle    = "dynu.com"
        name      = "Dynu"
@@ -957,11 +942,10 @@ class DDNSProviderEasyDNS(DDNSProvider):
                }
 
                # Send update to the server.
-               response = self.send_request(self.url, data=data,
-                       username=self.username, password=self.password)
+               response = self.send_request(self.url, data=data, username=self.username, password=self.password)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Remove all leading and trailing whitespace.
                output = output.strip()
@@ -1023,7 +1007,7 @@ class DDNSProviderDynsNet(DDNSProvider):
                response = self.send_request(self.url, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if output.startswith("200"):
@@ -1069,7 +1053,7 @@ class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider):
                response = self.send_request(self.url, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if self.get_xml_tag_value(output, "ErrCount") == "0":
@@ -1111,7 +1095,7 @@ class DDNSProviderEntryDNS(DDNSProvider):
                        response = self.send_request(url, data=data)
 
                # Handle error codes
-               except urllib2.HTTPError, e:
+               except urllib.error.HTTPError as e:
                        if e.code == 404:
                                raise DDNSAuthenticationError
 
@@ -1150,7 +1134,7 @@ class DDNSProviderFreeDNSAfraidOrg(DDNSProvider):
                response = self.send_request(url, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if output.startswith("Updated") or "has not changed" in output:
@@ -1204,6 +1188,51 @@ class DDNSProviderJoker(DDNSProtocolDynDNS2, DDNSProvider):
                url = "https://svc.joker.com/nic/update"
 
 
+class DDNSProviderKEYSYSTEMS(DDNSProvider):
+       handle    = "key-systems.net"
+       name      = "dynamicdns.key-systems.net"
+       website   = "https://domaindiscount24.com/"
+       protocols = ("ipv4",)
+
+       # There are only information provided by the domaindiscount24 how to
+       # perform an update with HTTP APIs
+       # https://www.domaindiscount24.com/faq/dynamic-dns
+       # examples: https://dynamicdns.key-systems.net/update.php?hostname=hostname&password=password&ip=auto
+       #           https://dynamicdns.key-systems.net/update.php?hostname=hostname&password=password&ip=213.x.x.x&mx=213.x.x.x
+
+       url = "https://dynamicdns.key-systems.net/update.php"
+       can_remove_records = False
+
+       def update_protocol(self, proto):
+               address = self.get_address(proto)
+               data = {
+                       "hostname"      : self.hostname,
+                       "password"      : self.password,
+                       "ip"            : address,
+               }
+
+               # Send update to the server.
+               response = self.send_request(self.url, data=data)
+
+               # Get the full response message.
+               output = response.read().decode()
+
+               # Handle success messages.
+               if "code = 200" in output:
+                       return
+
+               # Handle error messages.
+               if "abuse prevention triggered" in output:
+                       raise DDNSAbuseError
+               elif "invalid password" in output:
+                       raise DDNSAuthenticationError
+               elif "Authorization failed" in output:
+                       raise DDNSRequestError(_("Invalid hostname specified"))
+
+               # If we got here, some other update error happened.
+               raise DDNSUpdateError
+
+
 class DDNSProviderGoogle(DDNSProtocolDynDNS2, DDNSProvider):
         handle    = "domains.google.com"
         name      = "Google Domains"
@@ -1219,7 +1248,7 @@ class DDNSProviderGoogle(DDNSProtocolDynDNS2, DDNSProvider):
 class DDNSProviderLightningWireLabs(DDNSProvider):
        handle    = "dns.lightningwirelabs.com"
        name      = "Lightning Wire Labs DNS Service"
-       website   = "http://dns.lightningwirelabs.com/"
+       website   = "https://dns.lightningwirelabs.com/"
 
        # Information about the format of the HTTPS request is to be found
        # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
@@ -1227,27 +1256,17 @@ class DDNSProviderLightningWireLabs(DDNSProvider):
        url = "https://dns.lightningwirelabs.com/update"
 
        def update(self):
+               # Raise an error if no auth details are given.
+               if not self.token:
+                       raise DDNSConfigurationError
+
                data =  {
                        "hostname" : self.hostname,
+                       "token"    : self.token,
                        "address6" : self.get_address("ipv6", "-"),
                        "address4" : self.get_address("ipv4", "-"),
                }
 
-               # Check if a token has been set.
-               if self.token:
-                       data["token"] = self.token
-
-               # Check for username and password.
-               elif self.username and self.password:
-                       data.update({
-                               "username" : self.username,
-                               "password" : 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)
 
@@ -1321,7 +1340,7 @@ class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
                response = self.send_request(self.url, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if self.get_xml_tag_value(output, "IP") == address:
@@ -1344,7 +1363,7 @@ class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
 
 
 class DDNSProviderNOIP(DDNSProtocolDynDNS2, DDNSProvider):
-       handle    = "noip.com"
+       handle    = "no-ip.com"
        name      = "NoIP"
        website   = "http://www.noip.com/"
        protocols = ("ipv4",)
@@ -1488,7 +1507,7 @@ class DDNSProviderRegfish(DDNSProvider):
                        data["ipv4"] = address4
 
                # Raise an error if none address is given.
-               if not data.has_key("ipv6") and not data.has_key("ipv4"):
+               if "ipv6" not in data and "ipv4" not in data:
                        raise DDNSConfigurationError
 
                # Check if a token has been set.
@@ -1506,11 +1525,10 @@ class DDNSProviderRegfish(DDNSProvider):
                        response = self.send_request(self.url, data=data)
                else:
                        # Send update to the server.
-                       response = self.send_request(self.url, username=self.username, password=self.password,
-                               data=data)
+                       response = self.send_request(self.url, username=self.username, password=self.password, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if "100" in output or "101" in output:
@@ -1581,7 +1599,7 @@ class DDNSProviderServercow(DDNSProvider):
                response = self.send_request(self.url, data=data)
 
                # Read response
-               output = response.read()
+               output = response.read().decode()
 
                # Server responds with OK if update was successful
                if output.startswith("OK"):
@@ -1726,11 +1744,10 @@ class DDNSProviderZoneedit(DDNSProvider):
                }
 
                # Send update to the server.
-               response = self.send_request(self.url, username=self.username, password=self.password,
-                       data=data)
+               response = self.send_request(self.url, username=self.username, password=self.password, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if output.startswith("<SUCCESS"):
@@ -1773,7 +1790,7 @@ class DDNSProviderDNSmadeEasy(DDNSProvider):
                response = self.send_request(self.url, data=data)
 
                # Get the full response message.
-               output = response.read()
+               output = response.read().decode()
 
                # Handle success messages.
                if output.startswith("success") or output.startswith("error-record-ip-same"):