Add DHS as new provider.
[oddments/ddns.git] / src / ddns / providers.py
1 #!/usr/bin/python
2 ###############################################################################
3 # #
4 # ddns - A dynamic DNS client for IPFire #
5 # Copyright (C) 2012 IPFire development team #
6 # #
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. #
11 # #
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. #
16 # #
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/>. #
19 # #
20 ###############################################################################
21
22 # Import all possible exception types.
23 from .errors import *
24
25 class DDNSProvider(object):
26 INFO = {
27 # A short string that uniquely identifies
28 # this provider.
29 "handle" : None,
30
31 # The full name of the provider.
32 "name" : None,
33
34 # A weburl to the homepage of the provider.
35 # (Where to register a new account?)
36 "website" : None,
37
38 # A list of supported protocols.
39 "protocols" : ["ipv6", "ipv4"],
40 }
41
42 DEFAULT_SETTINGS = {}
43
44 def __init__(self, core, **settings):
45 self.core = core
46
47 # Copy a set of default settings and
48 # update them by those from the configuration file.
49 self.settings = self.DEFAULT_SETTINGS.copy()
50 self.settings.update(settings)
51
52 def __repr__(self):
53 return "<DDNS Provider %s (%s)>" % (self.name, self.handle)
54
55 def __cmp__(self, other):
56 return cmp(self.hostname, other.hostname)
57
58 @property
59 def name(self):
60 """
61 Returns the name of the provider.
62 """
63 return self.INFO.get("name")
64
65 @property
66 def website(self):
67 """
68 Returns the website URL of the provider
69 or None if that is not available.
70 """
71 return self.INFO.get("website", None)
72
73 @property
74 def handle(self):
75 """
76 Returns the handle of this provider.
77 """
78 return self.INFO.get("handle")
79
80 def get(self, key, default=None):
81 """
82 Get a setting from the settings dictionary.
83 """
84 return self.settings.get(key, default)
85
86 @property
87 def hostname(self):
88 """
89 Fast access to the hostname.
90 """
91 return self.get("hostname")
92
93 @property
94 def username(self):
95 """
96 Fast access to the username.
97 """
98 return self.get("username")
99
100 @property
101 def password(self):
102 """
103 Fast access to the password.
104 """
105 return self.get("password")
106
107 def __call__(self):
108 raise NotImplementedError
109
110 def send_request(self, *args, **kwargs):
111 """
112 Proxy connection to the send request
113 method.
114 """
115 return self.core.system.send_request(*args, **kwargs)
116
117 def get_address(self, proto):
118 """
119 Proxy method to get the current IP address.
120 """
121 return self.core.system.get_address(proto)
122
123
124 class DDNSProviderDHS(DDNSProvider):
125 INFO = {
126 "handle" : "dhs.org",
127 "name" : "DHS International",
128 "website" : "http://dhs.org/",
129 "protocols" : ["ipv4",]
130 }
131
132 # No information about the used update api provided on webpage,
133 # grabed from source code of ez-ipudate.
134 url = "http://members.dhs.org/nic/hosts"
135
136 def __call__(self):
137 url = self.url % {
138 "username" : self.username,
139 "password" : self.password,
140 }
141
142 data = {
143 "domain" : self.hostname,
144 "ip" : self.get_address("ipv4"),
145 "hostcmd" : "edit",
146 "hostcmdstage" : "2",
147 "type" : "4",
148 }
149
150 # Send update to the server.
151 response = self.send_request(url, username=self.username, password=self.password,
152 data=data)
153
154 # Handle success messages.
155 if response.code == 200:
156 return
157
158 # Handle error codes.
159 elif response.code == "401":
160 raise DDNSAuthenticationError
161
162 # If we got here, some other update error happened.
163 raise DDNSUpdateError
164
165
166 class DDNSProviderLightningWireLabs(DDNSProvider):
167 INFO = {
168 "handle" : "dns.lightningwirelabs.com",
169 "name" : "Lightning Wire Labs",
170 "website" : "http://dns.lightningwirelabs.com/",
171 "protocols" : ["ipv6", "ipv4",]
172 }
173
174 # Information about the format of the HTTPS request is to be found
175 # https://dns.lightningwirelabs.com/knowledge-base/api/ddns
176 url = "https://dns.lightningwirelabs.com/update"
177
178 @property
179 def token(self):
180 """
181 Fast access to the token.
182 """
183 return self.get("token")
184
185 def __call__(self):
186 data = {
187 "hostname" : self.hostname,
188 }
189
190 # Check if we update an IPv6 address.
191 address6 = self.get_address("ipv6")
192 if address6:
193 data["address6"] = address6
194
195 # Check if we update an IPv4 address.
196 address4 = self.get_address("ipv4")
197 if address4:
198 data["address4"] = address4
199
200 # Raise an error if none address is given.
201 if not data.has_key("address6") and not data.has_key("address4"):
202 raise DDNSConfigurationError
203
204 # Check if a token has been set.
205 if self.token:
206 data["token"] = self.token
207
208 # Check for username and password.
209 elif self.username and self.password:
210 data.update({
211 "username" : self.username,
212 "password" : self.password,
213 })
214
215 # Raise an error if no auth details are given.
216 else:
217 raise DDNSConfigurationError
218
219 # Send update to the server.
220 response = self.send_request(url, data=data)
221
222 # Handle success messages.
223 if response.code == 200:
224 return
225
226 # Handle error codes.
227 if response.code == "403":
228 raise DDNSAuthenticationError
229 elif response.code == "400":
230 raise DDNSRequestError
231
232 # If we got here, some other update error happened.
233 raise DDNSUpdateError
234
235
236 class DDNSProviderNOIP(DDNSProvider):
237 INFO = {
238 "handle" : "no-ip.com",
239 "name" : "No-IP",
240 "website" : "http://www.no-ip.com/",
241 "protocols" : ["ipv4",]
242 }
243
244 # Information about the format of the HTTP request is to be found
245 # here: http://www.no-ip.com/integrate/request and
246 # here: http://www.no-ip.com/integrate/response
247
248 url = "http://%(username)s:%(password)s@dynupdate.no-ip.com/nic/update"
249
250 def __call__(self):
251 url = self.url % {
252 "username" : self.username,
253 "password" : self.password,
254 }
255
256 data = {
257 "hostname" : self.hostname,
258 "address" : self.get_address("ipv4"),
259 }
260
261 # Send update to the server.
262 response = self.send_request(url, data=data)
263
264 # Get the full response message.
265 output = response.read()
266
267 # Handle success messages.
268 if output.startswith("good") or output.startswith("nochg"):
269 return
270
271 # Handle error codes.
272 if output == "badauth":
273 raise DDNSAuthenticationError
274 elif output == "aduse":
275 raise DDNSAbuseError
276 elif output == "911":
277 raise DDNSInternalServerError
278
279 # If we got here, some other update error happened.
280 raise DDNSUpdateError
281
282
283 class DDNSProviderSelfhost(DDNSProvider):
284 INFO = {
285 "handle" : "selfhost.de",
286 "name" : "Selfhost.de",
287 "website" : "http://www.selfhost.de/",
288 "protocols" : ["ipv4",],
289 }
290
291 url = "https://carol.selfhost.de/update"
292
293 def __call__(self):
294 data = {
295 "username" : self.username,
296 "password" : self.password,
297 "textmodi" : "1",
298 }
299
300 response = self.send_request(self.url, data=data)
301
302 match = re.search("status=20(0|4)", response.read())
303 if not match:
304 raise DDNSUpdateError