]>
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")
118 def __call__(self
, force
=False):
120 logger
.info(_("Updating %s forced") % self
.hostname
)
122 # Check if we actually need to update this host.
123 elif self
.is_uptodate(self
.protocols
):
124 logger
.info(_("%s is already up to date") % self
.hostname
)
127 # Execute the update.
131 raise NotImplementedError
133 def is_uptodate(self
, protos
):
135 Returns True if this host is already up to date
136 and does not need to change the IP address on the
140 addresses
= self
.core
.system
.resolve(self
.hostname
, proto
)
142 current_address
= self
.get_address(proto
)
144 if not current_address
in addresses
:
149 def send_request(self
, *args
, **kwargs
):
151 Proxy connection to the send request
154 return self
.core
.system
.send_request(*args
, **kwargs
)
156 def get_address(self
, proto
):
158 Proxy method to get the current IP address.
160 return self
.core
.system
.get_address(proto
)
163 class DDNSProviderDHS(DDNSProvider
):
165 "handle" : "dhs.org",
166 "name" : "DHS International",
167 "website" : "http://dhs.org/",
168 "protocols" : ["ipv4",]
171 # No information about the used update api provided on webpage,
172 # grabed from source code of ez-ipudate.
173 url
= "http://members.dhs.org/nic/hosts"
177 "username" : self
.username
,
178 "password" : self
.password
,
182 "domain" : self
.hostname
,
183 "ip" : self
.get_address("ipv4"),
185 "hostcmdstage" : "2",
189 # Send update to the server.
190 response
= self
.send_request(url
, username
=self
.username
, password
=self
.password
,
193 # Handle success messages.
194 if response
.code
== 200:
197 # Handle error codes.
198 elif response
.code
== 401:
199 raise DDNSAuthenticationError
201 # If we got here, some other update error happened.
202 raise DDNSUpdateError
205 class DDNSProviderDNSpark(DDNSProvider
):
207 "handle" : "dnspark.com",
209 "website" : "http://dnspark.com/",
210 "protocols" : ["ipv4",]
213 # Informations to the used api can be found here:
214 # https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation
215 url
= "https://control.dnspark.com/api/dynamic/update.php"
219 "username" : self
.username
,
220 "password" : self
.password
,
224 "domain" : self
.hostname
,
225 "ip" : self
.get_address("ipv4"),
228 # Send update to the server.
229 response
= self
.send_request(url
, username
=self
.username
, password
=self
.password
,
232 # Get the full response message.
233 output
= response
.read()
235 # Handle success messages.
236 if output
.startswith("ok") or output
.startswith("nochange"):
239 # Handle error codes.
240 if output
== "unauth":
241 raise DDNSAuthenticationError
242 elif output
== "abuse":
244 elif output
== "blocked":
245 raise DDNSBlockedError
246 elif output
== "nofqdn":
247 raise DDNSRequestError(_("No valid FQDN was given."))
248 elif output
== "nohost":
249 raise DDNSRequestError(_("Invalid hostname specified."))
250 elif output
== "notdyn":
251 raise DDNSRequestError(_("Hostname not marked as a dynamic host."))
252 elif output
== "invalid":
253 raise DDNSRequestError(_("Invalid IP address has been sent."))
255 # If we got here, some other update error happened.
256 raise DDNSUpdateError
259 class DDNSProviderDtDNS(DDNSProvider
):
261 "handle" : "dtdns.com",
263 "website" : "http://dtdns.com/",
264 "protocols" : ["ipv4",]
267 # Information about the format of the HTTPS request is to be found
268 # http://www.dtdns.com/dtsite/updatespec
269 url
= "https://www.dtdns.com/api/autodns.cfm"
274 "ip" : self
.get_address("ipv4"),
275 "id" : self
.hostname
,
279 # Send update to the server.
280 response
= self
.send_request(self
.url
, data
=data
)
282 # Get the full response message.
283 output
= response
.read()
285 # Remove all leading and trailing whitespace.
286 output
= output
.strip()
288 # Handle success messages.
289 if "now points to" in output
:
292 # Handle error codes.
293 if output
== "No hostname to update was supplied.":
294 raise DDNSRequestError(_("No hostname specified."))
296 elif output
== "The hostname you supplied is not valid.":
297 raise DDNSRequestError(_("Invalid hostname specified."))
299 elif output
== "The password you supplied is not valid.":
300 raise DDNSAuthenticationError
302 elif output
== "Administration has disabled this account.":
303 raise DDNSRequestError(_("Account has been disabled."))
305 elif output
== "Illegal character in IP.":
306 raise DDNSRequestError(_("Invalid IP address has been sent."))
308 elif output
== "Too many failed requests.":
309 raise DDNSRequestError(_("Too many failed requests."))
311 # If we got here, some other update error happened.
312 raise DDNSUpdateError
315 class DDNSProviderFreeDNSAfraidOrg(DDNSProvider
):
317 "handle" : "freedns.afraid.org",
318 "name" : "freedns.afraid.org",
319 "website" : "http://freedns.afraid.org/",
320 "protocols" : ["ipv6", "ipv4",]
323 # No information about the request or response could be found on the vendor
324 # page. All used values have been collected by testing.
325 url
= "https://freedns.afraid.org/dynamic/update.php"
329 return self
.get("proto")
332 address
= self
.get_address(self
.proto
)
338 # Add auth token to the update url.
339 url
= "%s?%s" % (self
.url
, self
.token
)
341 # Send update to the server.
342 response
= self
.send_request(url
, data
=data
)
344 # Get the full response message.
345 output
= response
.read()
347 # Handle success messages.
348 if output
.startswith("Updated") or "has not changed" in output
:
351 # Handle error codes.
352 if output
== "ERROR: Unable to locate this record":
353 raise DDNSAuthenticationError
354 elif "is an invalid IP address" in output
:
355 raise DDNSRequestError(_("Invalid IP address has been sent."))
357 # If we got here, some other update error happened.
358 raise DDNSUpdateError
361 class DDNSProviderLightningWireLabs(DDNSProvider
):
363 "handle" : "dns.lightningwirelabs.com",
364 "name" : "Lightning Wire Labs",
365 "website" : "http://dns.lightningwirelabs.com/",
366 "protocols" : ["ipv6", "ipv4",]
369 # Information about the format of the HTTPS request is to be found
370 # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
371 url
= "https://dns.lightningwirelabs.com/update"
376 Fast access to the token.
378 return self
.get("token")
382 "hostname" : self
.hostname
,
385 # Check if we update an IPv6 address.
386 address6
= self
.get_address("ipv6")
388 data
["address6"] = address6
390 # Check if we update an IPv4 address.
391 address4
= self
.get_address("ipv4")
393 data
["address4"] = address4
395 # Raise an error if none address is given.
396 if not data
.has_key("address6") and not data
.has_key("address4"):
397 raise DDNSConfigurationError
399 # Check if a token has been set.
401 data
["token"] = self
.token
403 # Check for username and password.
404 elif self
.username
and self
.password
:
406 "username" : self
.username
,
407 "password" : self
.password
,
410 # Raise an error if no auth details are given.
412 raise DDNSConfigurationError
414 # Send update to the server.
415 response
= self
.send_request(self
.url
, data
=data
)
417 # Handle success messages.
418 if response
.code
== 200:
421 # Handle error codes.
422 if response
.code
== 403:
423 raise DDNSAuthenticationError
424 elif response
.code
== 400:
425 raise DDNSRequestError
427 # If we got here, some other update error happened.
428 raise DDNSUpdateError
431 class DDNSProviderNOIP(DDNSProvider
):
433 "handle" : "no-ip.com",
435 "website" : "http://www.no-ip.com/",
436 "protocols" : ["ipv4",]
439 # Information about the format of the HTTP request is to be found
440 # here: http://www.no-ip.com/integrate/request and
441 # here: http://www.no-ip.com/integrate/response
443 url
= "http://%(username)s:%(password)s@dynupdate.no-ip.com/nic/update"
447 "username" : self
.username
,
448 "password" : self
.password
,
452 "hostname" : self
.hostname
,
453 "address" : self
.get_address("ipv4"),
456 # Send update to the server.
457 response
= self
.send_request(url
, data
=data
)
459 # Get the full response message.
460 output
= response
.read()
462 # Handle success messages.
463 if output
.startswith("good") or output
.startswith("nochg"):
466 # Handle error codes.
467 if output
== "badauth":
468 raise DDNSAuthenticationError
469 elif output
== "aduse":
471 elif output
== "911":
472 raise DDNSInternalServerError
474 # If we got here, some other update error happened.
475 raise DDNSUpdateError
478 class DDNSProviderSelfhost(DDNSProvider
):
480 "handle" : "selfhost.de",
481 "name" : "Selfhost.de",
482 "website" : "http://www.selfhost.de/",
483 "protocols" : ["ipv4",],
486 url
= "https://carol.selfhost.de/update"
490 "username" : self
.username
,
491 "password" : self
.password
,
495 response
= self
.send_request(self
.url
, data
=data
)
497 match
= re
.search("status=20(0|4)", response
.read())
499 raise DDNSUpdateError