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 ###############################################################################
28 from __version__
import CLIENT_VERSION
32 # Initialize the logger.
34 logger
= logging
.getLogger("ddns.system")
37 class DDNSSystem(object):
39 The DDNSSystem class adds a layer of abstraction
40 between the ddns software and the system.
43 # The default useragent.
44 USER_AGENT
= "IPFireDDNSUpdater/%s" % CLIENT_VERSION
46 def __init__(self
, core
):
47 # Connection to the core of the program.
53 # Find out on which distribution we are running.
54 self
.distro
= self
._get
_distro
_identifier
()
55 logger
.debug(_("Running on distribution: %s") % self
.distro
)
59 proxy
= self
.core
.settings
.get("proxy")
61 # Strip http:// at the beginning.
62 if proxy
and proxy
.startswith("http://"):
67 def get_local_ip_address(self
, proto
):
68 # Legacy code for IPFire 2.
69 if self
.distro
== "ipfire-2" and proto
== "ipv4":
71 with
open("/var/ipfire/red/local-ipaddress") as f
:
82 raise NotImplementedError
84 def _guess_external_ip_address(self
, url
, timeout
=10):
86 Sends a request to an external web server
87 to determine the current default IP address.
90 response
= self
.send_request(url
, timeout
=timeout
)
92 # If the server could not be reached, we will return nothing.
93 except DDNSNetworkError
:
96 if not response
.code
== 200:
99 match
= re
.search(r
"^Your IP address is: (.*)$", response
.read())
103 return match
.group(1)
105 def guess_external_ip_address(self
, family
, **kwargs
):
107 url
= "http://checkip6.dns.lightningwirelabs.com"
108 elif family
== "ipv4":
109 url
= "http://checkip4.dns.lightningwirelabs.com"
111 raise ValueError("unknown address family")
113 return self
._guess
_external
_ip
_address
(url
, **kwargs
)
115 def send_request(self
, url
, method
="GET", data
=None, username
=None, password
=None, timeout
=30):
116 assert method
in ("GET", "POST")
118 # Add all arguments in the data dict to the URL and escape them properly.
119 if method
== "GET" and data
:
120 query_args
= self
._format
_query
_args
(data
)
124 url
= "%s&%s" % (url
, query_args
)
126 url
= "%s?%s" % (url
, query_args
)
128 logger
.debug("Sending request (%s): %s" % (method
, url
))
130 logger
.debug(" data: %s" % data
)
132 req
= urllib2
.Request(url
, data
=data
)
134 if username
and password
:
135 basic_auth_header
= self
._make
_basic
_auth
_header
(username
, password
)
136 req
.add_header("Authorization", "Basic %s" % basic_auth_header
)
138 # Set the user agent.
139 req
.add_header("User-Agent", self
.USER_AGENT
)
141 # All requests should not be cached anywhere.
142 req
.add_header("Pragma", "no-cache")
144 # Set the upstream proxy if needed.
146 logger
.debug("Using proxy: %s" % self
.proxy
)
148 # Configure the proxy for this request.
149 req
.set_proxy(self
.proxy
, "http")
151 assert req
.get_method() == method
153 logger
.debug(_("Request header:"))
154 for k
, v
in req
.headers
.items():
155 logger
.debug(" %s: %s" % (k
, v
))
158 resp
= urllib2
.urlopen(req
, timeout
=timeout
)
160 # Log response header.
161 logger
.debug(_("Response header (Status Code %s):") % resp
.code
)
162 for k
, v
in resp
.info().items():
163 logger
.debug(" %s: %s" % (k
, v
))
165 # Return the entire response object.
168 except urllib2
.HTTPError
, e
:
169 # Log response header.
170 logger
.debug(_("Response header (Status Code %s):") % e
.code
)
171 for k
, v
in e
.hdrs
.items():
172 logger
.debug(" %s: %s" % (k
, v
))
176 raise DDNSRequestError(e
.reason
)
178 # 401 - Authorization Required
180 elif e
.code
in (401, 403):
181 raise DDNSAuthenticationError(e
.reason
)
183 # 500 - Internal Server Error
185 raise DDNSInternalServerError(e
.reason
)
187 # 503 - Service Unavailable
189 raise DDNSServiceUnavailableError(e
.reason
)
191 # Raise all other unhandled exceptions.
194 except urllib2
.URLError
, e
:
196 # Name or service not known
197 if e
.reason
.errno
== -2:
198 raise DDNSResolveError
200 # Network Unreachable (e.g. no IPv6 access)
201 if e
.reason
.errno
== 101:
202 raise DDNSNetworkUnreachableError
205 elif e
.reason
.errno
== 111:
206 raise DDNSConnectionRefusedError
208 # Raise all other unhandled exceptions.
211 except socket
.timeout
, e
:
212 logger
.debug(_("Connection timeout"))
214 raise DDNSConnectionTimeoutError
216 def _format_query_args(self
, data
):
219 for k
, v
in data
.items():
220 arg
= "%s=%s" % (k
, urllib
.quote(v
))
223 return "&".join(args
)
225 def _make_basic_auth_header(self
, username
, password
):
226 authstring
= "%s:%s" % (username
, password
)
228 # Encode authorization data in base64.
229 authstring
= base64
.encodestring(authstring
)
231 # Remove any newline characters.
232 authstring
= authstring
.replace("\n", "")
236 def get_address(self
, proto
):
238 Returns the current IP address for
239 the given IP protocol.
242 return self
.__addresses
[proto
]
244 # IP is currently unknown and needs to be retrieved.
246 self
.__addresses
[proto
] = address
= \
247 self
._get
_address
(proto
)
251 def _get_address(self
, proto
):
252 assert proto
in ("ipv6", "ipv4")
254 # IPFire 2 does not support IPv6.
255 if self
.distro
== "ipfire-2" and proto
== "ipv6":
258 # Check if the external IP address should be guessed from
260 guess_ip
= self
.core
.settings
.get("guess_external_ip", "true")
261 guess_ip
= guess_ip
in ("true", "yes", "1")
263 # If the external IP address should be used, we just do that.
265 return self
.guess_external_ip_address(proto
)
267 # Get the local IP address.
268 local_ip_address
= self
.get_local_ip_address(proto
)
270 # If the local IP address is not usable, we must guess
271 # the correct IP address...
272 if not self
._is
_usable
_ip
_address
(proto
, local_ip_address
):
273 local_ip_address
= self
.guess_external_ip_address(proto
)
275 return local_ip_address
277 def _is_usable_ip_address(self
, proto
, address
):
279 Returns True is the local IP address is usable
280 for dynamic DNS (i.e. is not a RFC1918 address or similar).
283 # This is not the most perfect solution to match
284 # these addresses, but instead of pulling in an entire
285 # library to handle the IP addresses better, we match
286 # with regular expressions instead.
288 # RFC1918 address space
289 r
"^10\.\d+\.\d+\.\d+$",
290 r
"^192\.168\.\d+\.\d+$",
291 r
"^172\.(1[6-9]|2[0-9]|31)\.\d+\.\d+$",
293 # Dual Stack Lite address space
294 r
"^100\.(6[4-9]|[7-9][0-9]|1[01][0-9]|12[0-7])\.\d+\.\d+$",
297 for match
in matches
:
298 m
= re
.match(match
, address
)
302 # Found a match. IP address is not usable.
305 # In all other cases, return OK.
308 def resolve(self
, hostname
, proto
=None):
313 elif proto
== "ipv6":
314 family
= socket
.AF_INET6
315 elif proto
== "ipv4":
316 family
= socket
.AF_INET
318 raise ValueError("Protocol not supported: %s" % proto
)
320 # Resolve the host address.
322 response
= socket
.getaddrinfo(hostname
, None, family
)
323 except socket
.gaierror
, e
:
324 # Name or service not known
328 # Temporary failure in name resolution
330 raise DDNSResolveError(hostname
)
332 # No record for requested family available (e.g. no AAAA)
339 for family
, socktype
, proto
, canonname
, sockaddr
in response
:
341 if family
== socket
.AF_INET6
:
342 address
, port
, flow_info
, scope_id
= sockaddr
344 # Only use the global scope.
345 if not scope_id
== 0:
349 elif family
== socket
.AF_INET
:
350 address
, port
= sockaddr
352 # Ignore everything else...
356 # Add to repsonse list if not already in there.
357 if not address
in addresses
:
358 addresses
.append(address
)
362 def _get_distro_identifier(self
):
364 Returns a unique identifier for the distribution
367 os_release
= self
.__parse
_os
_release
()
371 system_release
= self
.__parse
_system
_release
()
373 return system_release
375 # If nothing else could be found, we return
379 def __parse_os_release(self
):
381 Tries to parse /etc/os-release and
382 returns a unique distribution identifier
386 f
= open("/etc/os-release", "r")
396 for line
in f
.readlines():
397 m
= re
.match(r
"^([A-Z\_]+)=(.*)$", line
)
401 os_release
[m
.group(1)] = m
.group(2)
404 return "%(ID)s-%(VERSION_ID)s" % os_release
408 def __parse_system_release(self
):
410 Tries to parse /etc/system-release and
411 returns a unique distribution identifier
415 f
= open("/etc/system-release", "r")
427 # Check for IPFire systems
428 m
= re
.match(r
"^IPFire (\d).(\d+)", line
)
430 return "ipfire-%s" % m
.group(1)