xref: /aosp_15_r20/external/webrtc/rtc_base/socket_adapters.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1*d9f75844SAndroid Build Coastguard Worker /*
2*d9f75844SAndroid Build Coastguard Worker  *  Copyright 2004 The WebRTC Project Authors. All rights reserved.
3*d9f75844SAndroid Build Coastguard Worker  *
4*d9f75844SAndroid Build Coastguard Worker  *  Use of this source code is governed by a BSD-style license
5*d9f75844SAndroid Build Coastguard Worker  *  that can be found in the LICENSE file in the root of the source
6*d9f75844SAndroid Build Coastguard Worker  *  tree. An additional intellectual property rights grant can be found
7*d9f75844SAndroid Build Coastguard Worker  *  in the file PATENTS.  All contributing project authors may
8*d9f75844SAndroid Build Coastguard Worker  *  be found in the AUTHORS file in the root of the source tree.
9*d9f75844SAndroid Build Coastguard Worker  */
10*d9f75844SAndroid Build Coastguard Worker 
11*d9f75844SAndroid Build Coastguard Worker #ifndef RTC_BASE_SOCKET_ADAPTERS_H_
12*d9f75844SAndroid Build Coastguard Worker #define RTC_BASE_SOCKET_ADAPTERS_H_
13*d9f75844SAndroid Build Coastguard Worker 
14*d9f75844SAndroid Build Coastguard Worker #include <string>
15*d9f75844SAndroid Build Coastguard Worker 
16*d9f75844SAndroid Build Coastguard Worker #include "absl/strings/string_view.h"
17*d9f75844SAndroid Build Coastguard Worker #include "api/array_view.h"
18*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/async_socket.h"
19*d9f75844SAndroid Build Coastguard Worker #include "rtc_base/crypt_string.h"
20*d9f75844SAndroid Build Coastguard Worker 
21*d9f75844SAndroid Build Coastguard Worker namespace rtc {
22*d9f75844SAndroid Build Coastguard Worker 
23*d9f75844SAndroid Build Coastguard Worker struct HttpAuthContext;
24*d9f75844SAndroid Build Coastguard Worker class ByteBufferReader;
25*d9f75844SAndroid Build Coastguard Worker class ByteBufferWriter;
26*d9f75844SAndroid Build Coastguard Worker 
27*d9f75844SAndroid Build Coastguard Worker ///////////////////////////////////////////////////////////////////////////////
28*d9f75844SAndroid Build Coastguard Worker 
29*d9f75844SAndroid Build Coastguard Worker // Implements a socket adapter that can buffer and process data internally,
30*d9f75844SAndroid Build Coastguard Worker // as in the case of connecting to a proxy, where you must speak the proxy
31*d9f75844SAndroid Build Coastguard Worker // protocol before commencing normal socket behavior.
32*d9f75844SAndroid Build Coastguard Worker class BufferedReadAdapter : public AsyncSocketAdapter {
33*d9f75844SAndroid Build Coastguard Worker  public:
34*d9f75844SAndroid Build Coastguard Worker   BufferedReadAdapter(Socket* socket, size_t buffer_size);
35*d9f75844SAndroid Build Coastguard Worker   ~BufferedReadAdapter() override;
36*d9f75844SAndroid Build Coastguard Worker 
37*d9f75844SAndroid Build Coastguard Worker   BufferedReadAdapter(const BufferedReadAdapter&) = delete;
38*d9f75844SAndroid Build Coastguard Worker   BufferedReadAdapter& operator=(const BufferedReadAdapter&) = delete;
39*d9f75844SAndroid Build Coastguard Worker 
40*d9f75844SAndroid Build Coastguard Worker   int Send(const void* pv, size_t cb) override;
41*d9f75844SAndroid Build Coastguard Worker   int Recv(void* pv, size_t cb, int64_t* timestamp) override;
42*d9f75844SAndroid Build Coastguard Worker 
43*d9f75844SAndroid Build Coastguard Worker  protected:
DirectSend(const void * pv,size_t cb)44*d9f75844SAndroid Build Coastguard Worker   int DirectSend(const void* pv, size_t cb) {
45*d9f75844SAndroid Build Coastguard Worker     return AsyncSocketAdapter::Send(pv, cb);
46*d9f75844SAndroid Build Coastguard Worker   }
47*d9f75844SAndroid Build Coastguard Worker 
48*d9f75844SAndroid Build Coastguard Worker   void BufferInput(bool on = true);
49*d9f75844SAndroid Build Coastguard Worker   virtual void ProcessInput(char* data, size_t* len) = 0;
50*d9f75844SAndroid Build Coastguard Worker 
51*d9f75844SAndroid Build Coastguard Worker   void OnReadEvent(Socket* socket) override;
52*d9f75844SAndroid Build Coastguard Worker 
53*d9f75844SAndroid Build Coastguard Worker  private:
54*d9f75844SAndroid Build Coastguard Worker   char* buffer_;
55*d9f75844SAndroid Build Coastguard Worker   size_t buffer_size_, data_len_;
56*d9f75844SAndroid Build Coastguard Worker   bool buffering_;
57*d9f75844SAndroid Build Coastguard Worker };
58*d9f75844SAndroid Build Coastguard Worker 
59*d9f75844SAndroid Build Coastguard Worker ///////////////////////////////////////////////////////////////////////////////
60*d9f75844SAndroid Build Coastguard Worker 
61*d9f75844SAndroid Build Coastguard Worker // Implements a socket adapter that performs the client side of a
62*d9f75844SAndroid Build Coastguard Worker // fake SSL handshake. Used for "ssltcp" P2P functionality.
63*d9f75844SAndroid Build Coastguard Worker class AsyncSSLSocket : public BufferedReadAdapter {
64*d9f75844SAndroid Build Coastguard Worker  public:
65*d9f75844SAndroid Build Coastguard Worker   static ArrayView<const uint8_t> SslClientHello();
66*d9f75844SAndroid Build Coastguard Worker   static ArrayView<const uint8_t> SslServerHello();
67*d9f75844SAndroid Build Coastguard Worker 
68*d9f75844SAndroid Build Coastguard Worker   explicit AsyncSSLSocket(Socket* socket);
69*d9f75844SAndroid Build Coastguard Worker 
70*d9f75844SAndroid Build Coastguard Worker   AsyncSSLSocket(const AsyncSSLSocket&) = delete;
71*d9f75844SAndroid Build Coastguard Worker   AsyncSSLSocket& operator=(const AsyncSSLSocket&) = delete;
72*d9f75844SAndroid Build Coastguard Worker 
73*d9f75844SAndroid Build Coastguard Worker   int Connect(const SocketAddress& addr) override;
74*d9f75844SAndroid Build Coastguard Worker 
75*d9f75844SAndroid Build Coastguard Worker  protected:
76*d9f75844SAndroid Build Coastguard Worker   void OnConnectEvent(Socket* socket) override;
77*d9f75844SAndroid Build Coastguard Worker   void ProcessInput(char* data, size_t* len) override;
78*d9f75844SAndroid Build Coastguard Worker };
79*d9f75844SAndroid Build Coastguard Worker 
80*d9f75844SAndroid Build Coastguard Worker ///////////////////////////////////////////////////////////////////////////////
81*d9f75844SAndroid Build Coastguard Worker 
82*d9f75844SAndroid Build Coastguard Worker // Implements a socket adapter that speaks the HTTP/S proxy protocol.
83*d9f75844SAndroid Build Coastguard Worker class AsyncHttpsProxySocket : public BufferedReadAdapter {
84*d9f75844SAndroid Build Coastguard Worker  public:
85*d9f75844SAndroid Build Coastguard Worker   AsyncHttpsProxySocket(Socket* socket,
86*d9f75844SAndroid Build Coastguard Worker                         absl::string_view user_agent,
87*d9f75844SAndroid Build Coastguard Worker                         const SocketAddress& proxy,
88*d9f75844SAndroid Build Coastguard Worker                         absl::string_view username,
89*d9f75844SAndroid Build Coastguard Worker                         const CryptString& password);
90*d9f75844SAndroid Build Coastguard Worker   ~AsyncHttpsProxySocket() override;
91*d9f75844SAndroid Build Coastguard Worker 
92*d9f75844SAndroid Build Coastguard Worker   AsyncHttpsProxySocket(const AsyncHttpsProxySocket&) = delete;
93*d9f75844SAndroid Build Coastguard Worker   AsyncHttpsProxySocket& operator=(const AsyncHttpsProxySocket&) = delete;
94*d9f75844SAndroid Build Coastguard Worker 
95*d9f75844SAndroid Build Coastguard Worker   // If connect is forced, the adapter will always issue an HTTP CONNECT to the
96*d9f75844SAndroid Build Coastguard Worker   // target address.  Otherwise, it will connect only if the destination port
97*d9f75844SAndroid Build Coastguard Worker   // is not port 80.
SetForceConnect(bool force)98*d9f75844SAndroid Build Coastguard Worker   void SetForceConnect(bool force) { force_connect_ = force; }
99*d9f75844SAndroid Build Coastguard Worker 
100*d9f75844SAndroid Build Coastguard Worker   int Connect(const SocketAddress& addr) override;
101*d9f75844SAndroid Build Coastguard Worker   SocketAddress GetRemoteAddress() const override;
102*d9f75844SAndroid Build Coastguard Worker   int Close() override;
103*d9f75844SAndroid Build Coastguard Worker   ConnState GetState() const override;
104*d9f75844SAndroid Build Coastguard Worker 
105*d9f75844SAndroid Build Coastguard Worker  protected:
106*d9f75844SAndroid Build Coastguard Worker   void OnConnectEvent(Socket* socket) override;
107*d9f75844SAndroid Build Coastguard Worker   void OnCloseEvent(Socket* socket, int err) override;
108*d9f75844SAndroid Build Coastguard Worker   void ProcessInput(char* data, size_t* len) override;
109*d9f75844SAndroid Build Coastguard Worker 
110*d9f75844SAndroid Build Coastguard Worker   bool ShouldIssueConnect() const;
111*d9f75844SAndroid Build Coastguard Worker   void SendRequest();
112*d9f75844SAndroid Build Coastguard Worker   void ProcessLine(char* data, size_t len);
113*d9f75844SAndroid Build Coastguard Worker   void EndResponse();
114*d9f75844SAndroid Build Coastguard Worker   void Error(int error);
115*d9f75844SAndroid Build Coastguard Worker 
116*d9f75844SAndroid Build Coastguard Worker  private:
117*d9f75844SAndroid Build Coastguard Worker   SocketAddress proxy_, dest_;
118*d9f75844SAndroid Build Coastguard Worker   std::string agent_, user_, headers_;
119*d9f75844SAndroid Build Coastguard Worker   CryptString pass_;
120*d9f75844SAndroid Build Coastguard Worker   bool force_connect_;
121*d9f75844SAndroid Build Coastguard Worker   size_t content_length_;
122*d9f75844SAndroid Build Coastguard Worker   int defer_error_;
123*d9f75844SAndroid Build Coastguard Worker   bool expect_close_;
124*d9f75844SAndroid Build Coastguard Worker   enum ProxyState {
125*d9f75844SAndroid Build Coastguard Worker     PS_INIT,
126*d9f75844SAndroid Build Coastguard Worker     PS_LEADER,
127*d9f75844SAndroid Build Coastguard Worker     PS_AUTHENTICATE,
128*d9f75844SAndroid Build Coastguard Worker     PS_SKIP_HEADERS,
129*d9f75844SAndroid Build Coastguard Worker     PS_ERROR_HEADERS,
130*d9f75844SAndroid Build Coastguard Worker     PS_TUNNEL_HEADERS,
131*d9f75844SAndroid Build Coastguard Worker     PS_SKIP_BODY,
132*d9f75844SAndroid Build Coastguard Worker     PS_TUNNEL,
133*d9f75844SAndroid Build Coastguard Worker     PS_WAIT_CLOSE,
134*d9f75844SAndroid Build Coastguard Worker     PS_ERROR
135*d9f75844SAndroid Build Coastguard Worker   } state_;
136*d9f75844SAndroid Build Coastguard Worker   HttpAuthContext* context_;
137*d9f75844SAndroid Build Coastguard Worker   std::string unknown_mechanisms_;
138*d9f75844SAndroid Build Coastguard Worker };
139*d9f75844SAndroid Build Coastguard Worker 
140*d9f75844SAndroid Build Coastguard Worker ///////////////////////////////////////////////////////////////////////////////
141*d9f75844SAndroid Build Coastguard Worker 
142*d9f75844SAndroid Build Coastguard Worker // Implements a socket adapter that speaks the SOCKS proxy protocol.
143*d9f75844SAndroid Build Coastguard Worker class AsyncSocksProxySocket : public BufferedReadAdapter {
144*d9f75844SAndroid Build Coastguard Worker  public:
145*d9f75844SAndroid Build Coastguard Worker   AsyncSocksProxySocket(Socket* socket,
146*d9f75844SAndroid Build Coastguard Worker                         const SocketAddress& proxy,
147*d9f75844SAndroid Build Coastguard Worker                         absl::string_view username,
148*d9f75844SAndroid Build Coastguard Worker                         const CryptString& password);
149*d9f75844SAndroid Build Coastguard Worker   ~AsyncSocksProxySocket() override;
150*d9f75844SAndroid Build Coastguard Worker 
151*d9f75844SAndroid Build Coastguard Worker   AsyncSocksProxySocket(const AsyncSocksProxySocket&) = delete;
152*d9f75844SAndroid Build Coastguard Worker   AsyncSocksProxySocket& operator=(const AsyncSocksProxySocket&) = delete;
153*d9f75844SAndroid Build Coastguard Worker 
154*d9f75844SAndroid Build Coastguard Worker   int Connect(const SocketAddress& addr) override;
155*d9f75844SAndroid Build Coastguard Worker   SocketAddress GetRemoteAddress() const override;
156*d9f75844SAndroid Build Coastguard Worker   int Close() override;
157*d9f75844SAndroid Build Coastguard Worker   ConnState GetState() const override;
158*d9f75844SAndroid Build Coastguard Worker 
159*d9f75844SAndroid Build Coastguard Worker  protected:
160*d9f75844SAndroid Build Coastguard Worker   void OnConnectEvent(Socket* socket) override;
161*d9f75844SAndroid Build Coastguard Worker   void ProcessInput(char* data, size_t* len) override;
162*d9f75844SAndroid Build Coastguard Worker 
163*d9f75844SAndroid Build Coastguard Worker   void SendHello();
164*d9f75844SAndroid Build Coastguard Worker   void SendConnect();
165*d9f75844SAndroid Build Coastguard Worker   void SendAuth();
166*d9f75844SAndroid Build Coastguard Worker   void Error(int error);
167*d9f75844SAndroid Build Coastguard Worker 
168*d9f75844SAndroid Build Coastguard Worker  private:
169*d9f75844SAndroid Build Coastguard Worker   enum State { SS_INIT, SS_HELLO, SS_AUTH, SS_CONNECT, SS_TUNNEL, SS_ERROR };
170*d9f75844SAndroid Build Coastguard Worker   State state_;
171*d9f75844SAndroid Build Coastguard Worker   SocketAddress proxy_, dest_;
172*d9f75844SAndroid Build Coastguard Worker   std::string user_;
173*d9f75844SAndroid Build Coastguard Worker   CryptString pass_;
174*d9f75844SAndroid Build Coastguard Worker };
175*d9f75844SAndroid Build Coastguard Worker 
176*d9f75844SAndroid Build Coastguard Worker }  // namespace rtc
177*d9f75844SAndroid Build Coastguard Worker 
178*d9f75844SAndroid Build Coastguard Worker #endif  // RTC_BASE_SOCKET_ADAPTERS_H_
179