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
|
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef SERVICES_NETWORK_WEBSOCKET_H_
#define SERVICES_NETWORK_WEBSOCKET_H_
#include <stdint.h>
#include <memory>
#include <string>
#include <vector>
#include "base/component_export.h"
#include "base/containers/queue.h"
#include "base/containers/span.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/optional.h"
#include "base/time/time.h"
#include "base/util/type_safety/strong_alias.h"
#include "mojo/public/cpp/bindings/receiver.h"
#include "mojo/public/cpp/bindings/remote.h"
#include "net/websockets/websocket_event_interface.h"
#include "services/network/public/mojom/network_context.mojom.h"
#include "services/network/public/mojom/websocket.mojom.h"
#include "services/network/websocket_throttler.h"
#include "url/origin.h"
class GURL;
namespace base {
class Location;
} // namespace base
namespace net {
class SiteForCookies;
class SSLInfo;
class WebSocketChannel;
} // namespace net
namespace network {
class WebSocketFactory;
// Host of net::WebSocketChannel.
class COMPONENT_EXPORT(NETWORK_SERVICE) WebSocket : public mojom::WebSocket {
public:
using HasRawHeadersAccess =
util::StrongAlias<class HasRawHeadersAccessTag, bool>;
WebSocket(
WebSocketFactory* factory,
const GURL& url,
const std::vector<std::string>& requested_protocols,
const net::SiteForCookies& site_for_cookies,
const net::NetworkIsolationKey& network_isolation_key,
std::vector<mojom::HttpHeaderPtr> additional_headers,
int32_t process_id,
int32_t render_frame_id,
const url::Origin& origin,
uint32_t options,
HasRawHeadersAccess has_raw_cookie_access,
mojo::PendingRemote<mojom::WebSocketHandshakeClient> handshake_client,
mojo::PendingRemote<mojom::AuthenticationHandler> auth_handler,
mojo::PendingRemote<mojom::TrustedHeaderClient> header_client,
WebSocketThrottler::PendingConnection pending_connection_tracker,
base::TimeDelta delay);
~WebSocket() override;
// mojom::WebSocket methods:
void SendFrame(bool fin,
mojom::WebSocketMessageType type,
base::span<const uint8_t> data) override;
void SendMessage(mojom::WebSocketMessageType type,
uint64_t data_length) override;
void StartReceiving() override;
void StartClosingHandshake(uint16_t code, const std::string& reason) override;
bool handshake_succeeded() const { return handshake_succeeded_; }
// Whether to allow sending/setting cookies during WebSocket handshakes for
// |url|. This decision is based on the |options_| and |origin_| this
// WebSocket was created with.
bool AllowCookies(const GURL& url) const;
// These methods are called by the network delegate to forward these events to
// the |header_client_|.
int OnBeforeStartTransaction(net::CompletionOnceCallback callback,
net::HttpRequestHeaders* headers);
int OnHeadersReceived(
net::CompletionOnceCallback callback,
const net::HttpResponseHeaders* original_response_headers,
scoped_refptr<net::HttpResponseHeaders>* override_response_headers,
base::Optional<GURL>* preserve_fragment_on_redirect_url);
// Gets the WebSocket associated with this request.
static WebSocket* ForRequest(const net::URLRequest& request);
static const void* const kUserDataKey;
private:
class WebSocketEventHandler;
// This class is used to set the WebSocket as user data on a URLRequest. This
// is used instead of WebSocket directly because SetUserData requires a
// std::unique_ptr. This is safe because WebSocket owns the URLRequest, so is
// guaranteed to outlive it.
class UnownedPointer : public base::SupportsUserData::Data {
public:
explicit UnownedPointer(WebSocket* pointer) : pointer_(pointer) {}
WebSocket* get() const { return pointer_; }
private:
WebSocket* const pointer_;
DISALLOW_COPY_AND_ASSIGN(UnownedPointer);
};
struct DataFrame final {
DataFrame(mojom::WebSocketMessageType type, uint64_t data_length)
: type(type), data_length(data_length) {}
mojom::WebSocketMessageType type;
uint64_t data_length;
};
void OnConnectionError(const base::Location& set_from);
void AddChannel(const GURL& socket_url,
const std::vector<std::string>& requested_protocols,
const net::SiteForCookies& site_for_cookies,
const net::NetworkIsolationKey& network_isolation_key,
std::vector<mojom::HttpHeaderPtr> additional_headers);
void OnSSLCertificateErrorResponse(
std::unique_ptr<net::WebSocketEventInterface::SSLErrorCallbacks>
callbacks,
const net::SSLInfo& ssl_info,
int net_error);
void OnAuthRequiredComplete(
base::OnceCallback<void(const net::AuthCredentials*)> callback,
const base::Optional<net::AuthCredentials>& credential);
void OnBeforeSendHeadersComplete(
net::CompletionOnceCallback callback,
net::HttpRequestHeaders* out_headers,
int result,
const base::Optional<net::HttpRequestHeaders>& headers);
void OnHeadersReceivedComplete(
net::CompletionOnceCallback callback,
scoped_refptr<net::HttpResponseHeaders>* out_headers,
base::Optional<GURL>* out_preserve_fragment_on_redirect_url,
int result,
const base::Optional<std::string>& headers,
const base::Optional<GURL>& preserve_fragment_on_redirect_url);
void Reset();
// Datapipe functions to receive.
void OnWritable(MojoResult result, const mojo::HandleSignalsState& state);
void SendPendingDataFrames();
void SendDataFrame(base::span<const char>* data_span);
// Datapipe functions to send.
void OnReadable(MojoResult result, const mojo::HandleSignalsState& state);
// ReadAndSendFromDataPipe() may indirectly delete |this|.
void ReadAndSendFromDataPipe();
// |factory_| owns |this|.
WebSocketFactory* const factory_;
mojo::Receiver<mojom::WebSocket> receiver_{this};
mojo::Remote<mojom::WebSocketHandshakeClient> handshake_client_;
mojo::Remote<mojom::WebSocketClient> client_;
mojo::Remote<mojom::AuthenticationHandler> auth_handler_;
mojo::Remote<mojom::TrustedHeaderClient> header_client_;
WebSocketThrottler::PendingConnection pending_connection_tracker_;
// The channel we use to send events to the network.
std::unique_ptr<net::WebSocketChannel> channel_;
// Delay used for per-renderer WebSocket throttling.
const base::TimeDelta delay_;
const uint32_t options_;
const int32_t child_id_;
const int32_t frame_id_;
// The web origin to use for the WebSocket.
const url::Origin origin_;
// For 3rd-party cookie permission checking.
net::SiteForCookies site_for_cookies_;
// handshake_succeeded_ is used by WebSocketManager to manage counters for
// per-renderer WebSocket throttling.
bool handshake_succeeded_ = false;
const HasRawHeadersAccess has_raw_headers_access_;
// Datapipe fields to receive.
mojo::ScopedDataPipeProducerHandle writable_;
mojo::SimpleWatcher writable_watcher_;
base::queue<base::span<const char>> pending_data_frames_;
bool wait_for_writable_ = false;
// Datapipe fields to send.
mojo::ScopedDataPipeConsumerHandle readable_;
mojo::SimpleWatcher readable_watcher_;
base::queue<DataFrame> pending_send_data_frames_;
bool wait_for_readable_ = false;
base::WeakPtrFactory<WebSocket> weak_ptr_factory_{this};
DISALLOW_COPY_AND_ASSIGN(WebSocket);
};
} // namespace network
#endif // SERVICES_NETWORK_WEBSOCKET_H_
|
