]>
git.ipfire.org Git - ddns.git/blob - src/ddns/providers.py
07683957c47964e272249e6305ea56e3fde6a846
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 DDNSProviderLightningWireLabs(DDNSProvider
):
307 "handle" : "dns.lightningwirelabs.com",
308 "name" : "Lightning Wire Labs",
309 "website" : "http://dns.lightningwirelabs.com/",
310 "protocols" : ["ipv6", "ipv4",]
313 # Information about the format of the HTTPS request is to be found
314 # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
315 url
= "https://dns.lightningwirelabs.com/update"
320 Fast access to the token.
322 return self
.get("token")
326 "hostname" : self
.hostname
,
329 # Check if we update an IPv6 address.
330 address6
= self
.get_address("ipv6")
332 data
["address6"] = address6
334 # Check if we update an IPv4 address.
335 address4
= self
.get_address("ipv4")
337 data
["address4"] = address4
339 # Raise an error if none address is given.
340 if not data
.has_key("address6") and not data
.has_key("address4"):
341 raise DDNSConfigurationError
343 # Check if a token has been set.
345 data
["token"] = self
.token
347 # Check for username and password.
348 elif self
.username
and self
.password
:
350 "username" : self
.username
,
351 "password" : self
.password
,
354 # Raise an error if no auth details are given.
356 raise DDNSConfigurationError
358 # Send update to the server.
359 response
= self
.send_request(self
.url
, data
=data
)
361 # Handle success messages.
362 if response
.code
== 200:
365 # Handle error codes.
366 if response
.code
== 403:
367 raise DDNSAuthenticationError
368 elif response
.code
== 400:
369 raise DDNSRequestError
371 # If we got here, some other update error happened.
372 raise DDNSUpdateError
375 class DDNSProviderNOIP(DDNSProvider
):
377 "handle" : "no-ip.com",
379 "website" : "http://www.no-ip.com/",
380 "protocols" : ["ipv4",]
383 # Information about the format of the HTTP request is to be found
384 # here: http://www.no-ip.com/integrate/request and
385 # here: http://www.no-ip.com/integrate/response
387 url
= "http://%(username)s:%(password)s@dynupdate.no-ip.com/nic/update"
391 "username" : self
.username
,
392 "password" : self
.password
,
396 "hostname" : self
.hostname
,
397 "address" : self
.get_address("ipv4"),
400 # Send update to the server.
401 response
= self
.send_request(url
, data
=data
)
403 # Get the full response message.
404 output
= response
.read()
406 # Handle success messages.
407 if output
.startswith("good") or output
.startswith("nochg"):
410 # Handle error codes.
411 if output
== "badauth":
412 raise DDNSAuthenticationError
413 elif output
== "aduse":
415 elif output
== "911":
416 raise DDNSInternalServerError
418 # If we got here, some other update error happened.
419 raise DDNSUpdateError
422 class DDNSProviderSelfhost(DDNSProvider
):
424 "handle" : "selfhost.de",
425 "name" : "Selfhost.de",
426 "website" : "http://www.selfhost.de/",
427 "protocols" : ["ipv4",],
430 url
= "https://carol.selfhost.de/update"
434 "username" : self
.username
,
435 "password" : self
.password
,
439 response
= self
.send_request(self
.url
, data
=data
)
441 match
= re
.search("status=20(0|4)", response
.read())
443 raise DDNSUpdateError