Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions proton/vpn/backend/networkmanager/core/networkmanager.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ class LinuxNetworkManager(VPNConnection):
"""
SIGNAL_NAME = "vpn-state-changed"
backend = "linuxnetworkmanager"
# Whether to probe the OpenVPN TCP ports before starting the tunnel.
# Protocols using a different transport can disable it.
requires_openvpn_tcp_check = True

def __init__(self, *args, nm_client: NMClient = None, **kwargs):
self.__nm_client = nm_client
Expand All @@ -66,23 +69,21 @@ async def start(self):
"""
Starts a VPN connection using NetworkManager.
"""
# The VPN connection is started only if at least one of the TCP ports of the server to
# connect to is open. The reason for doing this check is that, after introducing the
# dummy kill switch network interface, the VPN connection backend tries to use it
# to establish the VPN connection.
# The VPN connection is started only if the server is reachable. Protocols
# that don't use the OpenVPN TCP ports can disable this check.
self._cancelled = False

server_reachable = await tcpcheck.is_any_port_reachable(
self._vpnserver.server_ip,
self._vpnserver.openvpn_ports.tcp
)

if not server_reachable:
logger.info("VPN server NOT reachable.")
self._notify_subscribers(events.Timeout(EventContext(connection=self)))
return
if self.requires_openvpn_tcp_check:
server_reachable = await tcpcheck.is_any_port_reachable(
self._vpnserver.server_ip,
self._vpnserver.openvpn_ports.tcp
)
if not server_reachable:
logger.info("VPN server NOT reachable.")
self._notify_subscribers(events.Timeout(EventContext(connection=self)))
return

logger.info("VPN server REACHABLE.")
logger.info("VPN server REACHABLE.")

if self._cancelled:
logger.info("Connection cancelled.")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ class Protun(LinuxNetworkManager, LocalAgentMixin):
SIGNAL_NAME: str = "vpn-state-changed"
VIRTUAL_DEVICE_NAME: str = "proton0"
PLUGIN_NAME: str = "protun"
requires_openvpn_tcp_check = False
connection: Optional[NM.SimpleConnection] = None
plugin_exists: Optional[bool] = None

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ class Wireguard(LinuxNetworkManager, LocalAgentMixin):
VIRTUAL_DEVICE_NAME: str = "proton0"
protocol: str = "wireguard"
ui_protocol: str = "WireGuard"
requires_openvpn_tcp_check = False
connection: Optional[NM.SimpleConnection] = None
FWMARK: int = FWMARK_VALUE

Expand Down
24 changes: 24 additions & 0 deletions tests/python/networkmanager/core/test_networkmanager.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,30 @@ async def test_start_generates_timeout_event_when_the_tcp_connection_check_fails
assert isinstance(generated_event, events.Timeout)


@pytest.mark.asyncio
@patch("proton.vpn.backend.networkmanager.core.networkmanager.tcpcheck")
async def test_start_skips_tcp_connection_check_when_disabled(
tcpcheck_patch, nm_client_mock
):
tcpcheck_patch.is_any_port_reachable = AsyncMock(return_value=False)

nm_protocol = create_nm_protocol(nm_client_mock)
nm_protocol.requires_openvpn_tcp_check = False

with patch.object(nm_protocol, "setup") as setup_mock:
start_connection_future = Future()
nm_client_mock.start_connection_async.return_value = start_connection_future
connection_mock = setup_mock.return_value.result()
start_connection_future.set_result(connection_mock)

await nm_protocol.start()

setup_mock.assert_called_once()

tcpcheck_patch.is_any_port_reachable.assert_not_called()
nm_client_mock.start_connection_async.assert_called_once_with(connection_mock)


@pytest.mark.asyncio
@patch("proton.vpn.backend.networkmanager.core.networkmanager.tcpcheck")
async def test_start_generates_tunnel_setup_failed_event_on_connection_setup_errors(
Expand Down