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
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# service.py
# Copyright (C) 2015-2017 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/>.
"""
VPN service declaration.
"""
import os
from time import strftime
from twisted.internet import defer
from twisted.logger import Logger
from leap.bitmask.hooks import HookableService
from leap.bitmask.util import merge_status
from leap.bitmask.vpn.gateways import GatewaySelector
from leap.bitmask.vpn.fw.firewall import FirewallManager
from leap.bitmask.vpn.tunnel import TunnelManager
from leap.bitmask.vpn._checks import is_service_ready, get_vpn_cert_path
from leap.bitmask.vpn import privilege, helpers
from leap.bitmask.vpn.privilege import NoPolkitAuthAgentAvailable
from leap.common.config import get_path_prefix
from leap.common.files import check_and_fix_urw_only
from leap.common.certs import get_cert_time_boundaries
class ImproperlyConfigured(Exception):
"""This error is a transient exception until autoconf automates all the
needed steps for VPN bootstrap."""
expected = True
class VPNService(HookableService):
name = 'vpn'
_last_vpn_path = os.path.join('leap', 'last_vpn')
log = Logger()
def __init__(self, basepath=None):
"""
Initialize VPN service. This launches both the firewall and the vpn.
"""
super(VPNService, self).__init__()
self._tunnel = None
self._firewall = FirewallManager([])
self._domain = ''
if basepath is None:
self._basepath = get_path_prefix()
else:
self._basepath = basepath
if helpers.check() and self._firewall.is_up():
self._firewall.stop()
def startService(self):
# TODO this could trigger a check for validity of the certificates,
# etc.
super(VPNService, self).startService()
def stopService(self):
try:
self.stop_vpn()
except Exception as e:
self.log.error('Error stopping vpn service... {0!r}'.format(e))
super(VPNService, self).stopService()
@defer.inlineCallbacks
def start_vpn(self, domain=None):
if self.do_status()['status'] == 'on':
exc = Exception('VPN already started')
exc.expected = True
raise exc
if not domain:
domain = self._read_last()
if not domain:
exc = Exception("VPN can't start, a provider is needed")
exc.expected = True
raise exc
yield self._setup(domain)
try:
fw_ok = self._firewall.start()
if not fw_ok:
raise Exception('Could not start firewall')
vpn_ok = self._tunnel.start()
if not vpn_ok:
self._firewall.stop()
raise Exception('Could not start VPN')
# XXX capture it inside start method
# here I'd like to get (status, message)
except NoPolkitAuthAgentAvailable as e:
e.expected = True
raise e
# --------------------------------------
self._domain = domain
self._write_last(domain)
defer.returnValue({'result': 'started'})
def stop_vpn(self):
if self._firewall.is_up():
fw_ok = self._firewall.stop()
if not fw_ok:
self.log.error("Firewall: error stopping")
if not self._tunnel or self._tunnel.status['status'] is not 'on':
raise Exception('VPN was not running')
vpn_ok = self._tunnel.stop()
if not vpn_ok:
raise Exception("Error stopping VPN")
return {'result': 'vpn stopped'}
def do_status(self):
childrenStatus = {
'vpn': {'status': 'off', 'error': None},
'firewall': {'status': 'off', 'error': None},
}
if self._tunnel:
childrenStatus['vpn'] = self._tunnel.status
childrenStatus['firewall'] = self._firewall.status
status = merge_status(childrenStatus)
if self._domain:
status['domain'] = self._domain
else:
status['domain'] = self._read_last()
return status
def do_check(self, domain=None):
"""Check whether the VPN Service is properly configured,
and can be started"""
ret = {'installed': helpers.check()}
if domain:
ret['vpn_ready'] = is_service_ready(domain)
ret['cert_expires'] = self._cert_expires(domain)
return ret
@defer.inlineCallbacks
def do_get_cert(self, username):
try:
_, provider = username.split('@')
except ValueError:
if not username:
raise ValueError('Need an username. are you logged in?')
raise ValueError(username + ' is not a valid username, it should'
' contain an @')
# fetch vpn cert and store
bonafide = self.parent.getServiceNamed("bonafide")
_, cert_str = yield bonafide.do_get_vpn_cert(username)
cert_path = get_vpn_cert_path(provider)
cert_dir = os.path.dirname(cert_path)
if not os.path.exists(cert_dir):
os.makedirs(cert_dir, mode=0700)
with open(cert_path, 'w') as outf:
outf.write(cert_str)
check_and_fix_urw_only(cert_path)
defer.returnValue({'get_cert': 'ok'})
def do_install(self):
privilege.install_helpers()
return {'install': 'ok'}
def do_uninstall(self):
privilege.uninstall_helpers()
return {'uninstall': 'ok'}
@defer.inlineCallbacks
def _setup(self, provider):
"""Set up TunnelManager for a specified provider.
:param provider: the provider to use, e.g. 'demo.bitmask.net'
:type provider: str"""
bonafide = self.parent.getServiceNamed("bonafide")
config = yield bonafide.do_provider_read(provider, "eip")
sorted_gateways = GatewaySelector(
config.gateways, config.locations).select_gateways()
# TODO - add manual gateway selection ability.
extra_flags = config.openvpn_configuration
prefix = os.path.join(
self._basepath, "leap", "providers", provider, "keys")
cert_path = key_path = os.path.join(prefix, "client", "openvpn.pem")
ca_path = os.path.join(prefix, "ca", "cacert.pem")
if not os.path.isfile(cert_path):
raise ImproperlyConfigured(
'Cannot find client certificate. Please get one')
if not os.path.isfile(ca_path):
raise ImproperlyConfigured(
'Cannot find provider certificate. '
'Please configure provider.')
# TODO add remote ports, according to preferred sequence
remotes = tuple([(ip, '443') for ip in sorted_gateways])
self._tunnel = TunnelManager(
provider, remotes, cert_path, key_path, ca_path, extra_flags)
self._firewall = FirewallManager(remotes)
def _cert_expires(self, provider):
path = os.path.join(
self._basepath, "leap", "providers", provider,
"keys", "client", "openvpn.pem")
with open(path, 'r') as f:
cert = f.read()
_, to = get_cert_time_boundaries(cert)
return strftime('%Y-%m-%dT%H:%M:%SZ', to)
def _write_last(self, domain):
path = os.path.join(self._basepath, self._last_vpn_path)
with open(path, 'w') as f:
f.write(domain)
def _read_last(self):
path = os.path.join(self._basepath, self._last_vpn_path)
try:
with open(path, 'r') as f:
domain = f.read()
except IOError:
domain = None
return domain
|
