]>
git.ipfire.org Git - people/ms/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"
326 "hostname" : self
.hostname
,
327 "myip" : self
.get_address("ipv4"),
330 # Send update to the server.
331 response
= self
.send_request(self
.url
, username
=self
.username
, password
=self
.password
,
334 # Get the full response message.
335 output
= response
.read()
337 # Handle success messages.
338 if output
.startswith("good") or output
.startswith("nochg"):
341 # Handle error codes.
342 if output
== "badauth":
343 raise DDNSAuthenticationError
344 elif output
== "aduse":
346 elif output
== "notfqdn":
347 raise DDNSRequestError(_("No valid FQDN was given."))
348 elif output
== "nohost":
349 raise DDNSRequestError(_("Specified host does not exist."))
350 elif output
== "911":
351 raise DDNSInternalServerError
352 elif output
== "dnserr":
353 raise DDNSInternalServerError(_("DNS error encountered."))
355 # If we got here, some other update error happened.
356 raise DDNSUpdateError
359 class DDNSProviderFreeDNSAfraidOrg(DDNSProvider
):
361 "handle" : "freedns.afraid.org",
362 "name" : "freedns.afraid.org",
363 "website" : "http://freedns.afraid.org/",
364 "protocols" : ["ipv6", "ipv4",]
367 # No information about the request or response could be found on the vendor
368 # page. All used values have been collected by testing.
369 url
= "https://freedns.afraid.org/dynamic/update.php"
373 return self
.get("proto")
376 address
= self
.get_address(self
.proto
)
382 # Add auth token to the update url.
383 url
= "%s?%s" % (self
.url
, self
.token
)
385 # Send update to the server.
386 response
= self
.send_request(url
, data
=data
)
388 if output
.startswith("Updated") or "has not changed" in output
:
391 # Handle error codes.
392 if output
== "ERROR: Unable to locate this record":
393 raise DDNSAuthenticationError
394 elif "is an invalid IP address" in output
:
395 raise DDNSRequestError(_("Invalid IP address has been sent."))
398 class DDNSProviderLightningWireLabs(DDNSProvider
):
400 "handle" : "dns.lightningwirelabs.com",
401 "name" : "Lightning Wire Labs",
402 "website" : "http://dns.lightningwirelabs.com/",
403 "protocols" : ["ipv6", "ipv4",]
406 # Information about the format of the HTTPS request is to be found
407 # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
408 url
= "https://dns.lightningwirelabs.com/update"
412 "hostname" : self
.hostname
,
415 # Check if we update an IPv6 address.
416 address6
= self
.get_address("ipv6")
418 data
["address6"] = address6
420 # Check if we update an IPv4 address.
421 address4
= self
.get_address("ipv4")
423 data
["address4"] = address4
425 # Raise an error if none address is given.
426 if not data
.has_key("address6") and not data
.has_key("address4"):
427 raise DDNSConfigurationError
429 # Check if a token has been set.
431 data
["token"] = self
.token
433 # Check for username and password.
434 elif self
.username
and self
.password
:
436 "username" : self
.username
,
437 "password" : self
.password
,
440 # Raise an error if no auth details are given.
442 raise DDNSConfigurationError
444 # Send update to the server.
445 response
= self
.send_request(self
.url
, data
=data
)
447 # Handle success messages.
448 if response
.code
== 200:
451 # Handle error codes.
452 if response
.code
== 403:
453 raise DDNSAuthenticationError
454 elif response
.code
== 400:
455 raise DDNSRequestError
457 # If we got here, some other update error happened.
458 raise DDNSUpdateError
461 class DDNSProviderNOIP(DDNSProvider
):
463 "handle" : "no-ip.com",
465 "website" : "http://www.no-ip.com/",
466 "protocols" : ["ipv4",]
469 # Information about the format of the HTTP request is to be found
470 # here: http://www.no-ip.com/integrate/request and
471 # here: http://www.no-ip.com/integrate/response
473 url
= "http://%(username)s:%(password)s@dynupdate.no-ip.com/nic/update"
477 "username" : self
.username
,
478 "password" : self
.password
,
482 "hostname" : self
.hostname
,
483 "address" : self
.get_address("ipv4"),
486 # Send update to the server.
487 response
= self
.send_request(url
, data
=data
)
489 # Get the full response message.
490 output
= response
.read()
492 # Handle success messages.
493 if output
.startswith("good") or output
.startswith("nochg"):
496 # Handle error codes.
497 if output
== "badauth":
498 raise DDNSAuthenticationError
499 elif output
== "aduse":
501 elif output
== "911":
502 raise DDNSInternalServerError
504 # If we got here, some other update error happened.
505 raise DDNSUpdateError
508 class DDNSProviderSelfhost(DDNSProvider
):
510 "handle" : "selfhost.de",
511 "name" : "Selfhost.de",
512 "website" : "http://www.selfhost.de/",
513 "protocols" : ["ipv4",],
516 url
= "https://carol.selfhost.de/update"
520 "username" : self
.username
,
521 "password" : self
.password
,
525 response
= self
.send_request(self
.url
, data
=data
)
527 match
= re
.search("status=20(0|4)", response
.read())
529 raise DDNSUpdateError