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
|
"""
Copyright (c) 2023 Proton AG
This file is part of Proton VPN.
Proton VPN 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.
Proton VPN 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 ProtonVPN. If not, see <https://www.gnu.org/licenses/>.
"""
import os
from unittest.mock import Mock, patch
import pytest
from proton.vpn.connection import VPNConnection, states
from proton.vpn.connection.persistence import ConnectionPersistence, ConnectionParameters
from proton.vpn.connection.states import StateContext
from proton.vpn.connection.interfaces import VPNServer, ProtocolPorts
from .common import MockVpnCredentials
@pytest.fixture
def settings():
return Mock()
@pytest.fixture
def vpn_credentials():
return MockVpnCredentials()
@pytest.fixture
def vpn_server():
return VPNServer(
server_ip="10.10.1.1",
domain="com.test-domain.www",
x25519pk="wg_public_key",
openvpn_ports=ProtocolPorts(tcp=[80, 1194], udp=[445, 5995]),
wireguard_ports=ProtocolPorts(tcp=[443, 88], udp=[445]),
server_name="TestServer#10",
server_id="OYB-3pMQQA2Z2Qnp5s5nIvTVO2...lRjxhx9DCAUM9uXfM2ZUFjzPXw==",
has_ipv6_support=False,
label="0"
)
@pytest.fixture
def connection_persistence_mock():
return Mock(ConnectionPersistence)
class DummyVPNConnection(VPNConnection):
"""Dummy VPN connection implementing all the required abstract methods."""
backend = "dummy"
protocol = "protocol"
def __init__(self, *args, connection_persistence = None, **kwargs):
self.initialize_persisted_connection_mock = Mock(return_value=states.Connected(StateContext(connection=self)))
# Make sure we don't trigger connection persistence.
connection_persistence = connection_persistence or Mock()
super().__init__(*args, connection_persistence=connection_persistence, **kwargs)
def _initialize_persisted_connection(
self, persisted_parameters: ConnectionParameters
) -> states.State:
return self.initialize_persisted_connection_mock(persisted_parameters)
def start(self):
pass
def stop(self):
pass
def refresh_certificate(self):
pass
def _get_connection(self):
return None
def _validate(cls) -> bool:
return True
def _get_priority(cls) -> int:
return 100
class InvalidVPNConnection(VPNConnection):
"""VPN connection class missing abstract method implementations."""
backend = "invalid"
protocol = "protocol"
def test_vpn_connection_subclass_raises_type_exception_if_abstract_methods_were_not_implemented():
with pytest.raises(TypeError, match="Can't instantiate abstract class"):
InvalidVPNConnection(server=None, credentials=None)
def test_vpn_connection_initialized_without_a_persisted_connection():
"""
When a VPNConnection object is created without passing persisted parameters
then it should be initialized without a unique id and with the Disconnected
initial state.
"""
vpnconn = DummyVPNConnection(
server=None,
credentials=None,
settings=None,
connection_id=None
)
assert vpnconn._unique_id is None
vpnconn.initialize_persisted_connection_mock.assert_not_called()
assert isinstance(vpnconn.initial_state, states.Disconnected)
@pytest.mark.asyncio
async def test_add_persistence(vpn_server, vpn_credentials, settings, connection_persistence_mock):
vpnconn = DummyVPNConnection(
vpn_server,
vpn_credentials,
settings=settings,
connection_persistence=connection_persistence_mock,
)
vpnconn._unique_id = "add-persistence"
await vpnconn.add_persistence()
connection_persistence_mock.save.assert_called_once()
persistence_params = connection_persistence_mock.save.call_args.args[0]
assert persistence_params.connection_id == "add-persistence"
assert persistence_params.backend == vpnconn.backend
assert persistence_params.protocol == vpnconn.protocol
assert persistence_params.server == vpn_server
@pytest.mark.asyncio
async def test_remove_persistence(vpn_server, vpn_credentials, settings, connection_persistence_mock):
vpnconn = DummyVPNConnection(
vpn_server,
vpn_credentials,
settings,
connection_persistence=connection_persistence_mock
)
vpnconn._unique_id = "remove-persistence"
await vpnconn.remove_persistence()
connection_persistence_mock.remove.assert_called()
def test_register_subscriber_delegates_to_publisher():
publisher_mock = Mock()
vpnconn = DummyVPNConnection(
server=None, credentials=None, settings=None, publisher=publisher_mock
)
def subscriber(event):
pass
vpnconn.register(subscriber)
publisher_mock.register.assert_called_with(subscriber)
def test_unregister_subscriber_delegates_to_publisher():
publisher_mock = Mock()
vpnconn = DummyVPNConnection(
server=None, credentials=None, settings=None, publisher=publisher_mock
)
def subscriber(event):
pass
vpnconn.unregister(subscriber)
publisher_mock.unregister.assert_called_with(subscriber)
def test_get_user_pass(vpn_server, vpn_credentials, settings):
vpnconn = DummyVPNConnection(vpn_server, vpn_credentials, settings)
u, p = vpn_credentials.userpass_credentials.username, vpn_credentials.userpass_credentials.password
user, password = vpnconn._get_user_pass()
assert u == user and p == password
def test_get_user_with_default_feature_flags(vpn_server, vpn_credentials, settings):
vpnconn = DummyVPNConnection(vpn_server, vpn_credentials, settings)
u = vpn_credentials.userpass_credentials.username
user, _ = vpnconn._get_user_pass(True)
_u = "+".join([u] + vpnconn._get_feature_flags())
assert user == _u
@pytest.mark.parametrize(
"ns, accel, pf, rn, sf",
[
("f1", False, True, False, True),
("f2", False, True, False, True),
("f3", False, True, False, True),
("f1", True, False, True, False),
("f2", True, False, True, False),
("f3", True, False, True, False),
]
)
def test_get_user_with_features(vpn_server, vpn_credentials, ns, accel, pf, rn, sf):
from proton.vpn.connection.interfaces import Features
class MockFeatures(Features):
@property
def netshield(self):
return ns
@property
def vpn_accelerator(self):
return accel
@property
def port_forwarding(self):
return pf
@property
def moderate_nat(self):
return rn
@property
def safe_mode(self):
return sf
settings = Mock()
settings.features = MockFeatures()
vpnconn = DummyVPNConnection(vpn_server, vpn_credentials, settings)
u = vpn_credentials.userpass_credentials.username
user, _ = vpnconn._get_user_pass(True)
_u = "+".join([u] + vpnconn._get_feature_flags())
assert user == _u
|