# #
###############################################################################
+import datetime
import logging
+import subprocess
import urllib2
import xml.dom.minidom
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.
DEFAULT_SETTINGS = {}
+ # holdoff time - Number of days no update is performed unless
+ # the IP address has changed.
+ holdoff_days = 30
+
+ # 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
def __cmp__(self, other):
return cmp(self.hostname, other.hostname)
+ @property
+ def db(self):
+ return self.core.db
+
def get(self, key, default=None):
"""
Get a setting from the settings dictionary.
if force:
logger.debug(_("Updating %s forced") % self.hostname)
- # Check if we actually need to update this host.
- elif self.is_uptodate(self.protocols):
- logger.debug(_("%s is already up to date") % self.hostname)
+ # Do nothing if no update is required
+ elif not self.requires_update:
return
# Execute the update.
- self.update()
+ try:
+ self.update()
+
+ # In case of any errors, log the failed request and
+ # raise the exception.
+ except DDNSError as e:
+ 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 })
+ self.core.db.log_success(self.hostname)
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 is_uptodate(self, protos):
+ 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
+
+ @property
+ 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 })
+
+ 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 })
+
+ 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 })
+
+ return False
+
+ def ip_address_changed(self, protos):
"""
Returns True if this host is already up to date
and does not need to change the IP address on the
continue
if not current_address in addresses:
- return False
+ return True
+
+ return False
- return True
+ def holdoff_time_expired(self):
+ """
+ Returns true if the holdoff time has expired
+ and the host requires an update
+ """
+ # If no holdoff days is defined, we cannot go on
+ if not self.holdoff_days:
+ return False
+
+ # Get the timestamp of the last successfull update
+ last_update = self.db.last_update(self.hostname)
+
+ # If no timestamp has been recorded, no update has been
+ # performed. An update should be performed now.
+ if not last_update:
+ return True
+
+ # Determine when the holdoff time ends
+ holdoff_end = last_update + datetime.timedelta(days=self.holdoff_days)
+
+ now = datetime.datetime.utcnow()
+
+ if now >= holdoff_end:
+ 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))
+ return False
def send_request(self, *args, **kwargs):
"""
"""
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):
"""
"""
# 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/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.
# Handle error codes.
if output == "badauth":
raise DDNSAuthenticationError
- elif output == "aduse":
+ elif output == "abuse":
raise DDNSAbuseError
elif output == "notfqdn":
raise DDNSRequestError(_("No valid FQDN was given."))
raise DDNSInternalServerError
elif output == "dnserr":
raise DDNSInternalServerError(_("DNS error encountered."))
+ elif output == "badagent":
+ raise DDNSBlockedError
# If we got here, some other update error happened.
raise DDNSUpdateError(_("Server response: %s") % output)
+class DDNSResponseParserXML(object):
+ """
+ This class provides a parser for XML responses which
+ 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.
+ xmldoc = xml.dom.minidom.parseString(document)
+
+ # Get XML elements by the given content.
+ element = xmldoc.getElementsByTagName(content)
+
+ # If no element has been found, we directly can return None.
+ if not element:
+ return None
+
+ # Only get the first child from an element, even there are more than one.
+ firstchild = element[0].firstChild
+
+ # Get the value of the child.
+ value = firstchild.nodeValue
+
+ # Return the value.
+ return value
+
+
class DDNSProviderAllInkl(DDNSProvider):
handle = "all-inkl.com"
name = "All-inkl.com"
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)
+
+ # Set the DNS zone the host should be added to.
+ zone = self.get("zone", None)
+ if zone:
+ scriptlet.append("zone %s" % zone)
+
+ 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"
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",
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.
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
}
url = "https://api.dynu.com/nic/update"
- def _prepare_request_data(self):
- data = DDNSProviderDynDNS._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
- data.update({
- "myipv6" : self.get_address("ipv6"),
- })
+ myipv6 = self.get_address("ipv6")
- return data
+ # Add update information if we have an IPv6 address.
+ if myipv6:
+ data["myipv6"] = myipv6
+
+ self._send_request(data)
class DDNSProviderEasyDNS(DDNSProtocolDynDNS2, DDNSProvider):
url = "http://api.cp.easydns.com/dyn/tomato.php"
+class DDNSProviderDomopoli(DDNSProtocolDynDNS2, DDNSProvider):
+ handle = "domopoli.de"
+ name = "domopoli.de"
+ website = "http://domopoli.de/"
+ protocols = ("ipv4",)
+
+ # https://www.domopoli.de/?page=howto#DynDns_start
+
+ 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.
+ # http://www.enom.com/APICommandCatalog/
+
+ url = "https://dynamic.name-services.com/interface.asp"
+
+ def update_protocol(self, proto):
+ data = {
+ "command" : "setdnshost",
+ "responsetype" : "xml",
+ "address" : self.get_address(proto),
+ "domainpassword" : self.password,
+ "zone" : self.hostname
+ }
+
+ # 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 self.get_xml_tag_value(output, "ErrCount") == "0":
+ return
+
+ # Handle error codes.
+ errorcode = self.get_xml_tag_value(output, "ResponseNumber")
+
+ if errorcode == "304155":
+ raise DDNSAuthenticationError
+ elif errorcode == "304153":
+ raise DDNSRequestError(_("Domain not found."))
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError
+
+
+class DDNSProviderEntryDNS(DDNSProvider):
+ handle = "entrydns.net"
+ name = "EntryDNS"
+ website = "http://entrydns.net/"
+ protocols = ("ipv4",)
+
+ # Some very tiny details about their so called "Simple API" can be found
+ # here: https://entrydns.net/help
+ url = "https://entrydns.net/records/modify"
+
+ def update_protocol(self, proto):
+ data = {
+ "ip" : self.get_address(proto),
+ }
+
+ # Add auth token to the update url.
+ url = "%s/%s" % (self.url, self.token)
+
+ # Send update to the server.
+ try:
+ response = self.send_request(url, data=data)
+
+ # Handle error codes
+ except urllib2.HTTPError, e:
+ if e.code == 404:
+ raise DDNSAuthenticationError
+
+ elif e.code == 422:
+ raise DDNSRequestError(_("An invalid IP address was submitted"))
+
+ raise
+
+ # Handle success messages.
+ if response.code == 200:
+ return
+
+ # If we got here, some other update error happened.
+ raise DDNSUpdateError
+
+
class DDNSProviderFreeDNSAfraidOrg(DDNSProvider):
handle = "freedns.afraid.org"
name = "freedns.afraid.org"
# 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.
# Send update to the server.
response = self.send_request(url, data=data)
+ # Get the full response message.
+ output = response.read()
+
+ # Handle success messages.
if output.startswith("Updated") or "has not changed" in output:
return
raise DDNSUpdateError
-class DDNSProviderNamecheap(DDNSProvider):
+class DDNSProviderMyOnlinePortal(DDNSProtocolDynDNS2, DDNSProvider):
+ handle = "myonlineportal.net"
+ name = "myonlineportal.net"
+ website = "https:/myonlineportal.net/"
+
+ # Information about the request and response can be obtained here:
+ # https://myonlineportal.net/howto_dyndns
+
+ url = "https://myonlineportal.net/updateddns"
+
+ def prepare_request_data(self, proto):
+ data = {
+ "hostname" : self.hostname,
+ "ip" : self.get_address(proto),
+ }
+
+ return data
+
+
+class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
handle = "namecheap.com"
name = "Namecheap"
website = "http://namecheap.com"
url = "https://dynamicdns.park-your-domain.com/update"
- def parse_xml(self, document, content):
- # Send input to the parser.
- xmldoc = xml.dom.minidom.parseString(document)
-
- # Get XML elements by the given content.
- element = xmldoc.getElementsByTagName(content)
-
- # If no element has been found, we directly can return None.
- if not element:
- return None
-
- # Only get the first child from an element, even there are more than one.
- firstchild = element[0].firstChild
-
- # Get the value of the child.
- value = firstchild.nodeValue
-
- # Return the value.
- return value
-
- 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
output = response.read()
# Handle success messages.
- if self.parse_xml(output, "IP") == self.get_address("ipv4"):
+ if self.get_xml_tag_value(output, "IP") == address:
return
# Handle error codes.
- errorcode = self.parse_xml(output, "ResponseNumber")
+ errorcode = self.get_xml_tag_value(output, "ResponseNumber")
if errorcode == "304156":
raise DDNSAuthenticationError
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
+
+
+class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider):
+ handle = "nsupdate.info"
+ name = "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 interface 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.token or self.get("secret")
+
+ @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, proto):
+ data = {
+ "myip" : self.get_address(proto),
+ }
+
+ return data
+
+
+class DDNSProviderOpenDNS(DDNSProtocolDynDNS2, DDNSProvider):
+ handle = "opendns.com"
+ name = "OpenDNS"
+ website = "http://www.opendns.com"
+
+ # Detailed information about the update request and possible
+ # response codes can be obtained from here:
+ # https://support.opendns.com/entries/23891440
+
+ url = "https://updates.opendns.com/nic/update"
+
+ def prepare_request_data(self, proto):
+ data = {
+ "hostname" : self.hostname,
+ "myip" : self.get_address(proto),
}
return data
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",
})
url = "https://carol.selfhost.de/nic/update"
- def _prepare_request_data(self):
- data = DDNSProviderDynDNS._prepare_request_data(self)
+ def prepare_request_data(self, proto):
+ data = DDNSProtocolDynDNS2.prepare_request_data(self, proto)
data.update({
"hostname" : "1",
})
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
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"
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
}
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
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
}
# 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
projects / oddments / ddns.git / blobdiff