-#!/usr/bin/python
+#!/usr/bin/python3
###############################################################################
# #
# ddns - A dynamic DNS client for IPFire #
import datetime
import logging
+import json
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 *
# 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
+ # True if the provider supports authentication via a random
+ # generated token instead of username and password.
+ supports_token_auth = True
@staticmethod
def supported():
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):
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):
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
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
# 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
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:"))
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):
# 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,
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"):
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.
protocols = ("ipv4",)
# There are only information provided by the vendor how to
- # perform an update on a FRITZ Box. Grab requried informations
+ # perform an update on a FRITZ Box. Grab required information
# from the net.
# http://all-inkl.goetze.it/v01/ddns-mit-einfachen-mitteln/
- url = "http://dyndns.kasserver.com"
+ url = "https://dyndns.kasserver.com"
can_remove_records = False
+ supports_token_auth = False
def update(self):
# There is no additional data required so we directly can
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"):
DEFAULT_TTL = 60
+ supports_token_auth = False
+
@staticmethod
def supported():
# Search if the nsupdate utility is available
# -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:
logger.debug(" %s" % line)
- return "\n".join(scriptlet)
+ return "\n".join(scriptlet).encode()
class DDNSProviderChangeIP(DDNSProvider):
url = "https://nic.changeip.com/nic/update"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
# 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."))
# http://www.ddnss.de/info.php
# http://www.megacomputing.de/2014/08/dyndns-service-response-time/#more-919
- url = "http://www.ddnss.de/upd.php"
+ url = "https://www.ddnss.de/upd.php"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
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":
# No information about the used update api provided on webpage,
# grabed from source code of ez-ipudate.
- url = "http://members.dhs.org/nic/hosts"
+ # Provider currently does not support TLS 1.2.
+ url = "https://members.dhs.org/nic/hosts"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
}
# 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:
url = "https://control.dnspark.com/api/dynamic/update.php"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
}
# 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"):
url = "https://www.dtdns.com/api/autodns.cfm"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
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()
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
- url = "https://www.duckdns.org/nic/update"
+ 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
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError
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
url = "https://dynup.de/dyn.php"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
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"
# (API 1.3) are available on the providers webpage.
# https://fusion.easydns.com/index.php?/Knowledgebase/Article/View/102/7/dynamic-dns
- url = "http://api.cp.easydns.com/dyn/tomato.php"
+ url = "https://api.cp.easydns.com/dyn/tomato.php"
+
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
}
# 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()
# https://www.domopoli.de/?page=howto#DynDns_start
- url = "http://dyndns.domopoli.de/nic/update"
+ # This provider does not support TLS 1.2.
+ url = "https://dyndns.domopoli.de/nic/update"
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)
# http://www.dyns.net/documentation/technical/protocol/
- url = "http://www.dyns.net/postscript011.php"
+ url = "https://www.dyns.net/postscript011.php"
def update_protocol(self, proto):
data = {
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"):
url = "https://dynamic.name-services.com/interface.asp"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
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":
# 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 = {
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
# No information about the request or response could be found on the vendor
# page. All used values have been collected by testing.
- url = "https://freedns.afraid.org/dynamic/update.php"
+ url = "https://sync.afraid.org/u/"
can_remove_records = False
+ supports_token_auth = True
def update_protocol(self, proto):
- data = {
- "address" : self.get_address(proto),
- }
# Add auth token to the update url.
- url = "%s?%s" % (self.url, self.token)
+ url = "%s%s/" % (self.url, self.token)
# Send update to the server.
- response = self.send_request(url, data=data)
+ response = self.send_request(url)
# 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:
+ if output.startswith("Updated") or output.startswith("No IP change detected"):
return
# Handle error codes.
raise DDNSUpdateError
+class DDNSProviderGodaddy(DDNSProvider):
+ handle = "godaddy.com"
+ name = "godaddy.com"
+ website = "https://godaddy.com/"
+ protocols = ("ipv4",)
+
+ # Information about the format of the HTTP request is to be found
+ # here: https://developer.godaddy.com/doc/endpoint/domains#/v1/recordReplaceTypeName
+ url = "https://api.godaddy.com/v1/domains/"
+ can_remove_records = False
+
+ def update_protocol(self, proto):
+ # retrieve ip
+ ip_address = self.get_address(proto)
+
+ # set target url
+ url = f"{self.url}/{self.hostname}/records/A/@"
+
+ # prepare data
+ data = json.dumps([{"data": ip_address, "ttl": 600, "name": self.hostname, "type": "A"}]).encode("utf-8")
+
+ # Method requires authentication by special headers.
+ request = urllib.request.Request(url=url,
+ data=data,
+ headers={"Authorization": f"sso-key {self.username}:{self.password}",
+ "Content-Type": "application/json"},
+ method="PUT")
+ result = urllib.request.urlopen(request)
+
+ # handle success
+ if result.code == 200:
+ return
+
+ # handle errors
+ if result.code == 400:
+ raise DDNSRequestError(_("Malformed request received."))
+ if result.code in (401, 403):
+ raise DDNSAuthenticationError
+ if result.code == 404:
+ raise DDNSRequestError(_("Resource not found."))
+ if result.code == 422:
+ raise DDNSRequestError(_("Record does not fulfill the schema."))
+ if result.code == 429:
+ raise DDNSRequestError(_("API Rate limiting."))
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError
+
+
+class DDNSProviderHENet(DDNSProtocolDynDNS2, DDNSProvider):
+ handle = "he.net"
+ name = "he.net"
+ website = "https://he.net"
+ protocols = ("ipv6", "ipv4",)
+
+ # Detailed information about the update api can be found here.
+ # http://dns.he.net/docs.html
+
+ url = "https://dyn.dns.he.net/nic/update"
+ @property
+ def username(self):
+ return self.get("hostname")
+
+
+
class DDNSProviderItsdns(DDNSProtocolDynDNS2, DDNSProvider):
handle = "inwx.com"
name = "INWX"
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
+ supports_token_auth = 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"
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
+ supports_token_auth = True
+
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)
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.
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:
class DDNSProviderNOIP(DDNSProtocolDynDNS2, DDNSProvider):
handle = "no-ip.com"
- name = "No-IP"
- website = "http://www.no-ip.com/"
+ name = "NoIP"
+ website = "http://www.noip.com/"
protocols = ("ipv4",)
# Information about the format of the HTTP request is to be found
- # here: http://www.no-ip.com/integrate/request and
- # here: http://www.no-ip.com/integrate/response
+ # here: http://www.noip.com/integrate/request and
+ # here: http://www.noip.com/integrate/response
- url = "http://dynupdate.no-ip.com/nic/update"
+ url = "https://dynupdate.noip.com/nic/update"
def prepare_request_data(self, proto):
assert proto == "ipv4"
# 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
url = "https://dyndns.regfish.de/"
can_remove_records = False
+ supports_token_auth = True
def update(self):
data = {
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.
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:
url = "https://www.servercow.de/dnsupdate/update.php"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
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"):
url = "https://update.spdyn.de/nic/update"
+ supports_token_auth = True
+
@property
def username(self):
return self.get("username") or self.hostname
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
}
# 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"):
url = "https://cp.dnsmadeeasy.com/servlet/updateip?"
can_remove_records = False
+ supports_token_auth = False
def update_protocol(self, proto):
data = {
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"):
url = "https://zzzz.io/api/v1/update"
can_remove_records = False
+ supports_token_auth = True
def update_protocol(self, proto):
data = {
# If we got here, some other update error happened.
raise DDNSUpdateError
+
+class DDNSProviderInfomaniak(DDNSProtocolDynDNS2, DDNSProvider):
+ handle = "infomaniak.ch"
+ name = "infomaniak"
+ website = "https://www.infomaniak.ch"
+ protocols = ("ipv4",)
+
+ # Detailed information about how to send the update request and possible response
+ # codes can be obtained from here.
+ # https://www.infomaniak.com/de/support/faq/2376/dyndns-aktualisieren-eines-dynamischen-dns-uber-die-api
+
+ url = "https://infomaniak.com/nic/update"
projects / oddments / ddns.git / commitdiff
