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
|
# -*- 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 Tunnel.
"""
import os
import tempfile
from ._control import VPNControl
from ._config import _TempVPNConfig, _TempProviderConfig
from .constants import IS_WIN
# TODO refactor - this class is still a very light proxy around the
# underlying VPNControl. The main methods here are start/stop, so this
# looks like it could better use the Service interface.
# TODO gateway selection should be done in this class.
# TODO DO NOT pass VPNConfig/ProviderConfig beyond this class.
# TODO split sync/async vpn control mechanisms.
# TODO ConfiguredVPNConnection ?
class TunnelManager(object):
"""
A VPN Tunnel holds the configuration for a VPN connection, and allows to
control that connection.
"""
def __init__(self, provider, remotes, cert_path, key_path, ca_path,
extra_flags):
"""
: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
# TODO need gateways here
# sorting them doesn't belong in here
# gateways = ((ip1, portA), (ip2, portB), ...)
ports = []
self._remotes = remotes
self._vpnconfig = _TempVPNConfig(extra_flags, cert_path, ports)
self._providerconfig = _TempProviderConfig(provider, ca_path)
host, port = self._get_management_location()
self._vpncontrol = VPNControl(
remotes=remotes, vpnconfig=self._vpnconfig,
providerconfig=self._providerconfig,
socket_host=host, socket_port=port)
def start(self):
"""
Start the VPN process.
"""
result = self._vpncontrol.start()
return result
def stop(self):
"""
Bring openvpn down.
:returns: True if succeeded, False otherwise.
:rtype: bool
"""
# TODO how to return False if this fails
result = self._vpncontrol.stop(False, False) # TODO review params
return result
@property
def status(self):
return self._vpncontrol.status
@property
def traffic_status(self):
return self._vpncontrol.traffic_status
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
|
