src/ddns/providers.py

   1 #!/usr/bin/python
   2 ###############################################################################
   3 #                                                                             #
   4 # ddns - A dynamic DNS client for IPFire                                      #
   5 # Copyright (C) 2012 IPFire development team                                  #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU General Public License as published by        #
   9 # the Free Software Foundation, either version 3 of the License, or           #
  10 # (at your option) any later version.                                         #
  11 #                                                                             #
  12 # This program is distributed in the hope that it will be useful,             #
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  15 # GNU General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 import datetime
  23 import logging
  24 import os
  25 import subprocess
  26 import urllib2
  27 import xml.dom.minidom
  28
  29 from i18n import _
  30
  31 # Import all possible exception types.
  32 from .errors import *
  33
  34 logger = logging.getLogger("ddns.providers")
  35 logger.propagate = 1
  36
  37 _providers = {}
  38
  39 def get():
  40         """
  41                 Returns a dict with all automatically registered providers.
  42         """
  43         return _providers.copy()
  44
  45 class DDNSProvider(object):
  46         # A short string that uniquely identifies
  47         # this provider.
  48         handle = None
  49
  50         # The full name of the provider.
  51         name = None
  52
  53         # A weburl to the homepage of the provider.
  54         # (Where to register a new account?)
  55         website = None
  56
  57         # A list of supported protocols.
  58         protocols = ("ipv6", "ipv4")
  59
  60         DEFAULT_SETTINGS = {}
  61
  62         # holdoff time - Number of days no update is performed unless
  63         # the IP address has changed.
  64         holdoff_days = 30
  65
  66         # holdoff time for update failures - Number of days no update
  67         # is tried after the last one has failed.
  68         holdoff_failure_days = 0.5
  69
  70         # True if the provider is able to remove records, too.
  71         # Required to remove AAAA records if IPv6 is absent again.
  72         can_remove_records = True
  73
  74         # Automatically register all providers.
  75         class __metaclass__(type):
  76                 def __init__(provider, name, bases, dict):
  77                         type.__init__(provider, name, bases, dict)
  78
  79                         # The main class from which is inherited is not registered
  80                         # as a provider.
  81                         if name == "DDNSProvider":
  82                                 return
  83
  84                         if not all((provider.handle, provider.name, provider.website)):
  85                                 raise DDNSError(_("Provider is not properly configured"))
  86
  87                         assert not _providers.has_key(provider.handle), \
  88                                 "Provider '%s' has already been registered" % provider.handle
  89
  90                         _providers[provider.handle] = provider
  91
  92         @staticmethod
  93         def supported():
  94                 """
  95                         Should be overwritten to check if the system the code is running
  96                         on has all the required tools to support this provider.
  97                 """
  98                 return True
  99
 100         def __init__(self, core, **settings):
 101                 self.core = core
 102
 103                 # Copy a set of default settings and
 104                 # update them by those from the configuration file.
 105                 self.settings = self.DEFAULT_SETTINGS.copy()
 106                 self.settings.update(settings)
 107
 108         def __repr__(self):
 109                 return "<DDNS Provider %s (%s)>" % (self.name, self.handle)
 110
 111         def __cmp__(self, other):
 112                 return cmp(self.hostname, other.hostname)
 113
 114         @property
 115         def db(self):
 116                 return self.core.db
 117
 118         def get(self, key, default=None):
 119                 """
 120                         Get a setting from the settings dictionary.
 121                 """
 122                 return self.settings.get(key, default)
 123
 124         @property
 125         def hostname(self):
 126                 """
 127                         Fast access to the hostname.
 128                 """
 129                 return self.get("hostname")
 130
 131         @property
 132         def username(self):
 133                 """
 134                         Fast access to the username.
 135                 """
 136                 return self.get("username")
 137
 138         @property
 139         def password(self):
 140                 """
 141                         Fast access to the password.
 142                 """
 143                 return self.get("password")
 144
 145         @property
 146         def token(self):
 147                 """
 148                         Fast access to the token.
 149                 """
 150                 return self.get("token")
 151
 152         def __call__(self, force=False):
 153                 if force:
 154                         logger.debug(_("Updating %s forced") % self.hostname)
 155
 156                 # Do nothing if the last update has failed or no update is required
 157                 elif self.has_failure or not self.requires_update:
 158                         return
 159
 160                 # Execute the update.
 161                 try:
 162                         self.update()
 163
 164                 # In case of any errors, log the failed request and
 165                 # raise the exception.
 166                 except DDNSError as e:
 167                         self.core.db.log_failure(self.hostname, e)
 168                         raise
 169
 170                 logger.info(_("Dynamic DNS update for %(hostname)s (%(provider)s) successful") % \
 171                         { "hostname" : self.hostname, "provider" : self.name })
 172                 self.core.db.log_success(self.hostname)
 173
 174         def update(self):
 175                 for protocol in self.protocols:
 176                         if self.have_address(protocol):
 177                                 self.update_protocol(protocol)
 178                         elif self.can_remove_records:
 179                                 self.remove_protocol(protocol)
 180
 181         def update_protocol(self, proto):
 182                 raise NotImplementedError
 183
 184         def remove_protocol(self, proto):
 185                 if not self.can_remove_records:
 186                         raise RuntimeError, "can_remove_records is enabled, but remove_protocol() not implemented"
 187
 188                 raise NotImplementedError
 189
 190         @property
 191         def requires_update(self):
 192                 # If the IP addresses have changed, an update is required
 193                 if self.ip_address_changed(self.protocols):
 194                         logger.debug(_("An update for %(hostname)s (%(provider)s)"
 195                                 " is performed because of an IP address change") % \
 196                                 { "hostname" : self.hostname, "provider" : self.name })
 197
 198                         return True
 199
 200                 # If the holdoff time has expired, an update is required, too
 201                 if self.holdoff_time_expired():
 202                         logger.debug(_("An update for %(hostname)s (%(provider)s)"
 203                                 " is performed because the holdoff time has expired") % \
 204                                 { "hostname" : self.hostname, "provider" : self.name })
 205
 206                         return True
 207
 208                 # Otherwise, we don't need to perform an update
 209                 logger.debug(_("No update required for %(hostname)s (%(provider)s)") % \
 210                         { "hostname" : self.hostname, "provider" : self.name })
 211
 212                 return False
 213
 214         @property
 215         def has_failure(self):
 216                 """
 217                         Returns True when the last update has failed and no retry
 218                         should be performed, yet.
 219                 """
 220                 last_status = self.db.last_update_status(self.hostname)
 221
 222                 # Return False if the last update has not failed.
 223                 if not last_status == "failure":
 224                         return False
 225
 226                 # If there is no holdoff time, we won't update ever again.
 227                 if self.holdoff_failure_days is None:
 228                         logger.warning(_("An update has not been performed because earlier updates failed for %s") \
 229                                 % self.hostname)
 230                         logger.warning(_("There will be no retries"))
 231
 232                         return True
 233
 234                 # Determine when the holdoff time ends
 235                 last_update = self.db.last_update(self.hostname, status=last_status)
 236                 holdoff_end = last_update + datetime.timedelta(days=self.holdoff_failure_days)
 237
 238                 now = datetime.datetime.utcnow()
 239                 if now < holdoff_end:
 240                         failure_message = self.db.last_update_failure_message(self.hostname)
 241
 242                         logger.warning(_("An update has not been performed because earlier updates failed for %s") \
 243                                 % self.hostname)
 244
 245                         if failure_message:
 246                                 logger.warning(_("Last failure message:"))
 247
 248                                 for line in failure_message.splitlines():
 249                                         logger.warning("  %s" % line)
 250
 251                         logger.warning(_("Further updates will be withheld until %s") % holdoff_end)
 252
 253                         return True
 254
 255                 return False
 256
 257         def ip_address_changed(self, protos):
 258                 """
 259                         Returns True if this host is already up to date
 260                         and does not need to change the IP address on the
 261                         name server.
 262                 """
 263                 for proto in protos:
 264                         addresses = self.core.system.resolve(self.hostname, proto)
 265                         current_address = self.get_address(proto)
 266
 267                         # Handle if the system has not got any IP address from a protocol
 268                         # (i.e. had full dual-stack connectivity which it has not any more)
 269                         if current_address is None:
 270                                 # If addresses still exists in the DNS system and if this provider
 271                                 # is able to remove records, we will do that.
 272                                 if addresses and self.can_remove_records:
 273                                         return True
 274
 275                                 # Otherwise, we cannot go on...
 276                                 continue
 277
 278                         if not current_address in addresses:
 279                                 return True
 280
 281                 return False
 282
 283         def holdoff_time_expired(self):
 284                 """
 285                         Returns true if the holdoff time has expired
 286                         and the host requires an update
 287                 """
 288                 # If no holdoff days is defined, we cannot go on
 289                 if not self.holdoff_days:
 290                         return False
 291
 292                 # Get the timestamp of the last successfull update
 293                 last_update = self.db.last_update(self.hostname, status="success")
 294
 295                 # If no timestamp has been recorded, no update has been
 296                 # performed. An update should be performed now.
 297                 if not last_update:
 298                         return True
 299
 300                 # Determine when the holdoff time ends
 301                 holdoff_end = last_update + datetime.timedelta(days=self.holdoff_days)
 302
 303                 now = datetime.datetime.utcnow()
 304
 305                 if now >= holdoff_end:
 306                         logger.debug("The holdoff time has expired for %s" % self.hostname)
 307                         return True
 308                 else:
 309                         logger.debug("Updates for %s are held off until %s" % \
 310                                 (self.hostname, holdoff_end))
 311                         return False
 312
 313         def send_request(self, *args, **kwargs):
 314                 """
 315                         Proxy connection to the send request
 316                         method.
 317                 """
 318                 return self.core.system.send_request(*args, **kwargs)
 319
 320         def get_address(self, proto, default=None):
 321                 """
 322                         Proxy method to get the current IP address.
 323                 """
 324                 return self.core.system.get_address(proto) or default
 325
 326         def have_address(self, proto):
 327                 """
 328                         Returns True if an IP address for the given protocol
 329                         is known and usable.
 330                 """
 331                 address = self.get_address(proto)
 332
 333                 if address:
 334                         return True
 335
 336                 return False
 337
 338
 339 class DDNSProtocolDynDNS2(object):
 340         """
 341                 This is an abstract class that implements the DynDNS updater
 342                 protocol version 2. As this is a popular way to update dynamic
 343                 DNS records, this class is supposed make the provider classes
 344                 shorter and simpler.
 345         """
 346
 347         # Information about the format of the request is to be found
 348         # http://dyn.com/support/developers/api/perform-update/
 349         # http://dyn.com/support/developers/api/return-codes/
 350
 351         # The DynDNS protocol version 2 does not allow to remove records
 352         can_remove_records = False
 353
 354         def prepare_request_data(self, proto):
 355                 data = {
 356                         "hostname" : self.hostname,
 357                         "myip"     : self.get_address(proto),
 358                 }
 359
 360                 return data
 361
 362         def update_protocol(self, proto):
 363                 data = self.prepare_request_data(proto)
 364
 365                 return self.send_request(data)
 366
 367         def send_request(self, data):
 368                 # Send update to the server.
 369                 response = DDNSProvider.send_request(self, self.url, data=data,
 370                         username=self.username, password=self.password)
 371
 372                 # Get the full response message.
 373                 output = response.read()
 374
 375                 # Handle success messages.
 376                 if output.startswith("good") or output.startswith("nochg"):
 377                         return
 378
 379                 # Handle error codes.
 380                 if output == "badauth":
 381                         raise DDNSAuthenticationError
 382                 elif output == "abuse":
 383                         raise DDNSAbuseError
 384                 elif output == "notfqdn":
 385                         raise DDNSRequestError(_("No valid FQDN was given."))
 386                 elif output == "nohost":
 387                         raise DDNSRequestError(_("Specified host does not exist."))
 388                 elif output == "911":
 389                         raise DDNSInternalServerError
 390                 elif output == "dnserr":
 391                         raise DDNSInternalServerError(_("DNS error encountered."))
 392                 elif output == "badagent":
 393                         raise DDNSBlockedError
 394
 395                 # If we got here, some other update error happened.
 396                 raise DDNSUpdateError(_("Server response: %s") % output)
 397
 398
 399 class DDNSResponseParserXML(object):
 400         """
 401                 This class provides a parser for XML responses which
 402                 will be sent by various providers. This class uses the python
 403                 shipped XML minidom module to walk through the XML tree and return
 404                 a requested element.
 405         """
 406
 407         def get_xml_tag_value(self, document, content):
 408                 # Send input to the parser.
 409                 xmldoc = xml.dom.minidom.parseString(document)
 410
 411                 # Get XML elements by the given content.
 412                 element = xmldoc.getElementsByTagName(content)
 413
 414                 # If no element has been found, we directly can return None.
 415                 if not element:
 416                         return None
 417
 418                 # Only get the first child from an element, even there are more than one.
 419                 firstchild = element[0].firstChild
 420
 421                 # Get the value of the child.
 422                 value = firstchild.nodeValue
 423
 424                 # Return the value.
 425                 return value
 426
 427
 428 class DDNSProviderAllInkl(DDNSProvider):
 429         handle    = "all-inkl.com"
 430         name      = "All-inkl.com"
 431         website   = "http://all-inkl.com/"
 432         protocols = ("ipv4",)
 433
 434         # There are only information provided by the vendor how to
 435         # perform an update on a FRITZ Box. Grab requried informations
 436         # from the net.
 437         # http://all-inkl.goetze.it/v01/ddns-mit-einfachen-mitteln/
 438
 439         url = "http://dyndns.kasserver.com"
 440         can_remove_records = False
 441
 442         def update(self):
 443                 # There is no additional data required so we directly can
 444                 # send our request.
 445                 response = self.send_request(self.url, username=self.username, password=self.password)
 446
 447                 # Get the full response message.
 448                 output = response.read()
 449
 450                 # Handle success messages.
 451                 if output.startswith("good") or output.startswith("nochg"):
 452                         return
 453
 454                 # If we got here, some other update error happened.
 455                 raise DDNSUpdateError
 456
 457
 458 class DDNSProviderBindNsupdate(DDNSProvider):
 459         handle  = "nsupdate"
 460         name    = "BIND nsupdate utility"
 461         website = "http://en.wikipedia.org/wiki/Nsupdate"
 462
 463         DEFAULT_TTL = 60
 464
 465         @staticmethod
 466         def supported():
 467                 # Search if the nsupdate utility is available
 468                 paths = os.environ.get("PATH")
 469
 470                 for path in paths.split(":"):
 471                         executable = os.path.join(path, "nsupdate")
 472
 473                         if os.path.exists(executable):
 474                                 return True
 475
 476                 return False
 477
 478         def update(self):
 479                 scriptlet = self.__make_scriptlet()
 480
 481                 # -v enables TCP hence we transfer keys and other data that may
 482                 # exceed the size of one packet.
 483                 # -t sets the timeout
 484                 command = ["nsupdate", "-v", "-t", "60"]
 485
 486                 p = subprocess.Popen(command, shell=True,
 487                         stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE,
 488                 )
 489                 stdout, stderr = p.communicate(scriptlet)
 490
 491                 if p.returncode == 0:
 492                         return
 493
 494                 raise DDNSError("nsupdate terminated with error code: %s\n  %s" % (p.returncode, stderr))
 495
 496         def __make_scriptlet(self):
 497                 scriptlet = []
 498
 499                 # Set a different server the update is sent to.
 500                 server = self.get("server", None)
 501                 if server:
 502                         scriptlet.append("server %s" % server)
 503
 504                 # Set the DNS zone the host should be added to.
 505                 zone = self.get("zone", None)
 506                 if zone:
 507                         scriptlet.append("zone %s" % zone)
 508
 509                 key = self.get("key", None)
 510                 if key:
 511                         secret = self.get("secret")
 512
 513                         scriptlet.append("key %s %s" % (key, secret))
 514
 515                 ttl = self.get("ttl", self.DEFAULT_TTL)
 516
 517                 # Perform an update for each supported protocol.
 518                 for rrtype, proto in (("AAAA", "ipv6"), ("A", "ipv4")):
 519                         address = self.get_address(proto)
 520                         if not address:
 521                                 continue
 522
 523                         scriptlet.append("update delete %s. %s" % (self.hostname, rrtype))
 524                         scriptlet.append("update add %s. %s %s %s" % \
 525                                 (self.hostname, ttl, rrtype, address))
 526
 527                 # Send the actions to the server.
 528                 scriptlet.append("send")
 529                 scriptlet.append("quit")
 530
 531                 logger.debug(_("Scriptlet:"))
 532                 for line in scriptlet:
 533                         # Masquerade the line with the secret key.
 534                         if line.startswith("key"):
 535                                 line = "key **** ****"
 536
 537                         logger.debug("  %s" % line)
 538
 539                 return "\n".join(scriptlet)
 540
 541
 542 class DDNSProviderChangeIP(DDNSProvider):
 543         handle    = "changeip.com"
 544         name      = "ChangeIP.com"
 545         website   = "https://changeip.com"
 546         protocols = ("ipv4",)
 547
 548         # Detailed information about the update api can be found here.
 549         # http://www.changeip.com/accounts/knowledgebase.php?action=displayarticle&id=34
 550
 551         url = "https://nic.changeip.com/nic/update"
 552         can_remove_records = False
 553
 554         def update_protocol(self, proto):
 555                 data = {
 556                         "hostname" : self.hostname,
 557                         "myip"     : self.get_address(proto),
 558                 }
 559
 560                 # Send update to the server.
 561                 try:
 562                         response = self.send_request(self.url, username=self.username, password=self.password,
 563                                 data=data)
 564
 565                 # Handle error codes.
 566                 except urllib2.HTTPError, e:
 567                         if e.code == 422:
 568                                 raise DDNSRequestError(_("Domain not found."))
 569
 570                         raise
 571
 572                 # Handle success message.
 573                 if response.code == 200:
 574                         return
 575
 576                 # If we got here, some other update error happened.
 577                 raise DDNSUpdateError(_("Server response: %s") % output)
 578
 579
 580 class DDNSProviderDDNSS(DDNSProvider):
 581         handle    = "ddnss.de"
 582         name      = "DDNSS"
 583         website   = "http://www.ddnss.de"
 584         protocols = ("ipv4",)
 585
 586         # Detailed information about how to send the update request and possible response
 587         # codes can be obtained from here.
 588         # http://www.ddnss.de/info.php
 589         # http://www.megacomputing.de/2014/08/dyndns-service-response-time/#more-919
 590
 591         url = "http://www.ddnss.de/upd.php"
 592         can_remove_records = False
 593
 594         def update_protocol(self, proto):
 595                 data = {
 596                         "ip"   : self.get_address(proto),
 597                         "host" : self.hostname,
 598                 }
 599
 600                 # Check if a token has been set.
 601                 if self.token:
 602                         data["key"] = self.token
 603
 604                 # Check if username and hostname are given.
 605                 elif self.username and self.password:
 606                         data.update({
 607                                 "user" : self.username,
 608                                 "pwd"  : self.password,
 609                         })
 610
 611                 # Raise an error if no auth details are given.
 612                 else:
 613                         raise DDNSConfigurationError
 614
 615                 # Send update to the server.
 616                 response = self.send_request(self.url, data=data)
 617
 618                 # This provider sends the response code as part of the header.
 619                 header = response.info()
 620
 621                 # Get status information from the header.
 622                 output = header.getheader('ddnss-response')
 623
 624                 # Handle success messages.
 625                 if output == "good" or output == "nochg":
 626                         return
 627
 628                 # Handle error codes.
 629                 if output == "badauth":
 630                         raise DDNSAuthenticationError
 631                 elif output == "notfqdn":
 632                         raise DDNSRequestError(_("No valid FQDN was given."))
 633                 elif output == "nohost":
 634                         raise DDNSRequestError(_("Specified host does not exist."))
 635                 elif output == "911":
 636                         raise DDNSInternalServerError
 637                 elif output == "dnserr":
 638                         raise DDNSInternalServerError(_("DNS error encountered."))
 639                 elif output == "disabled":
 640                         raise DDNSRequestError(_("Account disabled or locked."))
 641
 642                 # If we got here, some other update error happened.
 643                 raise DDNSUpdateError
 644
 645
 646 class DDNSProviderDHS(DDNSProvider):
 647         handle    = "dhs.org"
 648         name      = "DHS International"
 649         website   = "http://dhs.org/"
 650         protocols = ("ipv4",)
 651
 652         # No information about the used update api provided on webpage,
 653         # grabed from source code of ez-ipudate.
 654
 655         url = "http://members.dhs.org/nic/hosts"
 656         can_remove_records = False
 657
 658         def update_protocol(self, proto):
 659                 data = {
 660                         "domain"       : self.hostname,
 661                         "ip"           : self.get_address(proto),
 662                         "hostcmd"      : "edit",
 663                         "hostcmdstage" : "2",
 664                         "type"         : "4",
 665                 }
 666
 667                 # Send update to the server.
 668                 response = self.send_request(self.url, username=self.username, password=self.password,
 669                         data=data)
 670
 671                 # Handle success messages.
 672                 if response.code == 200:
 673                         return
 674
 675                 # If we got here, some other update error happened.
 676                 raise DDNSUpdateError
 677
 678
 679 class DDNSProviderDNSpark(DDNSProvider):
 680         handle    = "dnspark.com"
 681         name      = "DNS Park"
 682         website   = "http://dnspark.com/"
 683         protocols = ("ipv4",)
 684
 685         # Informations to the used api can be found here:
 686         # https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation
 687
 688         url = "https://control.dnspark.com/api/dynamic/update.php"
 689         can_remove_records = False
 690
 691         def update_protocol(self, proto):
 692                 data = {
 693                         "domain" : self.hostname,
 694                         "ip"     : self.get_address(proto),
 695                 }
 696
 697                 # Send update to the server.
 698                 response = self.send_request(self.url, username=self.username, password=self.password,
 699                         data=data)
 700
 701                 # Get the full response message.
 702                 output = response.read()
 703
 704                 # Handle success messages.
 705                 if output.startswith("ok") or output.startswith("nochange"):
 706                         return
 707
 708                 # Handle error codes.
 709                 if output == "unauth":
 710                         raise DDNSAuthenticationError
 711                 elif output == "abuse":
 712                         raise DDNSAbuseError
 713                 elif output == "blocked":
 714                         raise DDNSBlockedError
 715                 elif output == "nofqdn":
 716                         raise DDNSRequestError(_("No valid FQDN was given."))
 717                 elif output == "nohost":
 718                         raise DDNSRequestError(_("Invalid hostname specified."))
 719                 elif output == "notdyn":
 720                         raise DDNSRequestError(_("Hostname not marked as a dynamic host."))
 721                 elif output == "invalid":
 722                         raise DDNSRequestError(_("Invalid IP address has been sent."))
 723
 724                 # If we got here, some other update error happened.
 725                 raise DDNSUpdateError
 726
 727
 728 class DDNSProviderDtDNS(DDNSProvider):
 729         handle    = "dtdns.com"
 730         name      = "DtDNS"
 731         website   = "http://dtdns.com/"
 732         protocols = ("ipv4",)
 733
 734         # Information about the format of the HTTPS request is to be found
 735         # http://www.dtdns.com/dtsite/updatespec
 736
 737         url = "https://www.dtdns.com/api/autodns.cfm"
 738         can_remove_records = False
 739
 740         def update_protocol(self, proto):
 741                 data = {
 742                         "ip" : self.get_address(proto),
 743                         "id" : self.hostname,
 744                         "pw" : self.password
 745                 }
 746
 747                 # Send update to the server.
 748                 response = self.send_request(self.url, data=data)
 749
 750                 # Get the full response message.
 751                 output = response.read()
 752
 753                 # Remove all leading and trailing whitespace.
 754                 output = output.strip()
 755
 756                 # Handle success messages.
 757                 if "now points to" in output:
 758                         return
 759
 760                 # Handle error codes.
 761                 if output == "No hostname to update was supplied.":
 762                         raise DDNSRequestError(_("No hostname specified."))
 763
 764                 elif output == "The hostname you supplied is not valid.":
 765                         raise DDNSRequestError(_("Invalid hostname specified."))
 766
 767                 elif output == "The password you supplied is not valid.":
 768                         raise DDNSAuthenticationError
 769
 770                 elif output == "Administration has disabled this account.":
 771                         raise DDNSRequestError(_("Account has been disabled."))
 772
 773                 elif output == "Illegal character in IP.":
 774                         raise DDNSRequestError(_("Invalid IP address has been sent."))
 775
 776                 elif output == "Too many failed requests.":
 777                         raise DDNSRequestError(_("Too many failed requests."))
 778
 779                 # If we got here, some other update error happened.
 780                 raise DDNSUpdateError
 781
 782
 783 class DDNSProviderDynDNS(DDNSProtocolDynDNS2, DDNSProvider):
 784         handle    = "dyndns.org"
 785         name      = "Dyn"
 786         website   = "http://dyn.com/dns/"
 787         protocols = ("ipv4",)
 788
 789         # Information about the format of the request is to be found
 790         # http://http://dyn.com/support/developers/api/perform-update/
 791         # http://dyn.com/support/developers/api/return-codes/
 792
 793         url = "https://members.dyndns.org/nic/update"
 794
 795
 796 class DDNSProviderDynU(DDNSProtocolDynDNS2, DDNSProvider):
 797         handle    = "dynu.com"
 798         name      = "Dynu"
 799         website   = "http://dynu.com/"
 800         protocols = ("ipv6", "ipv4",)
 801
 802         # Detailed information about the request and response codes
 803         # are available on the providers webpage.
 804         # http://dynu.com/Default.aspx?page=dnsapi
 805
 806         url = "https://api.dynu.com/nic/update"
 807
 808         # DynU sends the IPv6 and IPv4 address in one request
 809
 810         def update(self):
 811                 data = DDNSProtocolDynDNS2.prepare_request_data(self, "ipv4")
 812
 813                 # This one supports IPv6
 814                 myipv6 = self.get_address("ipv6")
 815
 816                 # Add update information if we have an IPv6 address.
 817                 if myipv6:
 818                         data["myipv6"] = myipv6
 819
 820                 self.send_request(data)
 821
 822
 823 class DDNSProviderEasyDNS(DDNSProvider):
 824         handle    = "easydns.com"
 825         name      = "EasyDNS"
 826         website   = "http://www.easydns.com/"
 827         protocols = ("ipv4",)
 828
 829         # Detailed information about the request and response codes
 830         # (API 1.3) are available on the providers webpage.
 831         # https://fusion.easydns.com/index.php?/Knowledgebase/Article/View/102/7/dynamic-dns
 832
 833         url = "http://api.cp.easydns.com/dyn/tomato.php"
 834
 835         def update_protocol(self, proto):
 836                 data = {
 837                         "myip"     : self.get_address(proto, "-"),
 838                         "hostname" : self.hostname,
 839                 }
 840
 841                 # Send update to the server.
 842                 response = self.send_request(self.url, data=data,
 843                         username=self.username, password=self.password)
 844
 845                 # Get the full response message.
 846                 output = response.read()
 847
 848                 # Remove all leading and trailing whitespace.
 849                 output = output.strip()
 850
 851                 # Handle success messages.
 852                 if output.startswith("NOERROR"):
 853                         return
 854
 855                 # Handle error codes.
 856                 if output.startswith("NOACCESS"):
 857                         raise DDNSAuthenticationError
 858
 859                 elif output.startswith("NOSERVICE"):
 860                         raise DDNSRequestError(_("Dynamic DNS is not turned on for this domain."))
 861
 862                 elif output.startswith("ILLEGAL INPUT"):
 863                         raise DDNSRequestError(_("Invalid data has been sent."))
 864
 865                 elif output.startswith("TOOSOON"):
 866                         raise DDNSRequestError(_("Too frequent update requests have been sent."))
 867
 868                 # If we got here, some other update error happened.
 869                 raise DDNSUpdateError
 870
 871
 872 class DDNSProviderDomopoli(DDNSProtocolDynDNS2, DDNSProvider):
 873         handle    = "domopoli.de"
 874         name      = "domopoli.de"
 875         website   = "http://domopoli.de/"
 876         protocols = ("ipv4",)
 877
 878         # https://www.domopoli.de/?page=howto#DynDns_start
 879
 880         url = "http://dyndns.domopoli.de/nic/update"
 881
 882
 883 class DDNSProviderDynsNet(DDNSProvider):
 884         handle    = "dyns.net"
 885         name      = "DyNS"
 886         website   = "http://www.dyns.net/"
 887         protocols = ("ipv4",)
 888         can_remove_records = False
 889
 890         # There is very detailed informatio about how to send the update request and
 891         # the possible response codes. (Currently we are using the v1.1 proto)
 892         # http://www.dyns.net/documentation/technical/protocol/
 893
 894         url = "http://www.dyns.net/postscript011.php"
 895
 896         def update_protocol(self, proto):
 897                 data = {
 898                         "ip"       : self.get_address(proto),
 899                         "host"     : self.hostname,
 900                         "username" : self.username,
 901                         "password" : self.password,
 902                 }
 903
 904                 # Send update to the server.
 905                 response = self.send_request(self.url, data=data)
 906
 907                 # Get the full response message.
 908                 output = response.read()
 909
 910                 # Handle success messages.
 911                 if output.startswith("200"):
 912                         return
 913
 914                 # Handle error codes.
 915                 if output.startswith("400"):
 916                         raise DDNSRequestError(_("Malformed request has been sent."))
 917                 elif output.startswith("401"):
 918                         raise DDNSAuthenticationError
 919                 elif output.startswith("402"):
 920                         raise DDNSRequestError(_("Too frequent update requests have been sent."))
 921                 elif output.startswith("403"):
 922                         raise DDNSInternalServerError
 923
 924                 # If we got here, some other update error happened.
 925                 raise DDNSUpdateError(_("Server response: %s") % output)
 926
 927
 928 class DDNSProviderEnomCom(DDNSResponseParserXML, DDNSProvider):
 929         handle    = "enom.com"
 930         name      = "eNom Inc."
 931         website   = "http://www.enom.com/"
 932         protocols = ("ipv4",)
 933
 934         # There are very detailed information about how to send an update request and
 935         # the respone codes.
 936         # http://www.enom.com/APICommandCatalog/
 937
 938         url = "https://dynamic.name-services.com/interface.asp"
 939         can_remove_records = False
 940
 941         def update_protocol(self, proto):
 942                 data = {
 943                         "command"        : "setdnshost",
 944                         "responsetype"   : "xml",
 945                         "address"        : self.get_address(proto),
 946                         "domainpassword" : self.password,
 947                         "zone"           : self.hostname
 948                 }
 949
 950                 # Send update to the server.
 951                 response = self.send_request(self.url, data=data)
 952
 953                 # Get the full response message.
 954                 output = response.read()
 955
 956                 # Handle success messages.
 957                 if self.get_xml_tag_value(output, "ErrCount") == "0":
 958                         return
 959
 960                 # Handle error codes.
 961                 errorcode = self.get_xml_tag_value(output, "ResponseNumber")
 962
 963                 if errorcode == "304155":
 964                         raise DDNSAuthenticationError
 965                 elif errorcode == "304153":
 966                         raise DDNSRequestError(_("Domain not found."))
 967
 968                 # If we got here, some other update error happened.
 969                 raise DDNSUpdateError
 970
 971
 972 class DDNSProviderEntryDNS(DDNSProvider):
 973         handle    = "entrydns.net"
 974         name      = "EntryDNS"
 975         website   = "http://entrydns.net/"
 976         protocols = ("ipv4",)
 977
 978         # Some very tiny details about their so called "Simple API" can be found
 979         # here: https://entrydns.net/help
 980         url = "https://entrydns.net/records/modify"
 981         can_remove_records = False
 982
 983         def update_protocol(self, proto):
 984                 data = {
 985                         "ip" : self.get_address(proto),
 986                 }
 987
 988                 # Add auth token to the update url.
 989                 url = "%s/%s" % (self.url, self.token)
 990
 991                 # Send update to the server.
 992                 try:
 993                         response = self.send_request(url, data=data)
 994
 995                 # Handle error codes
 996                 except urllib2.HTTPError, e:
 997                         if e.code == 404:
 998                                 raise DDNSAuthenticationError
 999
