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
|
"""
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/>.
"""
from __future__ import annotations
from typing import TYPE_CHECKING
from pathlib import Path
import random
import time
from proton.utils.environment import VPNExecutionEnvironment
from proton.vpn.core.cache_handler import CacheHandler
from proton.vpn.session.exceptions import ClientConfigDecodeError
from proton.vpn.session.utils import rest_api_request
from proton.vpn.session.dataclasses.client_config import ProtocolPorts
if TYPE_CHECKING:
from proton.vpn.session import VPNSession
DEFAULT_CLIENT_CONFIG = {
"DefaultPorts": {
"OpenVPN": {
"UDP": [80, 51820, 4569, 1194, 5060],
"TCP": [443, 7770, 8443]
},
"WireGuard": {
"UDP": [443, 88, 1224, 51820, 500, 4500],
"TCP": [443],
}
},
"HolesIPs": ["62.112.9.168", "104.245.144.186"],
"ServerRefreshInterval": 10,
"FeatureFlags": {
"NetShield": True,
"GuestHoles": False,
"ServerRefresh": True,
"StreamingServicesLogos": True,
"PortForwarding": True,
"ModerateNAT": True,
"SafeMode": False,
"StartConnectOnBoot": True,
"PollNotificationAPI": True,
"VpnAccelerator": True,
"SmartReconnect": True,
"PromoCode": False,
"WireGuardTls": True,
"Telemetry": True,
"NetShieldStats": True
},
"SmartProtocol": {
"OpenVPN": True,
"IKEv2": True,
"WireGuard": True,
"WireGuardTCP": True,
"WireGuardTLS": True
},
"RatingSettings": {
"EligiblePlans": [],
"SuccessConnections": 3,
"DaysLastReviewPassed": 100,
"DaysConnected": 3,
"DaysFromFirstConnection": 14
}
}
class ClientConfig:
"""
General configuration used to connect to VPN servers.
"""
REFRESH_INTERVAL = 3 * 60 * 60 # 3 hours
REFRESH_RANDOMNESS = 0.22 # +/- 22%
def __init__(
self, openvpn_ports, wireguard_ports, holes_ips,
server_refresh_interval,
expiration_time
): # pylint: disable=R0913
self.openvpn_ports = openvpn_ports
self.wireguard_ports = wireguard_ports
self.holes_ips = holes_ips
self.server_refresh_interval = server_refresh_interval
self.expiration_time = expiration_time
@classmethod
def from_dict(cls, apidata: dict) -> ClientConfig:
"""Creates ClientConfig object from data."""
try:
openvpn_ports = apidata["DefaultPorts"]["OpenVPN"]
wireguard_ports = apidata["DefaultPorts"]["WireGuard"]
holes_ips = apidata["HolesIPs"]
server_refresh_interval = apidata["ServerRefreshInterval"]
expiration_time = float(apidata.get("ExpirationTime", cls.get_expiration_time()))
return ClientConfig(
# No need to copy openvpn_ports, OpenVPNPorts takes care of it.
ProtocolPorts.from_dict(openvpn_ports),
# No need to copy wireguard_ports, WireGuardPorts takes care of it.
ProtocolPorts.from_dict(wireguard_ports),
# We copy the holes_ips list to avoid side effects if it's modified.
holes_ips.copy(),
server_refresh_interval,
expiration_time
)
except (KeyError, ValueError) as error:
raise ClientConfigDecodeError(
"Error parsing client configuration."
) from error
@staticmethod
def default() -> ClientConfig:
"""":returns: the default client configuration."""
return ClientConfig.from_dict(DEFAULT_CLIENT_CONFIG)
@property
def is_expired(self) -> bool:
"""Returns if data has expired"""
current_time = time.time()
return current_time > self.expiration_time
@property
def seconds_until_expiration(self) -> float:
"""
Amount of seconds left until the client configuration is considered
outdated and should be fetched again from the REST API.
"""
seconds_left = self.expiration_time - time.time()
return seconds_left if seconds_left > 0 else 0
@classmethod
def _generate_random_component(cls):
# 1 +/- 0.22*random # nosec B311
return 1 + cls.REFRESH_RANDOMNESS * (2 * random.random() - 1) # nosec B311 # noqa: E501 # pylint: disable=line-too-long # nosemgrep: gitlab.bandit.B311
@classmethod
def get_refresh_interval_in_seconds(cls): # pylint: disable=missing-function-docstring
return cls.REFRESH_INTERVAL * cls._generate_random_component()
@classmethod
def get_expiration_time(cls, start_time: int = None): # noqa: E501 pylint: disable=missing-function-docstring
start_time = start_time if start_time is not None else time.time()
return start_time + cls.get_refresh_interval_in_seconds()
class ClientConfigFetcher:
"""
Fetches and caches the client configuration from Proton's REST API.
"""
ROUTE = "/vpn/v2/clientconfig"
CACHE_PATH = Path(VPNExecutionEnvironment().path_cache) / "clientconfig.json"
def __init__(self, session: "VPNSession"):
"""
:param session: session used to retrieve the client configuration.
"""
self._session = session
self._client_config = None
self._cache_file = CacheHandler(self.CACHE_PATH)
def clear_cache(self):
"""Discards the cache, if existing."""
self._client_config = None
self._cache_file.remove()
async def fetch(self) -> ClientConfig:
"""
Fetches the client configuration from the REST API.
:returns: the fetched client configuration.
"""
response = await rest_api_request(
self._session,
self.ROUTE,
)
response["ExpirationTime"] = ClientConfig.get_expiration_time()
self._cache_file.save(response)
self._client_config = ClientConfig.from_dict(response)
return self._client_config
def load_from_cache(self) -> ClientConfig:
"""
Loads the client configuration from persistence.
:returns: the persisted client configuration. If no persistence
was found then the default client configuration is returned.
"""
cache = self._cache_file.load()
self._client_config = ClientConfig.from_dict(cache) if cache else ClientConfig.default()
return self._client_config
|
