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 ###############################################################################
29 from __version__
import CLIENT_VERSION
33 # Initialize the logger.
35 logger
= logging
.getLogger("ddns.system")
38 class DDNSSystem(object):
40 The DDNSSystem class adds a layer of abstraction
41 between the ddns software and the system.
44 # The default useragent.
45 USER_AGENT
= "IPFireDDNSUpdater/%s" % CLIENT_VERSION
47 def __init__(self
, core
):
48 # Connection to the core of the program.
54 # Find out on which distribution we are running.
55 self
.distro
= self
._get
_distro
_identifier
()
56 logger
.debug(_("Running on distribution: %s") % self
.distro
)
60 proxy
= self
.core
.settings
.get("proxy")
62 # Strip http:// at the beginning.
63 if proxy
and proxy
.startswith("http://"):
68 def get_local_ip_address(self
, proto
):
69 # Legacy code for IPFire 2.
70 if self
.distro
== "ipfire-2" and proto
== "ipv4":
72 with
open("/var/ipfire/red/local-ipaddress") as f
:
83 raise NotImplementedError
85 def _guess_external_ip_address(self
, url
, timeout
=10):
87 Sends a request to an external web server
88 to determine the current default IP address.
91 response
= self
.send_request(url
, timeout
=timeout
)
93 # If the server could not be reached, we will return nothing.
94 except DDNSNetworkError
:
97 if not response
.code
== 200:
100 match
= re
.search(r
"^Your IP address is: (.*)$", response
.read())
104 return match
.group(1)
106 def guess_external_ip_address(self
, family
, **kwargs
):
108 url
= "http://checkip6.dns.lightningwirelabs.com"
109 elif family
== "ipv4":
110 url
= "http://checkip4.dns.lightningwirelabs.com"
112 raise ValueError("unknown address family")
114 return self
._guess
_external
_ip
_address
(url
, **kwargs
)
116 def send_request(self
, url
, method
="GET", data
=None, username
=None, password
=None, timeout
=30):
117 assert method
in ("GET", "POST")
119 # Add all arguments in the data dict to the URL and escape them properly.
120 if method
== "GET" and data
:
121 query_args
= self
._format
_query
_args
(data
)
125 url
= "%s&%s" % (url
, query_args
)
127 url
= "%s?%s" % (url
, query_args
)
129 logger
.debug("Sending request (%s): %s" % (method
, url
))
131 logger
.debug(" data: %s" % data
)
133 req
= urllib2
.Request(url
, data
=data
)
135 if username
and password
:
136 basic_auth_header
= self
._make
_basic
_auth
_header
(username
, password
)
137 req
.add_header("Authorization", "Basic %s" % basic_auth_header
)
139 # Set the user agent.
140 req
.add_header("User-Agent", self
.USER_AGENT
)
142 # All requests should not be cached anywhere.
143 req
.add_header("Pragma", "no-cache")
145 # Set the upstream proxy if needed.
147 logger
.debug("Using proxy: %s" % self
.proxy
)
149 # Configure the proxy for this request.
150 req
.set_proxy(self
.proxy
, "http")
152 assert req
.get_method() == method
154 logger
.debug(_("Request header:"))
155 for k
, v
in req
.headers
.items():
156 logger
.debug(" %s: %s" % (k
, v
))
159 resp
= urllib2
.urlopen(req
, timeout
=timeout
)
161 # Log response header.
162 logger
.debug(_("Response header (Status Code %s):") % resp
.code
)
163 for k
, v
in resp
.info().items():
164 logger
.debug(" %s: %s" % (k
, v
))
166 # Return the entire response object.
169 except urllib2
.HTTPError
, e
:
170 # Log response header.
171 logger
.debug(_("Response header (Status Code %s):") % e
.code
)
172 for k
, v
in e
.hdrs
.items():
173 logger
.debug(" %s: %s" % (k
, v
))
177 raise DDNSRequestError(e
.reason
)
179 # 401 - Authorization Required
181 elif e
.code
in (401, 403):
182 raise DDNSAuthenticationError(e
.reason
)
185 # Either the provider has changed the API, or
186 # there is an error on the server
188 raise DDNSNotFound(e
.reason
)
190 # 500 - Internal Server Error
192 raise DDNSInternalServerError(e
.reason
)
194 # 503 - Service Unavailable
196 raise DDNSServiceUnavailableError(e
.reason
)
198 # Raise all other unhandled exceptions.
201 except urllib2
.URLError
, e
:
204 if isinstance(e
.reason
, ssl
.SSLError
):
207 if e
.reason
== "CERTIFICATE_VERIFY_FAILED":
208 raise DDNSCertificateError
210 # Raise all other SSL errors
211 raise DDNSSSLError(e
.reason
)
213 # Name or service not known
214 if e
.reason
.errno
== -2:
215 raise DDNSResolveError
217 # Network Unreachable (e.g. no IPv6 access)
218 if e
.reason
.errno
== 101:
219 raise DDNSNetworkUnreachableError
222 elif e
.reason
.errno
== 111:
223 raise DDNSConnectionRefusedError
226 elif e
.reason
.errno
== 113:
227 raise DDNSNoRouteToHostError(req
.host
)
229 # Raise all other unhandled exceptions.
232 except socket
.timeout
, e
:
233 logger
.debug(_("Connection timeout"))
235 raise DDNSConnectionTimeoutError
237 def _format_query_args(self
, data
):
240 for k
, v
in data
.items():
241 arg
= "%s=%s" % (k
, urllib
.quote(v
))
244 return "&".join(args
)
246 def _make_basic_auth_header(self
, username
, password
):
247 authstring
= "%s:%s" % (username
, password
)
249 # Encode authorization data in base64.
250 authstring
= base64
.encodestring(authstring
)
252 # Remove any newline characters.
253 authstring
= authstring
.replace("\n", "")
257 def get_address(self
, proto
):
259 Returns the current IP address for
260 the given IP protocol.
263 return self
.__addresses
[proto
]
265 # IP is currently unknown and needs to be retrieved.
267 self
.__addresses
[proto
] = address
= \
268 self
._get
_address
(proto
)
272 def _get_address(self
, proto
):
273 assert proto
in ("ipv6", "ipv4")
275 # IPFire 2 does not support IPv6.
276 if self
.distro
== "ipfire-2" and proto
== "ipv6":
279 # Check if the external IP address should be guessed from
281 guess_ip
= self
.core
.settings
.get("guess_external_ip", "true")
282 guess_ip
= guess_ip
in ("true", "yes", "1")
284 # If the external IP address should be used, we just do that.
286 return self
.guess_external_ip_address(proto
)
288 # Get the local IP address.
289 local_ip_address
= self
.get_local_ip_address(proto
)
291 # If the local IP address is not usable, we must guess
292 # the correct IP address...
293 if not self
._is
_usable
_ip
_address
(proto
, local_ip_address
):
294 local_ip_address
= self
.guess_external_ip_address(proto
)
296 return local_ip_address
298 def _is_usable_ip_address(self
, proto
, address
):
300 Returns True is the local IP address is usable
301 for dynamic DNS (i.e. is not a RFC1918 address or similar).
304 # This is not the most perfect solution to match
305 # these addresses, but instead of pulling in an entire
306 # library to handle the IP addresses better, we match
307 # with regular expressions instead.
309 # RFC1918 address space
310 r
"^10\.\d+\.\d+\.\d+$",
311 r
"^192\.168\.\d+\.\d+$",
312 r
"^172\.(1[6-9]|2[0-9]|31)\.\d+\.\d+$",
314 # Dual Stack Lite address space
315 r
"^100\.(6[4-9]|[7-9][0-9]|1[01][0-9]|12[0-7])\.\d+\.\d+$",
318 for match
in matches
:
319 m
= re
.match(match
, address
)
323 # Found a match. IP address is not usable.
326 # In all other cases, return OK.
329 def resolve(self
, hostname
, proto
=None):
334 elif proto
== "ipv6":
335 family
= socket
.AF_INET6
336 elif proto
== "ipv4":
337 family
= socket
.AF_INET
339 raise ValueError("Protocol not supported: %s" % proto
)
341 # Resolve the host address.
343 response
= socket
.getaddrinfo(hostname
, None, family
)
344 except socket
.gaierror
, e
:
345 # Name or service not known
349 # Temporary failure in name resolution
351 raise DDNSResolveError(hostname
)
353 # No record for requested family available (e.g. no AAAA)
360 for family
, socktype
, proto
, canonname
, sockaddr
in response
:
362 if family
== socket
.AF_INET6
:
363 address
, port
, flow_info
, scope_id
= sockaddr
365 # Only use the global scope.
366 if not scope_id
== 0:
370 elif family
== socket
.AF_INET
:
371 address
, port
= sockaddr
373 # Ignore everything else...
377 # Add to repsonse list if not already in there.
378 if not address
in addresses
:
379 addresses
.append(address
)
383 def _get_distro_identifier(self
):
385 Returns a unique identifier for the distribution
388 os_release
= self
.__parse
_os
_release
()
392 system_release
= self
.__parse
_system
_release
()
394 return system_release
396 # If nothing else could be found, we return
400 def __parse_os_release(self
):
402 Tries to parse /etc/os-release and
403 returns a unique distribution identifier
407 f
= open("/etc/os-release", "r")
417 for line
in f
.readlines():
418 m
= re
.match(r
"^([A-Z\_]+)=(.*)$", line
)
422 os_release
[m
.group(1)] = m
.group(2)
425 return "%(ID)s-%(VERSION_ID)s" % os_release
429 def __parse_system_release(self
):
431 Tries to parse /etc/system-release and
432 returns a unique distribution identifier
436 f
= open("/etc/system-release", "r")
448 # Check for IPFire systems
449 m
= re
.match(r
"^IPFire (\d).(\d+)", line
)
451 return "ipfire-%s" % m
.group(1)