1000                         elif e.code == 422:
1001                                 raise DDNSRequestError(_("An invalid IP address was submitted"))
1002
1003                         raise
1004
1005                 # Handle success messages.
1006                 if response.code == 200:
1007                         return
1008
1009                 # If we got here, some other update error happened.
1010                 raise DDNSUpdateError
1011
1012
1013 class DDNSProviderFreeDNSAfraidOrg(DDNSProvider):
1014         handle    = "freedns.afraid.org"
1015         name      = "freedns.afraid.org"
1016         website   = "http://freedns.afraid.org/"
1017
1018         # No information about the request or response could be found on the vendor
1019         # page. All used values have been collected by testing.
1020         url = "https://freedns.afraid.org/dynamic/update.php"
1021         can_remove_records = False
1022
1023         def update_protocol(self, proto):
1024                 data = {
1025                         "address" : self.get_address(proto),
1026                 }
1027
1028                 # Add auth token to the update url.
1029                 url = "%s?%s" % (self.url, self.token)
1030
1031                 # Send update to the server.
1032                 response = self.send_request(url, data=data)
1033
1034                 # Get the full response message.
1035                 output = response.read()
1036
1037                 # Handle success messages.
1038                 if output.startswith("Updated") or "has not changed" in output:
1039                         return
1040
1041                 # Handle error codes.
1042                 if output == "ERROR: Unable to locate this record":
1043                         raise DDNSAuthenticationError
1044                 elif "is an invalid IP address" in output:
1045                         raise DDNSRequestError(_("Invalid IP address has been sent."))
1046
1047                 # If we got here, some other update error happened.
1048                 raise DDNSUpdateError
1049
1050
1051 class DDNSProviderLightningWireLabs(DDNSProvider):
1052         handle    = "dns.lightningwirelabs.com"
1053         name      = "Lightning Wire Labs DNS Service"
1054         website   = "http://dns.lightningwirelabs.com/"
1055
1056         # Information about the format of the HTTPS request is to be found
1057         # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
1058
1059         url = "https://dns.lightningwirelabs.com/update"
1060
1061         def update(self):
1062                 data =  {
1063                         "hostname" : self.hostname,
1064                         "address6" : self.get_address("ipv6", "-"),
1065                         "address4" : self.get_address("ipv4", "-"),
1066                 }
1067
1068                 # Check if a token has been set.
1069                 if self.token:
1070                         data["token"] = self.token
1071
1072                 # Check for username and password.
1073                 elif self.username and self.password:
1074                         data.update({
1075                                 "username" : self.username,
1076                                 "password" : self.password,
1077                         })
1078
1079                 # Raise an error if no auth details are given.
1080                 else:
1081                         raise DDNSConfigurationError
1082
1083                 # Send update to the server.
1084                 response = self.send_request(self.url, data=data)
1085
1086                 # Handle success messages.
1087                 if response.code == 200:
1088                         return
1089
1090                 # If we got here, some other update error happened.
1091                 raise DDNSUpdateError
1092
1093
1094 class DDNSProviderLoopia(DDNSProtocolDynDNS2, DDNSProvider):
1095         handle    = "loopia.se"
1096         name      = "Loopia AB"
1097         website   = "https://www.loopia.com"
1098         protocols = ("ipv4",)
1099
1100         # Information about the format of the HTTP request is to be found
1101         # here: https://support.loopia.com/wiki/About_the_DynDNS_support
1102
1103         url = "https://dns.loopia.se/XDynDNSServer/XDynDNS.php"
1104
1105
1106 class DDNSProviderMyOnlinePortal(DDNSProtocolDynDNS2, DDNSProvider):
1107         handle    = "myonlineportal.net"
1108         name      = "myonlineportal.net"
1109         website   = "https:/myonlineportal.net/"
1110
1111         # Information about the request and response can be obtained here:
1112         # https://myonlineportal.net/howto_dyndns
1113
1114         url = "https://myonlineportal.net/updateddns"
1115
1116         def prepare_request_data(self, proto):
1117                 data = {
1118                         "hostname" : self.hostname,
1119                         "ip"     : self.get_address(proto),
1120                 }
1121
1122                 return data
1123
1124
1125 class DDNSProviderNamecheap(DDNSResponseParserXML, DDNSProvider):
1126         handle    = "namecheap.com"
1127         name      = "Namecheap"
1128         website   = "http://namecheap.com"
1129         protocols = ("ipv4",)
1130
1131         # Information about the format of the HTTP request is to be found
1132         # https://www.namecheap.com/support/knowledgebase/article.aspx/9249/0/nc-dynamic-dns-to-dyndns-adapter
1133         # https://community.namecheap.com/forums/viewtopic.php?f=6&t=6772
1134
1135         url = "https://dynamicdns.park-your-domain.com/update"
1136         can_remove_records = False
1137
1138         def update_protocol(self, proto):
1139                 # Namecheap requires the hostname splitted into a host and domain part.
1140                 host, domain = self.hostname.split(".", 1)
1141
1142                 data = {
1143                         "ip"       : self.get_address(proto),
1144                         "password" : self.password,
1145                         "host"     : host,
1146                         "domain"   : domain
1147                 }
1148
1149                 # Send update to the server.
1150                 response = self.send_request(self.url, data=data)
1151
1152                 # Get the full response message.
1153                 output = response.read()
1154
1155                 # Handle success messages.
1156                 if self.get_xml_tag_value(output, "IP") == address:
1157                         return
1158
1159                 # Handle error codes.
1160                 errorcode = self.get_xml_tag_value(output, "ResponseNumber")
1161
1162                 if errorcode == "304156":
1163                         raise DDNSAuthenticationError
1164                 elif errorcode == "316153":
1165                         raise DDNSRequestError(_("Domain not found."))
1166                 elif errorcode == "316154":
1167                         raise DDNSRequestError(_("Domain not active."))
1168                 elif errorcode in ("380098", "380099"):
1169                         raise DDNSInternalServerError
1170
1171                 # If we got here, some other update error happened.
1172                 raise DDNSUpdateError
1173
1174
1175 class DDNSProviderNOIP(DDNSProtocolDynDNS2, DDNSProvider):
1176         handle    = "no-ip.com"
1177         name      = "No-IP"
1178         website   = "http://www.no-ip.com/"
1179         protocols = ("ipv4",)
1180
1181         # Information about the format of the HTTP request is to be found
1182         # here: http://www.no-ip.com/integrate/request and
1183         # here: http://www.no-ip.com/integrate/response
1184
1185         url = "http://dynupdate.no-ip.com/nic/update"
1186
1187         def prepare_request_data(self, proto):
1188                 assert proto == "ipv4"
1189
1190                 data = {
1191                         "hostname" : self.hostname,
1192                         "address"  : self.get_address(proto),
1193                 }
1194
1195                 return data
1196
1197
1198 class DDNSProviderNsupdateINFO(DDNSProtocolDynDNS2, DDNSProvider):
1199         handle    = "nsupdate.info"
1200         name      = "nsupdate.info"
1201         website   = "http://nsupdate.info/"
1202         protocols = ("ipv6", "ipv4",)
1203
1204         # Information about the format of the HTTP request can be found
1205         # after login on the provider user interface and here:
1206         # http://nsupdateinfo.readthedocs.org/en/latest/user.html
1207
1208         url = "https://nsupdate.info/nic/update"
1209
1210         # TODO nsupdate.info can actually do this, but the functionality
1211         # has not been implemented here, yet.
1212         can_remove_records = False
1213
1214         # After a failed update, there will be no retries
1215         # https://bugzilla.ipfire.org/show_bug.cgi?id=10603
1216         holdoff_failure_days = None
1217
1218         # Nsupdate.info uses the hostname as user part for the HTTP basic auth,
1219         # and for the password a so called secret.
1220         @property
1221         def username(self):
1222                 return self.get("hostname")
1223
1224         @property
1225         def password(self):
1226                 return self.token or self.get("secret")
1227
1228         def prepare_request_data(self, proto):
1229                 data = {
1230                         "myip" : self.get_address(proto),
1231                 }
1232
1233                 return data
1234
1235
1236 class DDNSProviderOpenDNS(DDNSProtocolDynDNS2, DDNSProvider):
1237         handle    = "opendns.com"
1238         name      = "OpenDNS"
1239         website   = "http://www.opendns.com"
1240
1241         # Detailed information about the update request and possible
1242         # response codes can be obtained from here:
1243         # https://support.opendns.com/entries/23891440
1244
1245         url = "https://updates.opendns.com/nic/update"
1246
1247         def prepare_request_data(self, proto):
1248                 data = {
1249                         "hostname" : self.hostname,
1250                         "myip"     : self.get_address(proto),
1251                 }
1252
1253                 return data
1254
1255
1256 class DDNSProviderOVH(DDNSProtocolDynDNS2, DDNSProvider):
1257         handle    = "ovh.com"
1258         name      = "OVH"
1259         website   = "http://www.ovh.com/"
1260         protocols = ("ipv4",)
1261
1262         # OVH only provides very limited information about how to
1263         # update a DynDNS host. They only provide the update url
1264         # on the their german subpage.
1265         #
1266         # http://hilfe.ovh.de/DomainDynHost
1267
1268         url = "https://www.ovh.com/nic/update"
1269
1270         def prepare_request_data(self, proto):
1271                 data = DDNSProtocolDynDNS2.prepare_request_data(self, proto)
1272                 data.update({
1273                         "system" : "dyndns",
1274                 })
1275
1276                 return data
1277
1278
1279 class DDNSProviderRegfish(DDNSProvider):
1280         handle  = "regfish.com"
1281         name    = "Regfish GmbH"
1282         website = "http://www.regfish.com/"
1283
1284         # A full documentation to the providers api can be found here
1285         # but is only available in german.
1286         # https://www.regfish.de/domains/dyndns/dokumentation
1287
1288         url = "https://dyndns.regfish.de/"
1289         can_remove_records = False
1290
1291         def update(self):
1292                 data = {
1293                         "fqdn" : self.hostname,
1294                 }
1295
1296                 # Check if we update an IPv6 address.
1297                 address6 = self.get_address("ipv6")
1298                 if address6:
1299                         data["ipv6"] = address6
1300
1301                 # Check if we update an IPv4 address.
1302                 address4 = self.get_address("ipv4")
1303                 if address4:
1304                         data["ipv4"] = address4
1305
1306                 # Raise an error if none address is given.
1307                 if not data.has_key("ipv6") and not data.has_key("ipv4"):
1308                         raise DDNSConfigurationError
1309
1310                 # Check if a token has been set.
1311                 if self.token:
1312                         data["token"] = self.token
1313
1314                 # Raise an error if no token and no useranem and password
1315                 # are given.
1316                 elif not self.username and not self.password:
1317                         raise DDNSConfigurationError(_("No Auth details specified."))
1318
1319                 # HTTP Basic Auth is only allowed if no token is used.
1320                 if self.token:
1321                         # Send update to the server.
1322                         response = self.send_request(self.url, data=data)
1323                 else:
1324                         # Send update to the server.
1325                         response = self.send_request(self.url, username=self.username, password=self.password,
1326                                 data=data)
1327
1328                 # Get the full response message.
1329                 output = response.read()
1330
1331                 # Handle success messages.
1332                 if "100" in output or "101" in output:
1333                         return
1334
1335                 # Handle error codes.
1336                 if "401" or "402" in output:
1337                         raise DDNSAuthenticationError
1338                 elif "408" in output:
1339                         raise DDNSRequestError(_("Invalid IPv4 address has been sent."))
1340                 elif "409" in output:
1341                         raise DDNSRequestError(_("Invalid IPv6 address has been sent."))
1342                 elif "412" in output:
1343                         raise DDNSRequestError(_("No valid FQDN was given."))
1344                 elif "414" in output:
1345                         raise DDNSInternalServerError
1346
1347                 # If we got here, some other update error happened.
1348                 raise DDNSUpdateError
1349
1350
1351 class DDNSProviderSelfhost(DDNSProtocolDynDNS2, DDNSProvider):
1352         handle    = "selfhost.de"
1353         name      = "Selfhost.de"
1354         website   = "http://www.selfhost.de/"
1355         protocols = ("ipv4",)
1356
1357         url = "https://carol.selfhost.de/nic/update"
1358
1359         def prepare_request_data(self, proto):
1360                 data = DDNSProtocolDynDNS2.prepare_request_data(self, proto)
1361                 data.update({
1362                         "hostname" : "1",
1363                 })
1364
1365                 return data
1366
1367
1368 class DDNSProviderSPDNS(DDNSProtocolDynDNS2, DDNSProvider):
1369         handle    = "spdns.org"
1370         name      = "SPDNS"
1371         website   = "http://spdns.org/"
1372
1373         # Detailed information about request and response codes are provided
1374         # by the vendor. They are using almost the same mechanism and status
1375         # codes as dyndns.org so we can inherit all those stuff.
1376         #
1377         # http://wiki.securepoint.de/index.php/SPDNS_FAQ
1378         # http://wiki.securepoint.de/index.php/SPDNS_Update-Tokens
1379
1380         url = "https://update.spdns.de/nic/update"
1381
1382         @property
1383         def username(self):
1384                 return self.get("username") or self.hostname
1385
1386         @property
1387         def password(self):
1388                 return self.get("password") or self.token
1389
1390
1391 class DDNSProviderStrato(DDNSProtocolDynDNS2, DDNSProvider):
1392         handle    = "strato.com"
1393         name      = "Strato AG"
1394         website   = "http:/www.strato.com/"
1395         protocols = ("ipv4",)
1396
1397         # Information about the request and response can be obtained here:
1398         # http://www.strato-faq.de/article/671/So-einfach-richten-Sie-DynDNS-f%C3%BCr-Ihre-Domains-ein.html
1399
1400         url = "https://dyndns.strato.com/nic/update"
1401
1402
1403 class DDNSProviderTwoDNS(DDNSProtocolDynDNS2, DDNSProvider):
1404         handle    = "twodns.de"
1405         name      = "TwoDNS"
1406         website   = "http://www.twodns.de"
1407         protocols = ("ipv4",)
1408
1409         # Detailed information about the request can be found here
1410         # http://twodns.de/en/faqs
1411         # http://twodns.de/en/api
1412
1413         url = "https://update.twodns.de/update"
1414
1415         def prepare_request_data(self, proto):
1416                 assert proto == "ipv4"
1417
1418                 data = {
1419                         "ip"       : self.get_address(proto),
1420                         "hostname" : self.hostname
1421                 }
1422
1423                 return data
1424
1425
1426 class DDNSProviderUdmedia(DDNSProtocolDynDNS2, DDNSProvider):
1427         handle    = "udmedia.de"
1428         name      = "Udmedia GmbH"
1429         website   = "http://www.udmedia.de"
1430         protocols = ("ipv4",)
1431
1432         # Information about the request can be found here
1433         # http://www.udmedia.de/faq/content/47/288/de/wie-lege-ich-einen-dyndns_eintrag-an.html
1434
1435         url = "https://www.udmedia.de/nic/update"
1436
1437
1438 class DDNSProviderVariomedia(DDNSProtocolDynDNS2, DDNSProvider):
1439         handle    = "variomedia.de"
1440         name      = "Variomedia"
1441         website   = "http://www.variomedia.de/"
1442         protocols = ("ipv6", "ipv4",)
1443
1444         # Detailed information about the request can be found here
1445         # https://dyndns.variomedia.de/
1446
1447         url = "https://dyndns.variomedia.de/nic/update"
1448
1449         def prepare_request_data(self, proto):
1450                 data = {
1451                         "hostname" : self.hostname,
1452                         "myip"     : self.get_address(proto),
1453                 }
1454
1455                 return data
1456
1457
1458 class DDNSProviderXLhost(DDNSProtocolDynDNS2, DDNSProvider):
1459         handle    = "xlhost.de"
1460         name      = "XLhost"
1461         website   = "http://xlhost.de/"
1462         protocols = ("ipv4",)
1463
1464         # Information about the format of the HTTP request is to be found
1465         # here: https://xlhost.de/faq/index_html?topicId=CQA2ELIPO4SQ
1466
1467         url = "https://nsupdate.xlhost.de/"
1468
1469
1470 class DDNSProviderZoneedit(DDNSProvider):
1471         handle    = "zoneedit.com"
1472         name      = "Zoneedit"
1473         website   = "http://www.zoneedit.com"
1474         protocols = ("ipv4",)
1475
1476         # Detailed information about the request and the response codes can be
1477         # obtained here:
1478         # http://www.zoneedit.com/doc/api/other.html
1479         # http://www.zoneedit.com/faq.html
1480
1481         url = "https://dynamic.zoneedit.com/auth/dynamic.html"
1482
1483         def update_protocol(self, proto):
1484                 data = {
1485                         "dnsto" : self.get_address(proto),
1486                         "host"  : self.hostname
1487                 }
1488
1489                 # Send update to the server.
1490                 response = self.send_request(self.url, username=self.username, password=self.password,
1491                         data=data)
1492
1493                 # Get the full response message.
1494                 output = response.read()
1495
1496                 # Handle success messages.
1497                 if output.startswith("<SUCCESS"):
1498                         return
1499
1500                 # Handle error codes.
1501                 if output.startswith("invalid login"):
1502                         raise DDNSAuthenticationError
1503                 elif output.startswith("<ERROR CODE=\"704\""):
1504                         raise DDNSRequestError(_("No valid FQDN was given."))
1505                 elif output.startswith("<ERROR CODE=\"702\""):
1506                         raise DDNSInternalServerError
1507
1508                 # If we got here, some other update error happened.
1509                 raise DDNSUpdateError
1510
1511
1512 class DDNSProviderZZZZ(DDNSProvider):
1513         handle    = "zzzz.io"
1514         name      = "zzzz"
1515         website   = "https://zzzz.io"
1516         protocols = ("ipv6", "ipv4",)
1517
1518         # Detailed information about the update request can be found here:
1519         # https://zzzz.io/faq/
1520
1521         # Details about the possible response codes have been provided in the bugtracker:
1522         # https://bugzilla.ipfire.org/show_bug.cgi?id=10584#c2
1523
1524         url = "https://zzzz.io/api/v1/update"
1525         can_remove_records = False
1526
1527         def update_protocol(self, proto):
1528                 data = {
1529                         "ip"    : self.get_address(proto),
1530                         "token" : self.token,
1531                 }
1532
1533                 if proto == "ipv6":
1534                         data["type"] = "aaaa"
1535
1536                 # zzzz uses the host from the full hostname as part
1537                 # of the update url.
1538                 host, domain = self.hostname.split(".", 1)
1539
1540                 # Add host value to the update url.
1541                 url = "%s/%s" % (self.url, host)
1542
1543                 # Send update to the server.
1544                 try:
1545                         response = self.send_request(url, data=data)
1546
1547                 # Handle error codes.
1548                 except DDNSNotFound:
1549                         raise DDNSRequestError(_("Invalid hostname specified"))
1550
1551                 # Handle success messages.
1552                 if response.code == 200:
1553                         return
1554
1555                 # If we got here, some other update error happened.
1556                 raise DDNSUpdateError