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
250
251
252
253
254
255
256
257
258
259
260
261
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_ASH_CROSAPI_VPN_SERVICE_ASH_H_
#define CHROME_BROWSER_ASH_CROSAPI_VPN_SERVICE_ASH_H_
#include <map>
#include <memory>
#include <string>
#include <vector>
#include "base/containers/flat_set.h"
#include "base/functional/callback_helpers.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "chrome/common/extensions/api/vpn_provider.h"
#include "chromeos/ash/components/dbus/shill/shill_third_party_vpn_observer.h"
#include "chromeos/ash/components/network/network_configuration_observer.h"
#include "chromeos/ash/components/network/network_state_handler_observer.h"
#include "chromeos/ash/components/network/vpn_providers_observer.h"
#include "chromeos/crosapi/mojom/vpn_service.mojom.h"
#include "extensions/common/extension_id.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "mojo/public/cpp/bindings/pending_remote.h"
#include "mojo/public/cpp/bindings/receiver_set.h"
#include "mojo/public/cpp/bindings/remote_set.h"
namespace ash {
class NetworkConfigurationHandler;
class NetworkStateHandler;
} // namespace ash
namespace base {
class Value;
} // namespace base
namespace chromeos {
// Fwd for friend declaration in VpnServiceAsh.
class VpnProviderApiTest;
} // namespace chromeos
namespace crosapi {
namespace api_vpn = extensions::api::vpn_provider;
class VpnServiceAsh;
// This class manages configurations for a particular extension.
class VpnServiceForExtensionAsh : public crosapi::mojom::VpnServiceForExtension,
public ash::NetworkConfigurationObserver {
public:
// Callback definitions.
using SuccessCallback = base::OnceClosure;
using FailureCallback =
base::OnceCallback<void(const std::string& error_name,
const std::string& error_message)>;
// Class forward declarations.
class VpnConfiguration;
public:
explicit VpnServiceForExtensionAsh(const std::string& extension_id);
~VpnServiceForExtensionAsh() override;
VpnServiceForExtensionAsh(const VpnServiceForExtensionAsh&) = delete;
VpnServiceForExtensionAsh& operator=(const VpnServiceForExtensionAsh&) =
delete;
void BindReceiverAndObserver(
mojo::PendingReceiver<crosapi::mojom::VpnServiceForExtension> receiver,
mojo::PendingRemote<crosapi::mojom::EventObserverForExtension> observer);
// crosapi::mojom::VpnServiceForExtension:
void CreateConfiguration(const std::string& configuration_name,
CreateConfigurationCallback) override;
void DestroyConfiguration(const std::string& configuration_name,
DestroyConfigurationCallback) override;
void SetParameters(base::Value::Dict parameters,
SetParametersCallback) override;
void SendPacket(const std::vector<uint8_t>& data,
SendPacketCallback) override;
void NotifyConnectionStateChanged(
bool connection_success,
NotifyConnectionStateChangedCallback) override;
void BindPepperVpnProxyObserver(
const std::string& configuration_name,
mojo::PendingRemote<crosapi::mojom::PepperVpnProxyObserver>
pepper_vpn_proxy_observer,
BindPepperVpnProxyObserverCallback) override;
// ash::NetworkConfigurationObserver:
void OnConfigurationRemoved(const std::string& service_path,
const std::string& guid) override;
bool OwnsActiveConfiguration() const;
bool HasConfigurationForServicePath(const std::string& service_path) const;
void DestroyAllConfigurations();
void CreateConfigurationWithServicePath(const std::string& configuration_name,
const std::string& service_path);
void DispatchConfigRemovedEvent(const std::string& configuration_name);
void DispatchOnPacketReceivedEvent(const std::vector<char>& data);
private:
friend class VpnConfigurationImpl;
friend class chromeos::VpnProviderApiTest;
friend class TestShillControllerAsh;
using StringToOwnedConfigurationMap =
std::map<std::string, std::unique_ptr<VpnConfiguration>>;
using StringToConfigurationMap =
std::map<std::string, raw_ptr<VpnConfiguration, CtnExperimental>>;
const extensions::ExtensionId& extension_id() const { return extension_id_; }
void DispatchOnPlatformMessageEvent(const std::string& configuration_name,
int32_t platform_message);
// Creates a key for |key_to_configuration_map_| as a hash of |extension_id|
// and |configuration_name|.
static std::string GetKey(const std::string& extension_id,
const std::string& configuration_name);
// Creates and adds the configuration to the internal store.
VpnConfiguration* CreateConfigurationInternal(
const std::string& configuration_name);
// Removes configuration from the internal store and destroys it.
void DestroyConfigurationInternal(VpnConfiguration*);
// Callback used to indicate that configuration was successfully created.
void OnCreateConfigurationSuccess(SuccessCallback,
VpnConfiguration*,
const std::string& service_path,
const std::string& guid);
// Callback used to indicate that configuration creation failed.
void OnCreateConfigurationFailure(FailureCallback,
VpnConfiguration*,
const std::string& error_name);
// Callback used to indicate that removing a configuration succeeded.
void OnRemoveConfigurationSuccess(SuccessCallback);
// Callback used to indicate that removing a configuration failed.
void OnRemoveConfigurationFailure(FailureCallback,
const std::string& error_name);
void SetActiveConfiguration(VpnConfiguration*);
const extensions::ExtensionId extension_id_;
// Owns all configurations. Key is a hash of |extension_id| and
// |configuration_name|.
StringToOwnedConfigurationMap key_to_configuration_map_;
// Maps shill service path to unowned configuration.
StringToConfigurationMap service_path_to_configuration_map_;
// Configuration that is currently in use.
raw_ptr<VpnConfiguration> active_configuration_ = nullptr;
base::ScopedObservation<ash::NetworkConfigurationHandler,
ash::NetworkConfigurationObserver>
network_configuration_observer_{this};
mojo::ReceiverSet<crosapi::mojom::VpnServiceForExtension> receivers_;
mojo::RemoteSet<crosapi::mojom::EventObserverForExtension> observers_;
base::WeakPtrFactory<VpnServiceForExtensionAsh> weak_factory_{this};
};
class VpnServiceAsh : public crosapi::mojom::VpnService,
public ash::NetworkStateHandlerObserver,
public ash::VpnProvidersObserver::Delegate {
public:
VpnServiceAsh();
~VpnServiceAsh() override;
VpnServiceAsh(const VpnServiceAsh&) = delete;
VpnServiceAsh& operator=(const VpnServiceAsh&) = delete;
// Binds |receiver| to this instance of VpnServiceAsh.
void BindReceiver(mojo::PendingReceiver<crosapi::mojom::VpnService> receiver);
// crosapi::mojom::VpnService:
void RegisterVpnServiceForExtension(
const std::string& extension_id,
mojo::PendingReceiver<crosapi::mojom::VpnServiceForExtension> receiver,
mojo::PendingRemote<crosapi::mojom::EventObserverForExtension> observer)
override;
void MaybeFailActiveConnectionAndDestroyConfigurations(
const std::string& extension_id,
bool destroy_configurations) override;
// ash::NetworkStateHandlerObserver:
void NetworkListChanged() override;
// ash::VpnProvidersObserver::Delegate:
void OnVpnExtensionsChanged(
base::flat_set<std::string> vpn_extensions) override;
private:
friend class chromeos::VpnProviderApiTest;
friend class VpnServiceForExtensionAsh;
// Callback for
// ash::NetworkConfigurationHandler::GetShillProperties(...); parses
// the |configuration_properties| dictionary and tries to add a new
// configuration provided that it belongs to some enabled extension.
void OnGetShillProperties(
const std::string& service_path,
std::optional<base::Value::Dict> configuration_properties);
// Always returns a valid pointer.
VpnServiceForExtensionAsh* GetVpnServiceForExtension(
const std::string& extension_id);
// Ids of enabled vpn extensions.
base::flat_set<std::string> vpn_extensions_;
base::ScopedObservation<ash::NetworkStateHandler,
ash::NetworkStateHandlerObserver>
network_state_handler_observer_{this};
// Supports any number of receivers.
mojo::ReceiverSet<crosapi::mojom::VpnService> receivers_;
// Maps |extension_id| to a dedicated service for that extension.
// We do not remove entries from this map due to various ash/lacros corner
// cases.
base::flat_map<std::string, std::unique_ptr<VpnServiceForExtensionAsh>>
extension_id_to_service_;
std::unique_ptr<ash::VpnProvidersObserver> vpn_providers_observer_;
base::WeakPtrFactory<VpnServiceAsh> weak_factory_{this};
};
class VpnServiceForExtensionAsh::VpnConfiguration
: public ash::ShillThirdPartyVpnObserver {
public:
virtual const std::string& configuration_name() const = 0;
virtual const std::string& key() const = 0;
virtual const std::string& object_path() const = 0;
virtual const std::optional<std::string>& service_path() const = 0;
virtual void set_service_path(std::string) = 0;
virtual void BindPepperVpnProxyObserver(
mojo::PendingRemote<crosapi::mojom::PepperVpnProxyObserver>) = 0;
};
} // namespace crosapi
#endif // CHROME_BROWSER_ASH_CROSAPI_VPN_SERVICE_ASH_H_
|
