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.
52 proxy
= self
.core
.settings
.get("proxy")
54 # Strip http:// at the beginning.
55 if proxy
and proxy
.startswith("http://"):
60 def _guess_external_ip_address(self
, url
, timeout
=10):
62 Sends a request to an external web server
63 to determine the current default IP address.
66 response
= self
.send_request(url
, timeout
=timeout
)
68 # If the server could not be reached, we will return nothing.
69 except DDNSNetworkError
:
72 if not response
.code
== 200:
75 match
= re
.search(r
"^Your IP address is: (.*)$", response
.read())
81 def guess_external_ipv6_address(self
):
83 Sends a request to the internet to determine
84 the public IPv6 address.
86 return self
._guess
_external
_ip
_address
("http://checkip6.dns.lightningwirelabs.com")
88 def guess_external_ipv4_address(self
):
90 Sends a request to the internet to determine
91 the public IPv4 address.
93 return self
._guess
_external
_ip
_address
("http://checkip4.dns.lightningwirelabs.com")
95 def send_request(self
, url
, method
="GET", data
=None, username
=None, password
=None, timeout
=30):
96 assert method
in ("GET", "POST")
98 # Add all arguments in the data dict to the URL and escape them properly.
99 if method
== "GET" and data
:
100 query_args
= self
._format
_query
_args
(data
)
104 url
= "%s&%s" % (url
, query_args
)
106 url
= "%s?%s" % (url
, query_args
)
108 logger
.debug("Sending request (%s): %s" % (method
, url
))
110 logger
.debug(" data: %s" % data
)
112 req
= urllib2
.Request(url
, data
=data
)
114 if username
and password
:
115 basic_auth_header
= self
._make
_basic
_auth
_header
(username
, password
)
116 req
.add_header("Authorization", "Basic %s" % basic_auth_header
)
118 # Set the user agent.
119 req
.add_header("User-Agent", self
.USER_AGENT
)
121 # All requests should not be cached anywhere.
122 req
.add_header("Pragma", "no-cache")
124 # Set the upstream proxy if needed.
126 logger
.debug("Using proxy: %s" % self
.proxy
)
128 # Configure the proxy for this request.
129 req
.set_proxy(self
.proxy
, "http")
131 assert req
.get_method() == method
133 logger
.debug(_("Request header:"))
134 for k
, v
in req
.headers
.items():
135 logger
.debug(" %s: %s" % (k
, v
))
138 resp
= urllib2
.urlopen(req
, timeout
=timeout
)
140 # Log response header.
141 logger
.debug(_("Response header:"))
142 for k
, v
in resp
.info().items():
143 logger
.debug(" %s: %s" % (k
, v
))
145 # Return the entire response object.
148 except urllib2
.HTTPError
, e
:
149 # 503 - Service Unavailable
151 raise DDNSServiceUnavailableError
153 # Raise all other unhandled exceptions.
156 except urllib2
.URLError
, e
:
158 # Network Unreachable (e.g. no IPv6 access)
159 if e
.reason
.errno
== 101:
160 raise DDNSNetworkUnreachableError
161 elif e
.reason
.errno
== 111:
162 raise DDNSConnectionRefusedError
164 # Raise all other unhandled exceptions.
167 except socket
.timeout
, e
:
168 logger
.debug(_("Connection timeout"))
170 raise DDNSConnectionTimeoutError
172 def _format_query_args(self
, data
):
175 for k
, v
in data
.items():
176 arg
= "%s=%s" % (k
, urllib
.quote(v
))
179 return "&".join(args
)
181 def _make_basic_auth_header(self
, username
, password
):
182 authstring
= "%s:%s" % (username
, password
)
184 # Encode authorization data in base64.
185 authstring
= base64
.encodestring(authstring
)
187 # Remove any newline characters.
188 authstring
= authstring
.replace("\n", "")
192 def get_address(self
, proto
):
193 assert proto
in ("ipv6", "ipv4")
195 # Check if the external IP address should be guessed from
197 guess_ip
= self
.core
.settings
.get("guess_external_ip", "true")
199 # If the external IP address should be used, we just do
201 if guess_ip
in ("true", "yes", "1"):
203 return self
.guess_external_ipv6_address()
205 elif proto
== "ipv4":
206 return self
.guess_external_ipv4_address()
211 def resolve(self
, hostname
, proto
=None):
216 elif proto
== "ipv6":
217 family
= socket
.AF_INET6
218 elif proto
== "ipv4":
219 family
= socket
.AF_INET
221 raise ValueError("Protocol not supported: %s" % proto
)
223 # Resolve the host address.
225 response
= socket
.getaddrinfo(hostname
, None, family
)
226 except socket
.gaierror
, e
:
227 # Name or service not known
231 # No record for requested family available (e.g. no AAAA)
238 for family
, socktype
, proto
, canonname
, sockaddr
in response
:
240 if family
== socket
.AF_INET6
:
241 address
, port
, flow_info
, scope_id
= sockaddr
243 # Only use the global scope.
244 if not scope_id
== 0:
248 elif family
== socket
.AF_INET
:
249 address
, port
= sockaddr
251 # Ignore everything else...
255 # Add to repsonse list if not already in there.
256 if not address
in addresses
:
257 addresses
.append(address
)