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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
content / browser / usb / web_usb_service_impl.cc [blame]
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/usb/web_usb_service_impl.h"
#include <memory>
#include <utility>
#include <vector>
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "content/browser/renderer_host/render_frame_host_impl.h"
#include "content/browser/service_worker/service_worker_usb_delegate_observer.h"
#include "content/browser/service_worker/service_worker_version.h"
#include "content/browser/web_contents/web_contents_impl.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/content_browser_client.h"
#include "content/public/browser/document_service.h"
#include "content/public/browser/isolated_context_util.h"
#include "content/public/common/content_client.h"
#include "mojo/public/cpp/bindings/associated_remote.h"
#include "services/device/public/mojom/usb_device.mojom.h"
#include "services/device/public/mojom/usb_enumeration_options.mojom.h"
#include "services/device/public/mojom/usb_manager_client.mojom.h"
#include "third_party/blink/public/common/features_generated.h"
namespace content {
namespace {
// Deletes the WebUsbService when the connected document is destroyed.
class DocumentHelper : public DocumentService<blink::mojom::WebUsbService> {
public:
DocumentHelper(std::unique_ptr<WebUsbServiceImpl> service,
RenderFrameHostImpl& render_frame_host,
mojo::PendingReceiver<blink::mojom::WebUsbService> receiver)
: DocumentService(render_frame_host, std::move(receiver)),
service_(std::move(service)) {
DCHECK(service_);
}
DocumentHelper(const DocumentHelper&) = delete;
DocumentHelper& operator=(const DocumentHelper&) = delete;
~DocumentHelper() override = default;
// blink::mojom::WebUsbService:
void GetDevices(GetDevicesCallback callback) override {
service_->GetDevices(std::move(callback));
}
void GetDevice(const std::string& guid,
mojo::PendingReceiver<device::mojom::UsbDevice>
device_receiver) override {
service_->GetDevice(guid, std::move(device_receiver));
}
void GetPermission(
blink::mojom::WebUsbRequestDeviceOptionsPtr options,
blink::mojom::WebUsbService::GetPermissionCallback callback) override {
service_->GetPermission(std::move(options), std::move(callback));
}
void ForgetDevice(
const std::string& guid,
blink::mojom::WebUsbService::ForgetDeviceCallback callback) override {
service_->ForgetDevice(guid, std::move(callback));
}
void SetClient(
mojo::PendingAssociatedRemote<device::mojom::UsbDeviceManagerClient>
client) override {
service_->SetClient(std::move(client));
}
private:
const std::unique_ptr<WebUsbServiceImpl> service_;
};
} // namespace
// A UsbDeviceClient represents a UsbDevice pipe that has been passed to the
// renderer process. The UsbDeviceClient pipe allows the browser process to
// continue to monitor how the device is used and cause the connection to be
// closed at will.
class WebUsbServiceImpl::UsbDeviceClient
: public device::mojom::UsbDeviceClient {
public:
UsbDeviceClient(
WebUsbServiceImpl* service,
const std::string& device_guid,
mojo::PendingReceiver<device::mojom::UsbDeviceClient> receiver)
: service_(service),
device_guid_(device_guid),
receiver_(this, std::move(receiver)) {
receiver_.set_disconnect_handler(
base::BindOnce(&WebUsbServiceImpl::RemoveDeviceClient,
base::Unretained(service_), base::Unretained(this)));
}
UsbDeviceClient(const UsbDeviceClient&) = delete;
UsbDeviceClient& operator=(const UsbDeviceClient&) = delete;
~UsbDeviceClient() override {
if (opened_) {
// If the connection was opened destroying |receiver_| will cause it to
// be closed but that event won't be dispatched here because the receiver
// has been destroyed.
OnDeviceClosed();
}
}
const std::string& device_guid() const { return device_guid_; }
// device::mojom::UsbDeviceClient implementation:
void OnDeviceOpened() override {
DCHECK(!opened_);
opened_ = true;
service_->IncrementConnectionCount();
}
void OnDeviceClosed() override {
DCHECK(opened_);
opened_ = false;
service_->DecrementConnectionCount();
}
private:
const raw_ptr<WebUsbServiceImpl> service_;
const std::string device_guid_;
bool opened_ = false;
mojo::Receiver<device::mojom::UsbDeviceClient> receiver_;
};
WebUsbServiceImpl::WebUsbServiceImpl(
RenderFrameHostImpl* render_frame_host,
base::WeakPtr<ServiceWorkerVersion> service_worker_version,
const url::Origin& origin)
: render_frame_host_(render_frame_host),
service_worker_version_(std::move(service_worker_version)),
origin_(origin) {
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (delegate && render_frame_host_) {
delegate->AddObserver(GetBrowserContext(), this);
} else if (service_worker_version_) {
#if !BUILDFLAG(IS_ANDROID)
// For service worker case, it relies on ServiceWorkerUsbDelegateObserver to
// be the broker between UsbDelegate and UsbService.
auto context = service_worker_version_->context();
if (context) {
context->usb_delegate_observer()->RegisterUsbService(
service_worker_version_->registration_id(),
weak_factory_.GetWeakPtr());
}
#else
NOTREACHED();
#endif // !BUILDFLAG(IS_ANDROID)
}
}
WebUsbServiceImpl::~WebUsbServiceImpl() {
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (delegate && render_frame_host_) {
delegate->RemoveObserver(GetBrowserContext(), this);
}
}
// static
void WebUsbServiceImpl::Create(
RenderFrameHostImpl& render_frame_host,
mojo::PendingReceiver<blink::mojom::WebUsbService> pending_receiver) {
if (!render_frame_host.IsFeatureEnabled(
blink::mojom::PermissionsPolicyFeature::kUsb)) {
mojo::ReportBadMessage("Permissions policy blocks access to USB.");
return;
}
// Avoid creating the WebUsbService if there is no USB delegate to provide the
// implementation.
UsbDelegate* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (!delegate) {
return;
}
if (render_frame_host.IsNestedWithinFencedFrame()) {
// The renderer is supposed to disallow the use of USB services when inside
// a fenced frame. Anything getting past the renderer checks must be marked
// as a bad request.
mojo::ReportBadMessage("WebUSB is not allowed in a fenced frame tree.");
return;
}
if (!delegate->PageMayUseUsb(render_frame_host.GetPage())) {
return;
}
// DocumentHelper observes the lifetime of the document connected to
// `render_frame_host` and destroys the WebUsbService when the Mojo connection
// is disconnected, RenderFrameHost is deleted, or the RenderFrameHost commits
// a cross-document navigation. It forwards its Mojo interface to
// WebUsbServiceImpl.
new DocumentHelper(
std::make_unique<WebUsbServiceImpl>(
&render_frame_host,
/*service_worker_version=*/nullptr,
render_frame_host.GetMainFrame()->GetLastCommittedOrigin()),
render_frame_host, std::move(pending_receiver));
}
// static
void WebUsbServiceImpl::Create(
base::WeakPtr<ServiceWorkerVersion> service_worker_version,
const url::Origin& origin,
mojo::PendingReceiver<blink::mojom::WebUsbService> pending_receiver) {
DCHECK(service_worker_version);
// Avoid creating the WebUsbService if there is no USB delegate to provide
// the implementation or if `origin` is not eligible to access WebUSB from a
// service worker.
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (!delegate || !delegate->IsServiceWorkerAllowedForOrigin(origin)) {
return;
}
// This makes the WebUsbService a self-owned receiver so it will self-destruct
// when a mojo interface error occurs.
mojo::MakeSelfOwnedReceiver(std::make_unique<WebUsbServiceImpl>(
/*render_frame_host=*/nullptr,
std::move(service_worker_version), origin),
std::move(pending_receiver));
}
BrowserContext* WebUsbServiceImpl::GetBrowserContext() const {
if (render_frame_host_) {
return render_frame_host_->GetBrowserContext();
}
if (service_worker_version_ && service_worker_version_->context()) {
return service_worker_version_->context()->wrapper()->browser_context();
}
return nullptr;
}
std::vector<uint8_t> WebUsbServiceImpl::GetProtectedInterfaceClasses() const {
// Specified in https://wicg.github.io/webusb#protected-interface-classes
std::vector<uint8_t> classes = {
device::mojom::kUsbAudioClass, device::mojom::kUsbHidClass,
device::mojom::kUsbMassStorageClass, device::mojom::kUsbSmartCardClass,
device::mojom::kUsbVideoClass, device::mojom::kUsbAudioVideoClass,
device::mojom::kUsbWirelessClass,
};
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (delegate) {
delegate->AdjustProtectedInterfaceClasses(GetBrowserContext(), origin_,
render_frame_host_, classes);
}
// If the 'kUnrestrictedUsb' feature is enabled and the isolated context has
// 'kUsbUnrestricted' permission, grant access to all USB interface classes.
bool is_usb_unrestricted = false;
if (base::FeatureList::IsEnabled(blink::features::kUnrestrictedUsb)) {
is_usb_unrestricted =
render_frame_host_ &&
render_frame_host_->IsFeatureEnabled(
blink::mojom::PermissionsPolicyFeature::kUsbUnrestricted) &&
HasIsolatedContextCapability(render_frame_host_);
}
if (is_usb_unrestricted) {
classes.clear();
}
return classes;
}
void WebUsbServiceImpl::GetDevices(GetDevicesCallback callback) {
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (!delegate) {
std::move(callback).Run(std::vector<device::mojom::UsbDeviceInfoPtr>());
return;
}
delegate->GetDevices(
GetBrowserContext(),
base::BindOnce(&WebUsbServiceImpl::OnGetDevices,
weak_factory_.GetWeakPtr(), std::move(callback)));
}
void WebUsbServiceImpl::OnGetDevices(
GetDevicesCallback callback,
std::vector<device::mojom::UsbDeviceInfoPtr> device_info_list) {
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
DCHECK(delegate);
std::vector<device::mojom::UsbDeviceInfoPtr> device_infos;
for (auto& device_info : device_info_list) {
if (delegate->HasDevicePermission(GetBrowserContext(), render_frame_host_,
origin_, *device_info)) {
device_infos.push_back(device_info.Clone());
}
}
std::move(callback).Run(std::move(device_infos));
}
void WebUsbServiceImpl::GetDevice(
const std::string& guid,
mojo::PendingReceiver<device::mojom::UsbDevice> device_receiver) {
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (!delegate) {
return;
}
auto* browser_context = GetBrowserContext();
auto* device_info = delegate->GetDeviceInfo(browser_context, guid);
if (!device_info ||
!delegate->HasDevicePermission(browser_context, render_frame_host_,
origin_, *device_info)) {
return;
}
// Connect Blink to the native device and keep a receiver to this for the
// UsbDeviceClient interface so we can receive DeviceOpened/Closed events.
// This receiver will also be closed to notify the device service to close
// the connection if permission is revoked.
mojo::PendingRemote<device::mojom::UsbDeviceClient> device_client;
device_clients_.push_back(std::make_unique<UsbDeviceClient>(
this, guid, device_client.InitWithNewPipeAndPassReceiver()));
delegate->GetDevice(GetBrowserContext(), guid, GetProtectedInterfaceClasses(),
std::move(device_receiver), std::move(device_client));
}
void WebUsbServiceImpl::GetPermission(
blink::mojom::WebUsbRequestDeviceOptionsPtr options,
GetPermissionCallback callback) {
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (!delegate ||
!delegate->CanRequestDevicePermission(GetBrowserContext(), origin_)) {
std::move(callback).Run(nullptr);
return;
}
usb_chooser_ = delegate->RunChooser(*render_frame_host_, std::move(options),
std::move(callback));
}
void WebUsbServiceImpl::ForgetDevice(const std::string& guid,
ForgetDeviceCallback callback) {
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (delegate) {
auto* browser_context = GetBrowserContext();
auto* device_info = delegate->GetDeviceInfo(browser_context, guid);
if (device_info &&
delegate->HasDevicePermission(browser_context, render_frame_host_,
origin_, *device_info)) {
delegate->RevokeDevicePermissionWebInitiated(browser_context, origin_,
*device_info);
}
}
std::move(callback).Run();
}
void WebUsbServiceImpl::SetClient(
mojo::PendingAssociatedRemote<device::mojom::UsbDeviceManagerClient>
client) {
DCHECK(client);
clients_.Add(std::move(client));
#if !BUILDFLAG(IS_ANDROID)
if (service_worker_version_ && service_worker_version_->context()) {
// WebUsbService is expected to have only one DeviceManagerClient when it is
// for a service worker. One renderer side of a service worker has its own
// associated WebUsbService.
CHECK_EQ(1u, clients_.size());
// When a service worker is woken up by a device connection event, the
// client might not have yet registered with the WebUsbService or the
// WebUsbService hasn't been created yet when service worker is in running
// state. This is because service worker is set to running state after
// script evaluation but inter-processes request triggered from the script
// evaluation that creates WebUsbService or registers a client might not be
// done in the browser process. To handle this situation, pending callbacks
// are stored and to be processed when registering the client.
service_worker_version_->context()
->usb_delegate_observer()
->ProcessPendingCallbacks(service_worker_version_.get());
}
#endif // !BUILDFLAG(IS_ANDROID)
}
void WebUsbServiceImpl::OnPermissionRevoked(const url::Origin& origin) {
if (origin_ != origin) {
return;
}
// Close the connection between Blink and the device if the device lost
// permission.
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
auto* browser_context = GetBrowserContext();
std::erase_if(device_clients_, [=, this](const auto& client) {
auto* device_info =
delegate->GetDeviceInfo(browser_context, client->device_guid());
if (!device_info)
return true;
return !delegate->HasDevicePermission(browser_context, render_frame_host_,
origin_, *device_info);
});
}
void WebUsbServiceImpl::OnDeviceAdded(
const device::mojom::UsbDeviceInfo& device_info) {
if (!GetContentClient()->browser()->GetUsbDelegate()->HasDevicePermission(
GetBrowserContext(), render_frame_host_, origin_, device_info)) {
return;
}
for (auto& client : clients_)
client->OnDeviceAdded(device_info.Clone());
}
void WebUsbServiceImpl::OnDeviceRemoved(
const device::mojom::UsbDeviceInfo& device_info) {
std::erase_if(device_clients_, [&device_info](const auto& client) {
return device_info.guid == client->device_guid();
});
if (!GetContentClient()->browser()->GetUsbDelegate()->HasDevicePermission(
GetBrowserContext(), render_frame_host_, origin_, device_info)) {
return;
}
for (auto& client : clients_)
client->OnDeviceRemoved(device_info.Clone());
}
void WebUsbServiceImpl::OnDeviceManagerConnectionError() {
// Close the connection with blink.
clients_.Clear();
}
// device::mojom::UsbDeviceClient implementation:
void WebUsbServiceImpl::IncrementConnectionCount() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (delegate) {
delegate->IncrementConnectionCount(GetBrowserContext(), origin_);
}
if (connection_count_++ == 0) {
if (render_frame_host_) {
auto* web_contents = static_cast<WebContentsImpl*>(
WebContents::FromRenderFrameHost(render_frame_host_));
web_contents->IncrementUsbActiveFrameCount();
} else if (service_worker_version_) {
CHECK(!service_worker_activity_request_uuid_);
service_worker_activity_request_uuid_ = base::Uuid::GenerateRandomV4();
service_worker_version_->StartExternalRequest(
*service_worker_activity_request_uuid_,
ServiceWorkerExternalRequestTimeoutType::kDoesNotTimeout);
}
}
}
void WebUsbServiceImpl::DecrementConnectionCount() {
DCHECK_CURRENTLY_ON(content::BrowserThread::UI);
auto* delegate = GetContentClient()->browser()->GetUsbDelegate();
if (delegate) {
delegate->DecrementConnectionCount(GetBrowserContext(), origin_);
}
DCHECK_GT(connection_count_, 0);
if (--connection_count_ == 0) {
if (render_frame_host_) {
auto* web_contents = static_cast<WebContentsImpl*>(
WebContents::FromRenderFrameHost(render_frame_host_));
web_contents->DecrementUsbActiveFrameCount();
} else if (service_worker_version_) {
CHECK(service_worker_activity_request_uuid_);
service_worker_version_->FinishExternalRequest(
*service_worker_activity_request_uuid_);
service_worker_activity_request_uuid_.reset();
}
}
}
void WebUsbServiceImpl::RemoveDeviceClient(const UsbDeviceClient* client) {
std::erase_if(device_clients_, [client](const auto& this_client) {
return client == this_client.get();
});
}
} // namespace content