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
|
# -*- coding: utf-8 -*-
# manager.py
# Copyright (C) 2015 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 Manager
"""
import os
import tempfile
from ._control import VPNControl
from ._config import _TempEIPConfig, _TempProviderConfig
from .constants import IS_WIN
# TODO this is very badly named. There is another class that is called
# manager. This
class VPNManager(object):
def __init__(self, remotes, cert_path, key_path, ca_path, extra_flags,
mock_signaler):
"""
Initialize the VPNManager object.
:param remotes: a list of gateways tuple (ip, port) looking like this:
((ip1, portA), (ip2, portB), ...)
:type remotes: tuple of tuple(str, int)
"""
# TODO we can set all the needed ports, gateways and paths in here
ports = []
# this seems to be obsolete, needed to get gateways
domain = "demo.bitmask.net"
self._remotes = remotes
self._eipconfig = _TempEIPConfig(extra_flags, cert_path, ports)
self._providerconfig = _TempProviderConfig(domain, ca_path)
signaler = None # XXX handle signaling somehow...
self._vpn = VPNControl(remotes=remotes, signaler=signaler)
def start(self):
"""
Start the VPN process.
VPN needs:
* paths for: cert, key, ca
* gateway, port
* domain name
"""
host, port = self._get_management_location()
# TODO need gateways here
# sorting them doesn't belong in here
# gateways = ((ip1, portA), (ip2, portB), ...)
self._vpn.start(eipconfig=self._eipconfig,
providerconfig=self._providerconfig,
socket_host=host, socket_port=port)
return True
def stop(self):
"""
Bring openvpn down using the privileged wrapper.
:returns: True if succeeded, False otherwise.
:rtype: bool
"""
self._vpn.terminate(False, False) # TODO review params
# TODO how to return False if this fails
return True
def is_up(self):
"""
Return whether the VPN is up or not.
:rtype: bool
"""
pass
def kill(self):
"""
Sends a kill signal to the openvpn process.
"""
pass
# self._vpn.killit()
def terminate(self):
"""
Stop the openvpn subprocess.
Attempts to send a SIGTERM first, and after a timeout it sends a
SIGKILL.
"""
pass
def _get_management_location(self):
"""
Return a tuple with the host (socket) and port to be used for VPN.
:return: (host, port)
:rtype: tuple (str, str)
"""
if IS_WIN:
host = "localhost"
port = "9876"
else:
# XXX cleanup this on exit too
# XXX atexit.register ?
host = os.path.join(tempfile.mkdtemp(prefix="leap-tmp"),
'openvpn.socket')
port = "unix"
return host, port
|
