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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
# -*- coding: utf-8 -*-
# process.py
# Copyright (C) 2013-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 Process management.
A custom processProtocol launches the VPNProcess and connects to its management
interface.
"""
import sys
from twisted.internet import protocol, reactor
from twisted.internet import error as internet_error
from twisted.logger import Logger
from leap.bitmask.vpn.utils import get_vpn_launcher
from leap.bitmask.vpn import _status
from leap.bitmask.vpn import _management
from leap.bitmask.vpn.launchers import darwin
# OpenVPN verbosity level - from flags.py
OPENVPN_VERBOSITY = 1
class VPNProcess(protocol.ProcessProtocol, _management.VPNManagement):
"""
A ProcessProtocol class that can be used to spawn a process that will
launch openvpn and connect to its management interface to control it
programmatically.
"""
log = Logger()
# TODO do we really need the vpnconfig/providerconfig objects in here???
def __init__(self, vpnconfig, providerconfig, socket_host, socket_port,
openvpn_verb, remotes, restartfun=None):
"""
:param vpnconfig: vpn configuration object
:type vpnconfig: VPNConfig
:param providerconfig: provider specific configuration
:type providerconfig: ProviderConfig
:param socket_host: either socket path (unix) or socket IP
:type socket_host: str
:param socket_port: either string "unix" if it's a unix
socket, or port otherwise
:type socket_port: str
:param openvpn_verb: the desired level of verbosity in the
openvpn invocation
:type openvpn_verb: int
"""
_management.VPNManagement.__init__(self)
self._vpnconfig = vpnconfig
self._providerconfig = providerconfig
self._socket_host = socket_host
self._socket_port = socket_port
self._launcher = get_vpn_launcher()
self._last_state = None
self._last_status = None
self._alive = False
# XXX use flags, maybe, instead of passing
# the parameter around.
self._openvpn_verb = openvpn_verb
self._restartfun = restartfun
self._status = _status.VPNStatus()
self.restarting = False
self._remotes = remotes
@property
def status(self):
return self._status.status
@property
def traffic_status(self):
return self._status.get_traffic_status()
# processProtocol methods
def connectionMade(self):
"""
Called when the connection is made.
.. seeAlso: `http://twistedmatrix.com/documents/13.0.0/api/twisted.internet.protocol.ProcessProtocol.html` # noqa
"""
self._alive = True
self.aborted = False
self.try_to_connect_to_management(max_retries=10)
def outReceived(self, data):
"""
Called when new data is available on stdout.
:param data: the data read on stdout
.. seeAlso: `http://twistedmatrix.com/documents/13.0.0/api/twisted.internet.protocol.ProcessProtocol.html` # noqa
"""
# truncate the newline
line = data[:-1]
if 'SIGTERM[soft,ping-restart]' in line:
self.restarting = True
self.log.info(line)
self._status.watch(line)
def processExited(self, failure):
"""
Called when the child process exits.
.. seeAlso: `http://twistedmatrix.com/documents/13.0.0/api/twisted.internet.protocol.ProcessProtocol.html` # noqa
"""
err = failure.trap(
internet_error.ProcessDone, internet_error.ProcessTerminated)
if err == internet_error.ProcessDone:
status, errmsg = 'off', None
elif err == internet_error.ProcessTerminated:
status, errmsg = 'failure', failure.value.exitCode
if errmsg:
self.log.debug('processExited, status %d' % (errmsg,))
else:
self.log.warn('%r' % failure.value)
self._status.set_status(status, errmsg)
self._alive = False
def processEnded(self, reason):
"""
Called when the child process exits and all file descriptors associated
with it have been closed.
.. seeAlso: `http://twistedmatrix.com/documents/13.0.0/api/twisted.internet.protocol.ProcessProtocol.html` # noqa
"""
exit_code = reason.value.exitCode
if isinstance(exit_code, int):
self.log.debug('processEnded, status %d' % (exit_code,))
if self.restarting:
self.log.debug('Restarting VPN process')
reactor.callLater(2, self._restartfun)
# polling
def pollStatus(self):
"""
Polls connection status.
"""
if self._alive:
self.get_status()
def pollState(self):
"""
Polls connection state.
"""
if self._alive:
self.get_state()
# launcher
def getCommand(self):
"""
Gets the vpn command from the aproppriate launcher.
Might throw:
VPNLauncherException,
OpenVPNNotFoundException.
:rtype: list of str
"""
command = self._launcher.get_vpn_command(
vpnconfig=self._vpnconfig,
providerconfig=self._providerconfig,
socket_host=self._socket_host,
socket_port=self._socket_port,
openvpn_verb=self._openvpn_verb,
remotes=self._remotes)
encoding = sys.getfilesystemencoding()
for i, c in enumerate(command):
if not isinstance(c, str):
command[i] = c.encode(encoding)
self.log.debug("Running VPN with command: ")
self.log.debug("{0}".format(" ".join(command)))
return command
def getGateways(self):
"""
Get the gateways from the appropiate launcher.
:rtype: list
"""
gateways_ports = self._launcher.get_gateways(
self._vpnconfig, self._providerconfig)
# filter out ports since we don't need that info
return [gateway for gateway, port in gateways_ports]
# shutdown
def killProcess(self):
"""
Sends the KILL signal to the running process.
"""
try:
self.transport.signalProcess('KILL')
except internet_error.ProcessExitedAlready:
self.log.debug('Process Exited Already')
class VPNCanary(VPNProcess):
"""
Special form of the VPNProcess, for Darwin Launcher (windows might use same
strategy).
This is a Canary Process that does not run openvpn itself, but it's
notified by the privileged process when the process dies.
This is a workaround to allow the state machine to be notified when openvpn
process is spawned by the privileged helper.
"""
def setupHelper(self):
self.helper = darwin.HelperCommand()
def connectionMade(self):
VPNProcess.connectionMade(self)
reactor.callLater(2, self.registerPID)
def registerPID(self):
cmd = 'openvpn_set_watcher %s' % self.pid
self.helper.send(cmd)
def killProcess(self):
cmd = 'openvpn_force_stop'
self.helper.send(cmd)
def getVPNCommand(self):
return VPNProcess.getCommand(self)
def getCommand(self):
canary = '''import sys, signal, time
def receive_signal(signum, stack):
sys.exit()
signal.signal(signal.SIGTERM, receive_signal)
while True:
time.sleep(60)'''
return ['python', '-c', '%s' % canary]
|
