]>
git.ipfire.org Git - 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 "domain" : self
.hostname
,
178 "ip" : self
.get_address("ipv4"),
180 "hostcmdstage" : "2",
184 # Send update to the server.
185 response
= self
.send_request(self
.url
, username
=self
.username
, password
=self
.password
,
188 # Handle success messages.
189 if response
.code
== 200:
192 # Handle error codes.
193 elif response
.code
== 401:
194 raise DDNSAuthenticationError
196 # If we got here, some other update error happened.
197 raise DDNSUpdateError
200 class DDNSProviderDNSpark(DDNSProvider
):
202 "handle" : "dnspark.com",
204 "website" : "http://dnspark.com/",
205 "protocols" : ["ipv4",]
208 # Informations to the used api can be found here:
209 # https://dnspark.zendesk.com/entries/31229348-Dynamic-DNS-API-Documentation
210 url
= "https://control.dnspark.com/api/dynamic/update.php"
214 "domain" : self
.hostname
,
215 "ip" : self
.get_address("ipv4"),
218 # Send update to the server.
219 response
= self
.send_request(self
.url
, username
=self
.username
, password
=self
.password
,
222 # Get the full response message.
223 output
= response
.read()
225 # Handle success messages.
226 if output
.startswith("ok") or output
.startswith("nochange"):
229 # Handle error codes.
230 if output
== "unauth":
231 raise DDNSAuthenticationError
232 elif output
== "abuse":
234 elif output
== "blocked":
235 raise DDNSBlockedError
236 elif output
== "nofqdn":
237 raise DDNSRequestError(_("No valid FQDN was given."))
238 elif output
== "nohost":
239 raise DDNSRequestError(_("Invalid hostname specified."))
240 elif output
== "notdyn":
241 raise DDNSRequestError(_("Hostname not marked as a dynamic host."))
242 elif output
== "invalid":
243 raise DDNSRequestError(_("Invalid IP address has been sent."))
245 # If we got here, some other update error happened.
246 raise DDNSUpdateError
249 class DDNSProviderDtDNS(DDNSProvider
):
251 "handle" : "dtdns.com",
253 "website" : "http://dtdns.com/",
254 "protocols" : ["ipv4",]
257 # Information about the format of the HTTPS request is to be found
258 # http://www.dtdns.com/dtsite/updatespec
259 url
= "https://www.dtdns.com/api/autodns.cfm"
264 "ip" : self
.get_address("ipv4"),
265 "id" : self
.hostname
,
269 # Send update to the server.
270 response
= self
.send_request(self
.url
, data
=data
)
272 # Get the full response message.
273 output
= response
.read()
275 # Remove all leading and trailing whitespace.
276 output
= output
.strip()
278 # Handle success messages.
279 if "now points to" in output
:
282 # Handle error codes.
283 if output
== "No hostname to update was supplied.":
284 raise DDNSRequestError(_("No hostname specified."))
286 elif output
== "The hostname you supplied is not valid.":
287 raise DDNSRequestError(_("Invalid hostname specified."))
289 elif output
== "The password you supplied is not valid.":
290 raise DDNSAuthenticationError
292 elif output
== "Administration has disabled this account.":
293 raise DDNSRequestError(_("Account has been disabled."))
295 elif output
== "Illegal character in IP.":
296 raise DDNSRequestError(_("Invalid IP address has been sent."))
298 elif output
== "Too many failed requests.":
299 raise DDNSRequestError(_("Too many failed requests."))
301 # If we got here, some other update error happened.
302 raise DDNSUpdateError
305 class DDNSProviderDynDNS(DDNSProvider
):
307 "handle" : "dyndns.org",
309 "website" : "http://dyn.com/dns/",
310 "protocols" : ["ipv4",]
313 # Information about the format of the request is to be found
314 # http://http://dyn.com/support/developers/api/perform-update/
315 # http://dyn.com/support/developers/api/return-codes/
316 url
= "https://members.dyndns.org/nic/update"
318 def _prepare_request_data(self
):
320 "hostname" : self
.hostname
,
321 "myip" : self
.get_address("ipv4"),
327 data
= self
._prepare
_request
_data
()
329 # Send update to the server.
330 response
= self
.send_request(self
.url
, data
=data
,
331 username
=self
.username
, password
=self
.password
)
333 # Get the full response message.
334 output
= response
.read()
336 # Handle success messages.
337 if output
.startswith("good") or output
.startswith("nochg"):
340 # Handle error codes.
341 if output
== "badauth":
342 raise DDNSAuthenticationError
343 elif output
== "aduse":
345 elif output
== "notfqdn":
346 raise DDNSRequestError(_("No valid FQDN was given."))
347 elif output
== "nohost":
348 raise DDNSRequestError(_("Specified host does not exist."))
349 elif output
== "911":
350 raise DDNSInternalServerError
351 elif output
== "dnserr":
352 raise DDNSInternalServerError(_("DNS error encountered."))
354 # If we got here, some other update error happened.
355 raise DDNSUpdateError
358 class DDNSProviderLightningWireLabs(DDNSProvider
):
360 "handle" : "dns.lightningwirelabs.com",
361 "name" : "Lightning Wire Labs",
362 "website" : "http://dns.lightningwirelabs.com/",
363 "protocols" : ["ipv6", "ipv4",]
366 # Information about the format of the HTTPS request is to be found
367 # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
368 url
= "https://dns.lightningwirelabs.com/update"
373 Fast access to the token.
375 return self
.get("token")
379 "hostname" : self
.hostname
,
382 # Check if we update an IPv6 address.
383 address6
= self
.get_address("ipv6")
385 data
["address6"] = address6
387 # Check if we update an IPv4 address.
388 address4
= self
.get_address("ipv4")
390 data
["address4"] = address4
392 # Raise an error if none address is given.
393 if not data
.has_key("address6") and not data
.has_key("address4"):
394 raise DDNSConfigurationError
396 # Check if a token has been set.
398 data
["token"] = self
.token
400 # Check for username and password.
401 elif self
.username
and self
.password
:
403 "username" : self
.username
,
404 "password" : self
.password
,
407 # Raise an error if no auth details are given.
409 raise DDNSConfigurationError
411 # Send update to the server.
412 response
= self
.send_request(self
.url
, data
=data
)
414 # Handle success messages.
415 if response
.code
== 200:
418 # Handle error codes.
419 if response
.code
== 403:
420 raise DDNSAuthenticationError
421 elif response
.code
== 400:
422 raise DDNSRequestError
424 # If we got here, some other update error happened.
425 raise DDNSUpdateError
428 class DDNSProviderNOIP(DDNSProviderDynDNS
):
430 "handle" : "no-ip.com",
432 "website" : "http://www.no-ip.com/",
433 "protocols" : ["ipv4",]
436 # Information about the format of the HTTP request is to be found
437 # here: http://www.no-ip.com/integrate/request and
438 # here: http://www.no-ip.com/integrate/response
440 url
= "http://dynupdate.no-ip.com/nic/update"
442 def _prepare_request_data(self
):
444 "hostname" : self
.hostname
,
445 "address" : self
.get_address("ipv4"),
451 class DDNSProviderSelfhost(DDNSProvider
):
453 "handle" : "selfhost.de",
454 "name" : "Selfhost.de",
455 "website" : "http://www.selfhost.de/",
456 "protocols" : ["ipv4",],
459 url
= "https://carol.selfhost.de/update"
463 "username" : self
.username
,
464 "password" : self
.password
,
468 response
= self
.send_request(self
.url
, data
=data
)
470 match
= re
.search("status=20(0|4)", response
.read())
472 raise DDNSUpdateError