]>
git.ipfire.org Git - oddments/ddns.git/blob - src/ddns/providers.py
2 ###############################################################################
4 # ddns - A dynamic DNS client for IPFire #
5 # Copyright (C) 2012 IPFire development team #
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. #
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. #
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/>. #
20 ###############################################################################
26 # Import all possible exception types.
29 logger
= logging
.getLogger("ddns.providers")
32 class DDNSProvider(object):
34 # A short string that uniquely identifies
38 # The full name of the provider.
41 # A weburl to the homepage of the provider.
42 # (Where to register a new account?)
45 # A list of supported protocols.
46 "protocols" : ["ipv6", "ipv4"],
51 def __init__(self
, core
, **settings
):
54 # Copy a set of default settings and
55 # update them by those from the configuration file.
56 self
.settings
= self
.DEFAULT_SETTINGS
.copy()
57 self
.settings
.update(settings
)
60 return "<DDNS Provider %s (%s)>" % (self
.name
, self
.handle
)
62 def __cmp__(self
, other
):
63 return cmp(self
.hostname
, other
.hostname
)
68 Returns the name of the provider.
70 return self
.INFO
.get("name")
75 Returns the website URL of the provider
76 or None if that is not available.
78 return self
.INFO
.get("website", None)
83 Returns the handle of this provider.
85 return self
.INFO
.get("handle")
87 def get(self
, key
, default
=None):
89 Get a setting from the settings dictionary.
91 return self
.settings
.get(key
, default
)
96 Fast access to the hostname.
98 return self
.get("hostname")
103 Fast access to the username.
105 return self
.get("username")
110 Fast access to the password.
112 return self
.get("password")
116 return self
.INFO
.get("protocols")
121 Fast access to the token.
123 return self
.get("token")
125 def __call__(self
, force
=False):
127 logger
.info(_("Updating %s forced") % self
.hostname
)
129 # Check if we actually need to update this host.
130 elif self
.is_uptodate(self
.protocols
):
131 logger
.info(_("%s is already up to date") % self
.hostname
)
134 # Execute the update.
138 raise NotImplementedError
140 def is_uptodate(self
, protos
):
142 Returns True if this host is already up to date
143 and does not need to change the IP address on the
147 addresses
= self
.core
.system
.resolve(self
.hostname
, proto
)
149 current_address
= self
.get_address(proto
)
151 if not current_address
in addresses
:
156 def send_request(self
, *args
, **kwargs
):
158 Proxy connection to the send request
161 return self
.core
.system
.send_request(*args
, **kwargs
)
163 def get_address(self
, proto
):
165 Proxy method to get the current IP address.
167 return self
.core
.system
.get_address(proto
)
170 class DDNSProviderDHS(DDNSProvider
):
172 "handle" : "dhs.org",
173 "name" : "DHS International",
174 "website" : "http://dhs.org/",
175 "protocols" : ["ipv4",]
178 # No information about the used update api provided on webpage,
179 # grabed from source code of ez-ipudate.
180 url
= "http://members.dhs.org/nic/hosts"
184 "domain" : self
.hostname
,
185 "ip" : self
.get_address("ipv4"),
187 "hostcmdstage" : "2",
191 # Send update to the server.
192 response
= self
.send_request(self
.url
, username
=self
.username
, password
=self
.password
,
195 # Handle success messages.
196 if response
.code
== 200:
199 # Handle error codes.
200 elif response
.code
== 401:
201 raise DDNSAuthenticationError
203 # If we got here, some other update error happened.
204 raise DDNSUpdateError
207 class DDNSProviderDNSpark(DDNSProvider
):
209 "handle" : "dnspark.com",
211 "website" : "http://dnspark.com/",
212 "protocols" : ["ipv4",]
215 # Informations to the used api can be found here:
216 # https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation
217 url
= "https://control.dnspark.com/api/dynamic/update.php"
221 "domain" : self
.hostname
,
222 "ip" : self
.get_address("ipv4"),
225 # Send update to the server.
226 response
= self
.send_request(self
.url
, username
=self
.username
, password
=self
.password
,
229 # Get the full response message.
230 output
= response
.read()
232 # Handle success messages.
233 if output
.startswith("ok") or output
.startswith("nochange"):
236 # Handle error codes.
237 if output
== "unauth":
238 raise DDNSAuthenticationError
239 elif output
== "abuse":
241 elif output
== "blocked":
242 raise DDNSBlockedError
243 elif output
== "nofqdn":
244 raise DDNSRequestError(_("No valid FQDN was given."))
245 elif output
== "nohost":
246 raise DDNSRequestError(_("Invalid hostname specified."))
247 elif output
== "notdyn":
248 raise DDNSRequestError(_("Hostname not marked as a dynamic host."))
249 elif output
== "invalid":
250 raise DDNSRequestError(_("Invalid IP address has been sent."))
252 # If we got here, some other update error happened.
253 raise DDNSUpdateError
256 class DDNSProviderDtDNS(DDNSProvider
):
258 "handle" : "dtdns.com",
260 "website" : "http://dtdns.com/",
261 "protocols" : ["ipv4",]
264 # Information about the format of the HTTPS request is to be found
265 # http://www.dtdns.com/dtsite/updatespec
266 url
= "https://www.dtdns.com/api/autodns.cfm"
270 "ip" : self
.get_address("ipv4"),
271 "id" : self
.hostname
,
275 # Send update to the server.
276 response
= self
.send_request(self
.url
, data
=data
)
278 # Get the full response message.
279 output
= response
.read()
281 # Remove all leading and trailing whitespace.
282 output
= output
.strip()
284 # Handle success messages.
285 if "now points to" in output
:
288 # Handle error codes.
289 if output
== "No hostname to update was supplied.":
290 raise DDNSRequestError(_("No hostname specified."))
292 elif output
== "The hostname you supplied is not valid.":
293 raise DDNSRequestError(_("Invalid hostname specified."))
295 elif output
== "The password you supplied is not valid.":
296 raise DDNSAuthenticationError
298 elif output
== "Administration has disabled this account.":
299 raise DDNSRequestError(_("Account has been disabled."))
301 elif output
== "Illegal character in IP.":
302 raise DDNSRequestError(_("Invalid IP address has been sent."))
304 elif output
== "Too many failed requests.":
305 raise DDNSRequestError(_("Too many failed requests."))
307 # If we got here, some other update error happened.
308 raise DDNSUpdateError
311 class DDNSProviderDynDNS(DDNSProvider
):
313 "handle" : "dyndns.org",
315 "website" : "http://dyn.com/dns/",
316 "protocols" : ["ipv4",]
319 # Information about the format of the request is to be found
320 # http://http://dyn.com/support/developers/api/perform-update/
321 # http://dyn.com/support/developers/api/return-codes/
322 url
= "https://members.dyndns.org/nic/update"
324 def _prepare_request_data(self
):
326 "hostname" : self
.hostname
,
327 "myip" : self
.get_address("ipv4"),
333 data
= self
._prepare
_request
_data
()
335 # Send update to the server.
336 response
= self
.send_request(self
.url
, data
=data
,
337 username
=self
.username
, password
=self
.password
)
339 # Get the full response message.
340 output
= response
.read()
342 # Handle success messages.
343 if output
.startswith("good") or output
.startswith("nochg"):
346 # Handle error codes.
347 if output
== "badauth":
348 raise DDNSAuthenticationError
349 elif output
== "aduse":
351 elif output
== "notfqdn":
352 raise DDNSRequestError(_("No valid FQDN was given."))
353 elif output
== "nohost":
354 raise DDNSRequestError(_("Specified host does not exist."))
355 elif output
== "911":
356 raise DDNSInternalServerError
357 elif output
== "dnserr":
358 raise DDNSInternalServerError(_("DNS error encountered."))
360 # If we got here, some other update error happened.
361 raise DDNSUpdateError
364 class DDNSProviderDynU(DDNSProviderDynDNS
):
366 "handle" : "dynu.com",
368 "website" : "http://dynu.com/",
369 "protocols" : ["ipv6", "ipv4",]
373 # Detailed information about the request and response codes
374 # are available on the providers webpage.
375 # http://dynu.com/Default.aspx?page=dnsapi
377 url
= "https://api.dynu.com/nic/update"
379 def _prepare_request_data(self
):
381 "hostname" : self
.hostname
,
382 "myip" : self
.get_address("ipv4"),
383 "myipv6" : self
.get_address("ipv6"),
387 class DDNSProviderEasyDNS(DDNSProviderDynDNS
):
389 "handle" : "easydns.com",
391 "website" : "http://www.easydns.com/",
392 "protocols" : ["ipv4",]
395 # There is only some basic documentation provided by the vendor,
396 # also searching the web gain very poor results.
397 # http://mediawiki.easydns.com/index.php/Dynamic_DNS
399 url
= "http://api.cp.easydns.com/dyn/tomato.php"
402 class DDNSProviderFreeDNSAfraidOrg(DDNSProvider
):
404 "handle" : "freedns.afraid.org",
405 "name" : "freedns.afraid.org",
406 "website" : "http://freedns.afraid.org/",
407 "protocols" : ["ipv6", "ipv4",]
410 # No information about the request or response could be found on the vendor
411 # page. All used values have been collected by testing.
412 url
= "https://freedns.afraid.org/dynamic/update.php"
416 return self
.get("proto")
419 address
= self
.get_address(self
.proto
)
425 # Add auth token to the update url.
426 url
= "%s?%s" % (self
.url
, self
.token
)
428 # Send update to the server.
429 response
= self
.send_request(url
, data
=data
)
431 if output
.startswith("Updated") or "has not changed" in output
:
434 # Handle error codes.
435 if output
== "ERROR: Unable to locate this record":
436 raise DDNSAuthenticationError
437 elif "is an invalid IP address" in output
:
438 raise DDNSRequestError(_("Invalid IP address has been sent."))
441 class DDNSProviderLightningWireLabs(DDNSProvider
):
443 "handle" : "dns.lightningwirelabs.com",
444 "name" : "Lightning Wire Labs",
445 "website" : "http://dns.lightningwirelabs.com/",
446 "protocols" : ["ipv6", "ipv4",]
449 # Information about the format of the HTTPS request is to be found
450 # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
451 url
= "https://dns.lightningwirelabs.com/update"
455 "hostname" : self
.hostname
,
458 # Check if we update an IPv6 address.
459 address6
= self
.get_address("ipv6")
461 data
["address6"] = address6
463 # Check if we update an IPv4 address.
464 address4
= self
.get_address("ipv4")
466 data
["address4"] = address4
468 # Raise an error if none address is given.
469 if not data
.has_key("address6") and not data
.has_key("address4"):
470 raise DDNSConfigurationError
472 # Check if a token has been set.
474 data
["token"] = self
.token
476 # Check for username and password.
477 elif self
.username
and self
.password
:
479 "username" : self
.username
,
480 "password" : self
.password
,
483 # Raise an error if no auth details are given.
485 raise DDNSConfigurationError
487 # Send update to the server.
488 response
= self
.send_request(self
.url
, data
=data
)
490 # Handle success messages.
491 if response
.code
== 200:
494 # Handle error codes.
495 if response
.code
== 403:
496 raise DDNSAuthenticationError
497 elif response
.code
== 400:
498 raise DDNSRequestError
500 # If we got here, some other update error happened.
501 raise DDNSUpdateError
504 class DDNSProviderNOIP(DDNSProviderDynDNS
):
506 "handle" : "no-ip.com",
508 "website" : "http://www.no-ip.com/",
509 "protocols" : ["ipv4",]
512 # Information about the format of the HTTP request is to be found
513 # here: http://www.no-ip.com/integrate/request and
514 # here: http://www.no-ip.com/integrate/response
516 url
= "http://dynupdate.no-ip.com/nic/update"
518 def _prepare_request_data(self
):
520 "hostname" : self
.hostname
,
521 "address" : self
.get_address("ipv4"),
527 class DDNSProviderOVH(DDNSProviderDynDNS
):
529 "handle" : "ovh.com",
531 "website" : "http://www.ovh.com/",
532 "protocols" : ["ipv4",]
535 # OVH only provides very limited information about how to
536 # update a DynDNS host. They only provide the update url
537 # on the their german subpage.
539 # http://hilfe.ovh.de/DomainDynHost
541 url
= "https://www.ovh.com/nic/update"
543 def _prepare_request_data(self
):
545 "hostname" : self
.hostname
,
546 "myip" : self
.get_address("ipv4"),
551 class DDNSProviderRegfish(DDNSProvider
):
553 "handle" : "regfish.com",
554 "name" : "Regfish GmbH",
555 "website" : "http://www.regfish.com/",
556 "protocols" : ["ipv6", "ipv4",]
559 # A full documentation to the providers api can be found here
560 # but is only available in german.
561 # https://www.regfish.de/domains/dyndns/dokumentation
563 url
= "https://dyndns.regfish.de/"
567 "fqdn" : self
.hostname
,
570 # Check if we update an IPv6 address.
571 address6
= self
.get_address("ipv6")
573 data
["ipv6"] = address6
575 # Check if we update an IPv4 address.
576 address4
= self
.get_address("ipv4")
578 data
["ipv4"] = address4
580 # Raise an error if none address is given.
581 if not data
.has_key("ipv6") and not data
.has_key("ipv4"):
582 raise DDNSConfigurationError
584 # Check if a token has been set.
586 data
["token"] = self
.token
588 # Raise an error if no token and no useranem and password
590 elif not self
.username
and not self
.password
:
591 raise DDNSConfigurationError(_("No Auth details specified."))
593 # HTTP Basic Auth is only allowed if no token is used.
595 # Send update to the server.
596 response
= self
.send_request(self
.url
, data
=data
)
598 # Send update to the server.
599 response
= self
.send_request(self
.url
, username
=self
.username
, password
=self
.password
,
602 # Get the full response message.
603 output
= response
.read()
605 # Handle success messages.
606 if "100" in output
or "101" in output
:
609 # Handle error codes.
610 if "401" or "402" in output
:
611 raise DDNSAuthenticationError
612 elif "408" in output
:
613 raise DDNSRequestError(_("Invalid IPv4 address has been sent."))
614 elif "409" in output
:
615 raise DDNSRequestError(_("Invalid IPv6 address has been sent."))
616 elif "412" in output
:
617 raise DDNSRequestError(_("No valid FQDN was given."))
618 elif "414" in output
:
619 raise DDNSInternalServerError
621 # If we got here, some other update error happened.
622 raise DDNSUpdateError
625 class DDNSProviderSelfhost(DDNSProvider
):
627 "handle" : "selfhost.de",
628 "name" : "Selfhost.de",
629 "website" : "http://www.selfhost.de/",
630 "protocols" : ["ipv4",],
633 url
= "https://carol.selfhost.de/update"
637 "username" : self
.username
,
638 "password" : self
.password
,
642 response
= self
.send_request(self
.url
, data
=data
)
644 match
= re
.search("status=20(0|4)", response
.read())
646 raise DDNSUpdateError
649 class DDNSProviderSPDNS(DDNSProviderDynDNS
):
651 "handle" : "spdns.org",
653 "website" : "http://spdns.org/",
654 "protocols" : ["ipv4",]
657 # Detailed information about request and response codes are provided
658 # by the vendor. They are using almost the same mechanism and status
659 # codes as dyndns.org so we can inherit all those stuff.
661 # http://wiki.securepoint.de/index.php/SPDNS_FAQ
662 # http://wiki.securepoint.de/index.php/SPDNS_Update-Tokens
664 url
= "https://update.spdns.de/nic/update"
667 class DDNSProviderVariomedia(DDNSProviderDynDNS
):
669 "handle" : "variomedia.de",
670 "name" : "Variomedia",
671 "website" : "http://www.variomedia.de/",
672 "protocols" : ["ipv6", "ipv4",]
675 # Detailed information about the request can be found here
676 # https://dyndns.variomedia.de/
678 url
= "https://dyndns.variomedia.de/nic/update"
682 return self
.get("proto")
684 def _prepare_request_data(self
):
686 "hostname" : self
.hostname
,
687 "myip" : self
.get_address(self
.proto
)