1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
# -*- coding: utf-8 -*-
# eipconfig.py
# Copyright (C) 2013 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Provider configuration
"""
import logging
import os
import re
import time
import ipaddr
from leap.common.check import leap_assert, leap_assert_type
from leap.common.config.baseconfig import BaseConfig
from leap.config.providerconfig import ProviderConfig
from leap.services.eip.eipspec import get_schema
logger = logging.getLogger(__name__)
class VPNGatewaySelector(object):
"""
VPN Gateway selector.
"""
# http://www.timeanddate.com/time/map/
equivalent_timezones = {13: -11, 14: -10}
def __init__(self, eipconfig, tz_offset=None):
'''
Constructor for VPNGatewaySelector.
:param eipconfig: a valid EIP Configuration.
:type eipconfig: EIPConfig
:param tz_offset: use this offset as a local distance to GMT.
:type tz_offset: int
'''
leap_assert_type(eipconfig, EIPConfig)
self._local_offset = tz_offset
if tz_offset is None:
tz_offset = self._get_local_offset()
if tz_offset in self.equivalent_timezones:
tz_offset = self.equivalent_timezones[tz_offset]
self._local_offset = tz_offset
self._eipconfig = eipconfig
def get_gateways(self):
"""
Returns the 4 best gateways, sorted by timezone proximity.
:rtype: list of IPv4Address or IPv6Address object.
"""
gateways_timezones = []
locations = self._eipconfig.get_locations()
gateways = self._eipconfig.get_gateways()
for idx, gateway in enumerate(gateways):
gateway_location = gateway.get('location')
gateway_distance = 99 # if hasn't location -> should go last
if gateway_location is not None:
gw_offset = int(locations[gateway['location']]['timezone'])
if gw_offset in self.equivalent_timezones:
gw_offset = self.equivalent_timezones[gw_offset]
gateway_distance = self._get_timezone_distance(gw_offset)
ip = self._eipconfig.get_gateway_ip(idx)
gateways_timezones.append((ip, gateway_distance))
gateways_timezones = sorted(gateways_timezones,
key=lambda gw: gw[1])[:4]
gateways = [ip for ip, dist in gateways_timezones]
return gateways
def _get_timezone_distance(self, offset):
'''
Returns the distance between the local timezone and
the one with offset 'offset'.
:param offset: the distance of a timezone to GMT.
:type offset: int
:returns: distance between local offset and param offset.
:rtype: int
'''
timezones = range(-11, 13)
tz1 = offset
tz2 = self._local_offset
distance = abs(timezones.index(tz1) - timezones.index(tz2))
if distance > 12:
if tz1 < 0:
distance = timezones.index(tz1) + timezones[::-1].index(tz2)
else:
distance = timezones[::-1].index(tz1) + timezones.index(tz2)
return distance
def _get_local_offset(self):
'''
Returns the distance between GMT and the local timezone.
:rtype: int
'''
local_offset = time.timezone
if time.daylight:
local_offset = time.altzone
return local_offset / 3600
class EIPConfig(BaseConfig):
"""
Provider configuration abstraction class
"""
OPENVPN_ALLOWED_KEYS = ("auth", "cipher", "tls-cipher")
OPENVPN_CIPHERS_REGEX = re.compile("[A-Z0-9\-]+")
def __init__(self):
BaseConfig.__init__(self)
self._api_version = None
self._get_schema = get_schema
def get_clusters(self):
# TODO: create an abstraction for clusters
return self._safe_get_value("clusters")
def get_gateways(self):
# TODO: create an abstraction for gateways
return self._safe_get_value("gateways")
def get_locations(self):
'''
Returns a list of locations
:rtype: dict
'''
return self._safe_get_value("locations")
def get_openvpn_configuration(self):
"""
Returns a dictionary containing the openvpn configuration
parameters.
These are sanitized with alphanumeric whitelist.
:returns: openvpn configuration dict
:rtype: C{dict}
"""
ovpncfg = self._safe_get_value("openvpn_configuration")
config = {}
for key, value in ovpncfg.items():
if key in self.OPENVPN_ALLOWED_KEYS and value is not None:
sanitized_val = self.OPENVPN_CIPHERS_REGEX.findall(value)
if len(sanitized_val) != 0:
_val = sanitized_val[0]
config[str(key)] = str(_val)
return config
def get_serial(self):
return self._safe_get_value("serial")
def get_version(self):
return self._safe_get_value("version")
def get_gateway_ip(self, index=0):
"""
Returns the ip of the gateway.
:rtype: An IPv4Address or IPv6Address object.
"""
gateways = self.get_gateways()
leap_assert(len(gateways) > 0, "We don't have any gateway!")
if index > len(gateways):
index = 0
logger.warning("Provided an unknown gateway index %s, " +
"defaulting to 0")
ip_addr_str = gateways[index]["ip_address"]
try:
ipaddr.IPAddress(ip_addr_str)
return ip_addr_str
except ValueError:
logger.error("Invalid ip address in config: %s" % (ip_addr_str,))
return None
def get_client_cert_path(self,
providerconfig=None,
about_to_download=False):
"""
Returns the path to the certificate used by openvpn
"""
leap_assert(providerconfig, "We need a provider")
leap_assert_type(providerconfig, ProviderConfig)
cert_path = os.path.join(self.get_path_prefix(),
"leap",
"providers",
providerconfig.get_domain(),
"keys",
"client",
"openvpn.pem")
if not about_to_download:
leap_assert(os.path.exists(cert_path),
"You need to download the certificate first")
logger.debug("Using OpenVPN cert %s" % (cert_path,))
return cert_path
if __name__ == "__main__":
logger = logging.getLogger(name='leap')
logger.setLevel(logging.DEBUG)
console = logging.StreamHandler()
console.setLevel(logging.DEBUG)
formatter = logging.Formatter(
'%(asctime)s '
'- %(name)s - %(levelname)s - %(message)s')
console.setFormatter(formatter)
logger.addHandler(console)
eipconfig = EIPConfig('1')
try:
eipconfig.get_clusters()
except Exception as e:
assert isinstance(e, AssertionError), "Expected an assert"
print "Safe value getting is working"
if eipconfig.load("leap/providers/bitmask.net/eip-service.json"):
print eipconfig.get_clusters()
print eipconfig.get_gateways()
print eipconfig.get_locations()
print eipconfig.get_openvpn_configuration()
print eipconfig.get_serial()
print eipconfig.get_version()
|
