blob: f29877c5b9eb12b563f1a7298a2484d28c40d2b8 [file] [log] [blame]
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001/*
2 * Copyright 2004 The WebRTC Project Authors. All rights reserved.
3 *
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
9 */
10
Steve Anton10542f22019-01-11 09:11:00 -080011#ifndef P2P_BASE_PORT_ALLOCATOR_H_
12#define P2P_BASE_PORT_ALLOCATOR_H_
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000013
Taylor Brandstettera1c30352016-05-13 08:15:11 -070014#include <deque>
15#include <memory>
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000016#include <string>
17#include <vector>
18
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020019#include "p2p/base/port.h"
Steve Anton10542f22019-01-11 09:11:00 -080020#include "p2p/base/port_interface.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020021#include "rtc_base/helpers.h"
Steve Anton10542f22019-01-11 09:11:00 -080022#include "rtc_base/proxy_info.h"
23#include "rtc_base/ssl_certificate.h"
Mirko Bonadei3b56ee72018-10-15 17:15:12 +020024#include "rtc_base/system/rtc_export.h"
Artem Titove41c4332018-07-25 15:04:28 +020025#include "rtc_base/third_party/sigslot/sigslot.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020026#include "rtc_base/thread.h"
Qingsi Wanga2d60672018-04-11 16:57:45 -070027#include "rtc_base/thread_checker.h"
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000028
Honghai Zhangd93f50c2016-10-05 11:47:22 -070029namespace webrtc {
Jonas Orelandbdcee282017-10-10 14:01:40 +020030class TurnCustomizer;
Yves Gerey665174f2018-06-19 15:03:05 +020031} // namespace webrtc
Honghai Zhangd93f50c2016-10-05 11:47:22 -070032
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000033namespace cricket {
34
35// PortAllocator is responsible for allocating Port types for a given
36// P2PSocket. It also handles port freeing.
37//
38// Clients can override this class to control port allocation, including
39// what kinds of ports are allocated.
40
41enum {
Guo-wei Shieh13d35f62015-08-26 15:32:56 -070042 // Disable local UDP ports. This doesn't impact how we connect to relay
43 // servers.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000044 PORTALLOCATOR_DISABLE_UDP = 0x01,
45 PORTALLOCATOR_DISABLE_STUN = 0x02,
46 PORTALLOCATOR_DISABLE_RELAY = 0x04,
Guo-wei Shieh13d35f62015-08-26 15:32:56 -070047 // Disable local TCP ports. This doesn't impact how we connect to relay
48 // servers.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000049 PORTALLOCATOR_DISABLE_TCP = 0x08,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000050 PORTALLOCATOR_ENABLE_IPV6 = 0x40,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000051 PORTALLOCATOR_ENABLE_SHARED_SOCKET = 0x100,
52 PORTALLOCATOR_ENABLE_STUN_RETRANSMIT_ATTRIBUTE = 0x200,
Guo-wei Shieh9af97f82015-11-10 14:47:39 -080053 // When specified, we'll only allocate the STUN candidate for the public
54 // interface as seen by regular http traffic and the HOST candidate associated
55 // with the default local interface.
guoweis@webrtc.orgf358aea2015-02-18 18:44:01 +000056 PORTALLOCATOR_DISABLE_ADAPTER_ENUMERATION = 0x400,
Guo-wei Shieh9af97f82015-11-10 14:47:39 -080057 // When specified along with PORTALLOCATOR_DISABLE_ADAPTER_ENUMERATION, the
58 // default local candidate mentioned above will not be allocated. Only the
59 // STUN candidate will be.
60 PORTALLOCATOR_DISABLE_DEFAULT_LOCAL_CANDIDATE = 0x800,
Guo-wei Shieh13d35f62015-08-26 15:32:56 -070061 // Disallow use of UDP when connecting to a relay server. Since proxy servers
62 // usually don't handle UDP, using UDP will leak the IP address.
63 PORTALLOCATOR_DISABLE_UDP_RELAY = 0x1000,
honghaiz60347052016-05-31 18:29:12 -070064
65 // When multiple networks exist, do not gather candidates on the ones with
66 // high cost. So if both Wi-Fi and cellular networks exist, gather only on the
67 // Wi-Fi network. If a network type is "unknown", it has a cost lower than
68 // cellular but higher than Wi-Fi/Ethernet. So if an unknown network exists,
69 // cellular networks will not be used to gather candidates and if a Wi-Fi
70 // network is present, "unknown" networks will not be usd to gather
71 // candidates. Doing so ensures that even if a cellular network type was not
72 // detected initially, it would not be used if a Wi-Fi network is present.
73 PORTALLOCATOR_DISABLE_COSTLY_NETWORKS = 0x2000,
zhihuangb09b3f92017-03-07 14:40:51 -080074
75 // When specified, do not collect IPv6 ICE candidates on Wi-Fi.
76 PORTALLOCATOR_ENABLE_IPV6_ON_WIFI = 0x4000,
deadbeef1ee21252017-06-13 15:49:45 -070077
Mirko Bonadei5f4d47b2018-08-22 17:41:22 +000078 // When this flag is set, ports not bound to any specific network interface
79 // will be used, in addition to normal ports bound to the enumerated
80 // interfaces. Without this flag, these "any address" ports would only be
81 // used when network enumeration fails or is disabled. But under certain
82 // conditions, these ports may succeed where others fail, so they may allow
83 // the application to work in a wider variety of environments, at the expense
84 // of having to allocate additional candidates.
Qingsi Wangefbcb312018-08-21 23:23:26 +000085 PORTALLOCATOR_ENABLE_ANY_ADDRESS_PORTS = 0x8000,
86
Daniel Lazarenko2870b0a2018-01-25 10:30:22 +010087 // Exclude link-local network interfaces
88 // from considertaion after adapter enumeration.
Qingsi Wangefbcb312018-08-21 23:23:26 +000089 PORTALLOCATOR_DISABLE_LINK_LOCAL_NETWORKS = 0x10000,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000090};
91
Honghai Zhangd93f50c2016-10-05 11:47:22 -070092// Defines various reasons that have caused ICE regathering.
Steve Anton300bf8e2017-07-14 10:13:10 -070093enum class IceRegatheringReason {
94 NETWORK_CHANGE, // Network interfaces on the device changed
95 NETWORK_FAILURE, // Regather only on networks that have failed
96 OCCASIONAL_REFRESH, // Periodic regather on all networks
97 MAX_VALUE
98};
Honghai Zhangd93f50c2016-10-05 11:47:22 -070099
Peter Boström0c4e06b2015-10-07 12:23:21 +0200100const uint32_t kDefaultPortAllocatorFlags = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000101
Peter Boström0c4e06b2015-10-07 12:23:21 +0200102const uint32_t kDefaultStepDelay = 1000; // 1 sec step delay.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000103// As per RFC 5245 Appendix B.1, STUN transactions need to be paced at certain
104// internal. Less than 20ms is not acceptable. We choose 50ms as our default.
Peter Boström0c4e06b2015-10-07 12:23:21 +0200105const uint32_t kMinimumStepDelay = 50;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000106
deadbeef3427f532017-07-26 16:09:33 -0700107// Turning on IPv6 could make many IPv6 interfaces available for connectivity
108// check and delay the call setup time. kDefaultMaxIPv6Networks is the default
109// upper limit of IPv6 networks but could be changed by
110// set_max_ipv6_networks().
111constexpr int kDefaultMaxIPv6Networks = 5;
112
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000113// CF = CANDIDATE FILTER
Oleh Prypinfd7df982017-12-21 16:25:19 +0100114enum : uint32_t {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000115 CF_NONE = 0x0,
116 CF_HOST = 0x1,
117 CF_REFLEXIVE = 0x2,
118 CF_RELAY = 0x4,
119 CF_ALL = 0x7,
120};
121
Sergey Silkin9c147dd2018-09-12 10:45:38 +0000122// TLS certificate policy.
123enum class TlsCertPolicy {
124 // For TLS based protocols, ensure the connection is secure by not
125 // circumventing certificate validation.
126 TLS_CERT_POLICY_SECURE,
127 // For TLS based protocols, disregard security completely by skipping
128 // certificate validation. This is insecure and should never be used unless
129 // security is irrelevant in that particular context.
130 TLS_CERT_POLICY_INSECURE_NO_CHECK,
131};
132
deadbeef653b8e02015-11-11 12:55:10 -0800133// TODO(deadbeef): Rename to TurnCredentials (and username to ufrag).
134struct RelayCredentials {
135 RelayCredentials() {}
136 RelayCredentials(const std::string& username, const std::string& password)
137 : username(username), password(password) {}
138
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700139 bool operator==(const RelayCredentials& o) const {
140 return username == o.username && password == o.password;
141 }
142 bool operator!=(const RelayCredentials& o) const { return !(*this == o); }
143
deadbeef653b8e02015-11-11 12:55:10 -0800144 std::string username;
145 std::string password;
146};
147
148typedef std::vector<ProtocolAddress> PortList;
149// TODO(deadbeef): Rename to TurnServerConfig.
Mirko Bonadei3b56ee72018-10-15 17:15:12 +0200150struct RTC_EXPORT RelayServerConfig {
Steve Anton6c38cc72017-11-29 10:25:58 -0800151 explicit RelayServerConfig(RelayType type);
Emad Omaradab1d2d2017-06-16 15:43:11 -0700152 RelayServerConfig(const rtc::SocketAddress& address,
153 const std::string& username,
154 const std::string& password,
Steve Anton7995d8c2017-10-30 16:23:38 -0700155 ProtocolType proto);
Taylor Brandstetter0c7e9f52015-12-29 14:14:52 -0800156 RelayServerConfig(const std::string& address,
157 int port,
158 const std::string& username,
159 const std::string& password,
Steve Anton7995d8c2017-10-30 16:23:38 -0700160 ProtocolType proto);
hnsl277b2502016-12-13 05:17:23 -0800161 // Legacy constructor where "secure" and PROTO_TCP implies PROTO_TLS.
162 RelayServerConfig(const std::string& address,
163 int port,
164 const std::string& username,
165 const std::string& password,
Taylor Brandstetter0c7e9f52015-12-29 14:14:52 -0800166 ProtocolType proto,
Steve Anton7995d8c2017-10-30 16:23:38 -0700167 bool secure);
168 RelayServerConfig(const RelayServerConfig&);
169 ~RelayServerConfig();
Taylor Brandstetter0c7e9f52015-12-29 14:14:52 -0800170
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700171 bool operator==(const RelayServerConfig& o) const {
172 return type == o.type && ports == o.ports && credentials == o.credentials &&
173 priority == o.priority;
174 }
175 bool operator!=(const RelayServerConfig& o) const { return !(*this == o); }
176
deadbeef653b8e02015-11-11 12:55:10 -0800177 RelayType type;
178 PortList ports;
179 RelayCredentials credentials;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700180 int priority = 0;
hnsl04833622017-01-09 08:35:45 -0800181 TlsCertPolicy tls_cert_policy = TlsCertPolicy::TLS_CERT_POLICY_SECURE;
Diogo Real1dca9d52017-08-29 12:18:32 -0700182 std::vector<std::string> tls_alpn_protocols;
Diogo Real7bd1f1b2017-09-08 12:50:41 -0700183 std::vector<std::string> tls_elliptic_curves;
Benjamin Wrightd6f86e82018-05-08 13:12:25 -0700184 rtc::SSLCertificateVerifier* tls_cert_verifier = nullptr;
Jonas Oreland3c028422019-08-22 16:16:35 +0200185 std::string turn_logging_id;
deadbeef653b8e02015-11-11 12:55:10 -0800186};
187
Mirko Bonadei3b56ee72018-10-15 17:15:12 +0200188class RTC_EXPORT PortAllocatorSession : public sigslot::has_slots<> {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000189 public:
190 // Content name passed in mostly for logging and debugging.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000191 PortAllocatorSession(const std::string& content_name,
192 int component,
deadbeefcbecd352015-09-23 11:50:27 -0700193 const std::string& ice_ufrag,
194 const std::string& ice_pwd,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200195 uint32_t flags);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000196
197 // Subclasses should clean up any ports created.
Steve Anton7995d8c2017-10-30 16:23:38 -0700198 ~PortAllocatorSession() override;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000199
Peter Boström0c4e06b2015-10-07 12:23:21 +0200200 uint32_t flags() const { return flags_; }
201 void set_flags(uint32_t flags) { flags_ = flags; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000202 std::string content_name() const { return content_name_; }
203 int component() const { return component_; }
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700204 const std::string& ice_ufrag() const { return ice_ufrag_; }
205 const std::string& ice_pwd() const { return ice_pwd_; }
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200206 bool pooled() const { return pooled_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000207
Taylor Brandstetter417eebe2016-05-23 16:02:19 -0700208 // Setting this filter should affect not only candidates gathered in the
209 // future, but candidates already gathered and ports already "ready",
210 // which would be returned by ReadyCandidates() and ReadyPorts().
211 //
212 // Default filter should be CF_ALL.
213 virtual void SetCandidateFilter(uint32_t filter) = 0;
214
deadbeefb60a8192016-08-24 15:15:00 -0700215 // Starts gathering ports and ICE candidates.
Honghai Zhangd8f6fc42016-07-01 17:31:12 -0700216 virtual void StartGettingPorts() = 0;
deadbeefb60a8192016-08-24 15:15:00 -0700217 // Completely stops gathering. Will not gather again unless StartGettingPorts
218 // is called again.
Honghai Zhangd8f6fc42016-07-01 17:31:12 -0700219 virtual void StopGettingPorts() = 0;
Honghai Zhang5622c5e2016-07-01 13:59:29 -0700220 // Whether the session is actively getting ports.
Honghai Zhangd8f6fc42016-07-01 17:31:12 -0700221 virtual bool IsGettingPorts() = 0;
deadbeefb60a8192016-08-24 15:15:00 -0700222
223 //
224 // NOTE: The group of methods below is only used for continual gathering.
225 //
226
227 // ClearGettingPorts should have the same immediate effect as
228 // StopGettingPorts, but if the implementation supports continual gathering,
229 // ClearGettingPorts allows additional ports/candidates to be gathered if the
230 // network conditions change.
Honghai Zhangd8f6fc42016-07-01 17:31:12 -0700231 virtual void ClearGettingPorts() = 0;
Honghai Zhang5622c5e2016-07-01 13:59:29 -0700232 // Whether it is in the state where the existing gathering process is stopped,
233 // but new ones may be started (basically after calling ClearGettingPorts).
Steve Anton7995d8c2017-10-30 16:23:38 -0700234 virtual bool IsCleared() const;
Honghai Zhang5622c5e2016-07-01 13:59:29 -0700235 // Whether the session has completely stopped.
Steve Anton7995d8c2017-10-30 16:23:38 -0700236 virtual bool IsStopped() const;
Honghai Zhang5622c5e2016-07-01 13:59:29 -0700237 // Re-gathers candidates on networks that do not have any connections. More
238 // precisely, a network interface may have more than one IP addresses (e.g.,
239 // IPv4 and IPv6 addresses). Each address subnet will be used to create a
240 // network. Only if all networks of an interface have no connection, the
241 // implementation should start re-gathering on all networks of that interface.
242 virtual void RegatherOnFailedNetworks() {}
243 // Re-gathers candidates on all networks.
Honghai Zhang5622c5e2016-07-01 13:59:29 -0700244 virtual void RegatherOnAllNetworks() {}
Qingsi Wang72a43a12018-02-20 16:03:18 -0800245 // Get candidate-level stats from all candidates on the ready ports and return
246 // the stats to the given list.
247 virtual void GetCandidateStatsFromReadyPorts(
Qingsi Wang7627fdd2019-08-19 16:07:40 -0700248 CandidateStatsList* candidate_stats_list) const {}
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800249 // Set the interval at which STUN candidates will resend STUN binding requests
250 // on the underlying ports to keep NAT bindings open.
251 // The default value of the interval in implementation is restored if a null
252 // optional value is passed.
253 virtual void SetStunKeepaliveIntervalForReadyPorts(
Danil Chapovalov00c71832018-06-15 15:58:38 +0200254 const absl::optional<int>& stun_keepalive_interval) {}
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700255 // Another way of getting the information provided by the signals below.
256 //
257 // Ports and candidates are not guaranteed to be in the same order as the
258 // signals were emitted in.
259 virtual std::vector<PortInterface*> ReadyPorts() const = 0;
260 virtual std::vector<Candidate> ReadyCandidates() const = 0;
261 virtual bool CandidatesAllocationDone() const = 0;
Honghai Zhanga74363c2016-07-28 18:06:15 -0700262 // Marks all ports in the current session as "pruned" so that they may be
263 // destroyed if no connection is using them.
264 virtual void PruneAllPorts() {}
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700265
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000266 sigslot::signal2<PortAllocatorSession*, PortInterface*> SignalPortReady;
Honghai Zhang8eeecab2016-07-28 13:20:15 -0700267 // Fires this signal when the network of the ports failed (either because the
268 // interface is down, or because there is no connection on the interface),
269 // or when TURN ports are pruned because a higher-priority TURN port becomes
270 // ready(pairable).
Honghai Zhang5622c5e2016-07-01 13:59:29 -0700271 sigslot::signal2<PortAllocatorSession*, const std::vector<PortInterface*>&>
Honghai Zhang8eeecab2016-07-28 13:20:15 -0700272 SignalPortsPruned;
Yves Gerey665174f2018-06-19 15:03:05 +0200273 sigslot::signal2<PortAllocatorSession*, const std::vector<Candidate>&>
274 SignalCandidatesReady;
Eldar Relloda13ea22019-06-01 12:23:43 +0300275 sigslot::signal2<PortAllocatorSession*, const IceCandidateErrorEvent&>
276 SignalCandidateError;
Honghai Zhang5622c5e2016-07-01 13:59:29 -0700277 // Candidates should be signaled to be removed when the port that generated
278 // the candidates is removed.
279 sigslot::signal2<PortAllocatorSession*, const std::vector<Candidate>&>
280 SignalCandidatesRemoved;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000281 sigslot::signal1<PortAllocatorSession*> SignalCandidatesAllocationDone;
282
Honghai Zhangd93f50c2016-10-05 11:47:22 -0700283 sigslot::signal2<PortAllocatorSession*, IceRegatheringReason>
284 SignalIceRegathering;
285
Steve Anton7995d8c2017-10-30 16:23:38 -0700286 virtual uint32_t generation();
287 virtual void set_generation(uint32_t generation);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000288 sigslot::signal1<PortAllocatorSession*> SignalDestroyed;
289
deadbeefc55fb302016-05-12 12:51:38 -0700290 protected:
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700291 // This method is called when a pooled session (which doesn't have these
292 // properties initially) is returned by PortAllocator::TakePooledSession,
293 // and the content name, component, and ICE ufrag/pwd are updated.
294 //
295 // A subclass may need to override this method to perform additional actions,
296 // such as applying the updated information to ports and candidates.
297 virtual void UpdateIceParametersInternal() {}
298
deadbeefcbecd352015-09-23 11:50:27 -0700299 // TODO(deadbeef): Get rid of these when everyone switches to ice_ufrag and
300 // ice_pwd.
301 const std::string& username() const { return ice_ufrag_; }
302 const std::string& password() const { return ice_pwd_; }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000303
deadbeefc55fb302016-05-12 12:51:38 -0700304 private:
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700305 void SetIceParameters(const std::string& content_name,
306 int component,
307 const std::string& ice_ufrag,
308 const std::string& ice_pwd) {
309 content_name_ = content_name;
310 component_ = component;
311 ice_ufrag_ = ice_ufrag;
312 ice_pwd_ = ice_pwd;
313 UpdateIceParametersInternal();
314 }
315
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200316 void set_pooled(bool value) { pooled_ = value; }
317
deadbeefc55fb302016-05-12 12:51:38 -0700318 uint32_t flags_;
319 uint32_t generation_;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700320 std::string content_name_;
321 int component_;
deadbeefcbecd352015-09-23 11:50:27 -0700322 std::string ice_ufrag_;
323 std::string ice_pwd_;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700324
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200325 bool pooled_ = false;
326
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700327 // SetIceParameters is an implementation detail which only PortAllocator
328 // should be able to call.
329 friend class PortAllocator;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000330};
331
Taylor Brandstetterf8e65772016-06-27 17:20:15 -0700332// Every method of PortAllocator (including the destructor) must be called on
Qingsi Wanga2d60672018-04-11 16:57:45 -0700333// the same thread after Initialize is called.
Taylor Brandstetterf8e65772016-06-27 17:20:15 -0700334//
Qingsi Wanga2d60672018-04-11 16:57:45 -0700335// This allows a PortAllocator subclass to be constructed and configured on one
336// thread, and passed into an object that uses it on a different thread.
Mirko Bonadei3b56ee72018-10-15 17:15:12 +0200337class RTC_EXPORT PortAllocator : public sigslot::has_slots<> {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000338 public:
Steve Anton7995d8c2017-10-30 16:23:38 -0700339 PortAllocator();
340 ~PortAllocator() override;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000341
Qingsi Wanga2d60672018-04-11 16:57:45 -0700342 // This MUST be called on the PortAllocator's thread after finishing
343 // constructing and configuring the PortAllocator subclasses.
344 virtual void Initialize();
Taylor Brandstetterf8e65772016-06-27 17:20:15 -0700345
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200346 // Set to true if some Ports need to know the ICE credentials when they are
347 // created. This will ensure that the PortAllocator will only match pooled
348 // allocator sessions to the ICE transport with the same credentials.
349 virtual void set_restrict_ice_credentials_change(bool value);
350
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700351 // Set STUN and TURN servers to be used in future sessions, and set
352 // candidate pool size, as described in JSEP.
353 //
deadbeef42a42632017-03-10 15:18:00 -0800354 // If the servers are changing, and the candidate pool size is nonzero, and
355 // FreezeCandidatePool hasn't been called, existing pooled sessions will be
356 // destroyed and new ones created.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700357 //
deadbeef42a42632017-03-10 15:18:00 -0800358 // If the servers are not changing but the candidate pool size is, and
359 // FreezeCandidatePool hasn't been called, pooled sessions will be either
360 // created or destroyed as necessary.
deadbeef6de92f92016-12-12 18:49:32 -0800361 //
362 // Returns true if the configuration could successfully be changed.
363 bool SetConfiguration(const ServerAddresses& stun_servers,
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700364 const std::vector<RelayServerConfig>& turn_servers,
Honghai Zhangb9e7b4a2016-06-30 20:52:02 -0700365 int candidate_pool_size,
Jonas Orelandbdcee282017-10-10 14:01:40 +0200366 bool prune_turn_ports,
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800367 webrtc::TurnCustomizer* turn_customizer = nullptr,
Danil Chapovalov00c71832018-06-15 15:58:38 +0200368 const absl::optional<int>&
369 stun_candidate_keepalive_interval = absl::nullopt);
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700370
Qingsi Wanga2d60672018-04-11 16:57:45 -0700371 const ServerAddresses& stun_servers() const {
372 CheckRunOnValidThreadIfInitialized();
373 return stun_servers_;
374 }
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700375
376 const std::vector<RelayServerConfig>& turn_servers() const {
Qingsi Wanga2d60672018-04-11 16:57:45 -0700377 CheckRunOnValidThreadIfInitialized();
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700378 return turn_servers_;
379 }
380
Qingsi Wanga2d60672018-04-11 16:57:45 -0700381 int candidate_pool_size() const {
382 CheckRunOnValidThreadIfInitialized();
383 return candidate_pool_size_;
384 }
385
Danil Chapovalov00c71832018-06-15 15:58:38 +0200386 const absl::optional<int>& stun_candidate_keepalive_interval() const {
Qingsi Wanga2d60672018-04-11 16:57:45 -0700387 CheckRunOnValidThreadIfInitialized();
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800388 return stun_candidate_keepalive_interval_;
389 }
deadbeef653b8e02015-11-11 12:55:10 -0800390
Taylor Brandstetter0c7e9f52015-12-29 14:14:52 -0800391 // Sets the network types to ignore.
392 // Values are defined by the AdapterType enum.
393 // For instance, calling this with
394 // ADAPTER_TYPE_ETHERNET | ADAPTER_TYPE_LOOPBACK will ignore Ethernet and
395 // loopback interfaces.
396 virtual void SetNetworkIgnoreMask(int network_ignore_mask) = 0;
397
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700398 std::unique_ptr<PortAllocatorSession> CreateSession(
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000399 const std::string& content_name,
400 int component,
401 const std::string& ice_ufrag,
402 const std::string& ice_pwd);
403
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700404 // Get an available pooled session and set the transport information on it.
405 //
406 // Caller takes ownership of the returned session.
407 //
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200408 // If restrict_ice_credentials_change is TRUE, then it will only
409 // return a pooled session with matching ice credentials.
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700410 // If no pooled sessions are available, returns null.
411 std::unique_ptr<PortAllocatorSession> TakePooledSession(
412 const std::string& content_name,
413 int component,
414 const std::string& ice_ufrag,
415 const std::string& ice_pwd);
416
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200417 // Returns the next session that would be returned by TakePooledSession
418 // optionally restricting it to sessions with specified ice credentials.
419 const PortAllocatorSession* GetPooledSession(
420 const IceParameters* ice_credentials = nullptr) const;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700421
deadbeef42a42632017-03-10 15:18:00 -0800422 // After FreezeCandidatePool is called, changing the candidate pool size will
423 // no longer be allowed, and changing ICE servers will not cause pooled
424 // sessions to be recreated.
425 //
426 // Expected to be called when SetLocalDescription is called on a
427 // PeerConnection. Can be called safely on any thread as long as not
428 // simultaneously with SetConfiguration.
429 void FreezeCandidatePool();
430
431 // Discard any remaining pooled sessions.
432 void DiscardCandidatePool();
433
Qingsi Wang7627fdd2019-08-19 16:07:40 -0700434 // Clears the address and the related address fields of a local candidate to
435 // avoid IP leakage. This is applicable in several scenarios:
436 // 1. Sanitization is configured via the candidate filter.
437 // 2. Sanitization is configured via the port allocator flags.
438 // 3. mDNS concealment of private IPs is enabled.
439 Candidate SanitizeCandidate(const Candidate& c) const;
440
Qingsi Wanga2d60672018-04-11 16:57:45 -0700441 uint32_t flags() const {
442 CheckRunOnValidThreadIfInitialized();
443 return flags_;
444 }
445
446 void set_flags(uint32_t flags) {
447 CheckRunOnValidThreadIfInitialized();
448 flags_ = flags;
449 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000450
deadbeeff137e972017-03-23 15:45:49 -0700451 // These three methods are deprecated. If connections need to go through a
452 // proxy, the application should create a BasicPortAllocator given a custom
453 // PacketSocketFactory that creates proxy sockets.
Qingsi Wanga2d60672018-04-11 16:57:45 -0700454 const std::string& user_agent() const {
455 CheckRunOnValidThreadIfInitialized();
456 return agent_;
457 }
458
459 const rtc::ProxyInfo& proxy() const {
460 CheckRunOnValidThreadIfInitialized();
461 return proxy_;
462 }
463
deadbeeff137e972017-03-23 15:45:49 -0700464 void set_proxy(const std::string& agent, const rtc::ProxyInfo& proxy) {
Qingsi Wanga2d60672018-04-11 16:57:45 -0700465 CheckRunOnValidThreadIfInitialized();
deadbeeff137e972017-03-23 15:45:49 -0700466 agent_ = agent;
467 proxy_ = proxy;
468 }
469
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000470 // Gets/Sets the port range to use when choosing client ports.
Qingsi Wanga2d60672018-04-11 16:57:45 -0700471 int min_port() const {
472 CheckRunOnValidThreadIfInitialized();
473 return min_port_;
474 }
475
476 int max_port() const {
477 CheckRunOnValidThreadIfInitialized();
478 return max_port_;
479 }
480
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000481 bool SetPortRange(int min_port, int max_port) {
Qingsi Wanga2d60672018-04-11 16:57:45 -0700482 CheckRunOnValidThreadIfInitialized();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000483 if (min_port > max_port) {
484 return false;
485 }
486
487 min_port_ = min_port;
488 max_port_ = max_port;
489 return true;
490 }
491
deadbeef3427f532017-07-26 16:09:33 -0700492 // Can be used to change the default numer of IPv6 network interfaces used
493 // (5). Can set to INT_MAX to effectively disable the limit.
494 //
495 // TODO(deadbeef): Applications shouldn't have to arbitrarily limit the
496 // number of available IPv6 network interfaces just because they could slow
497 // ICE down. We should work on making our ICE logic smarter (for example,
498 // prioritizing pinging connections that are most likely to work) so that
499 // every network interface can be used without impacting ICE's speed.
Qingsi Wanga2d60672018-04-11 16:57:45 -0700500 void set_max_ipv6_networks(int networks) {
501 CheckRunOnValidThreadIfInitialized();
502 max_ipv6_networks_ = networks;
503 }
504
505 int max_ipv6_networks() {
506 CheckRunOnValidThreadIfInitialized();
507 return max_ipv6_networks_;
508 }
deadbeef3427f532017-07-26 16:09:33 -0700509
deadbeef1c5e6d02017-09-15 17:46:56 -0700510 // Delay between different candidate gathering phases (UDP, TURN, TCP).
511 // Defaults to 1 second, but PeerConnection sets it to 50ms.
512 // TODO(deadbeef): Get rid of this. Its purpose is to avoid sending too many
513 // STUN transactions at once, but that's already happening if you configure
514 // multiple STUN servers or have multiple network interfaces. We should
515 // implement some global pacing logic instead if that's our goal.
Qingsi Wanga2d60672018-04-11 16:57:45 -0700516 uint32_t step_delay() const {
517 CheckRunOnValidThreadIfInitialized();
518 return step_delay_;
519 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000520
Qingsi Wanga2d60672018-04-11 16:57:45 -0700521 void set_step_delay(uint32_t delay) {
522 CheckRunOnValidThreadIfInitialized();
523 step_delay_ = delay;
524 }
525
526 bool allow_tcp_listen() const {
527 CheckRunOnValidThreadIfInitialized();
528 return allow_tcp_listen_;
529 }
530
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000531 void set_allow_tcp_listen(bool allow_tcp_listen) {
Qingsi Wanga2d60672018-04-11 16:57:45 -0700532 CheckRunOnValidThreadIfInitialized();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000533 allow_tcp_listen_ = allow_tcp_listen;
534 }
535
Qingsi Wanga2d60672018-04-11 16:57:45 -0700536 uint32_t candidate_filter() {
537 CheckRunOnValidThreadIfInitialized();
538 return candidate_filter_;
539 }
540
Qingsi Wangc129c352019-04-18 10:41:58 -0700541 // The new filter value will be populated to future allocation sessions, when
542 // they are created via CreateSession, and also pooled sessions when one is
543 // taken via TakePooledSession.
544 //
545 // A change in the candidate filter also fires a signal
546 // |SignalCandidateFilterChanged|, so that objects subscribed to this signal
547 // can, for example, update the candidate filter for sessions created by this
548 // allocator and already taken by the object.
549 //
550 // Specifically for the session taken by the ICE transport, we currently do
551 // not support removing candidate pairs formed with local candidates from this
552 // session that are disabled by the new candidate filter.
553 void SetCandidateFilter(uint32_t filter);
554 // Deprecated.
555 // TODO(qingsi): Remove this after Chromium migrates to the new method.
556 void set_candidate_filter(uint32_t filter) { SetCandidateFilter(filter); }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000557
Qingsi Wanga2d60672018-04-11 16:57:45 -0700558 bool prune_turn_ports() const {
559 CheckRunOnValidThreadIfInitialized();
560 return prune_turn_ports_;
561 }
Honghai Zhangb9e7b4a2016-06-30 20:52:02 -0700562
pthatcher@webrtc.org0ba15332015-01-10 00:47:02 +0000563 // Gets/Sets the Origin value used for WebRTC STUN requests.
Qingsi Wanga2d60672018-04-11 16:57:45 -0700564 const std::string& origin() const {
565 CheckRunOnValidThreadIfInitialized();
566 return origin_;
567 }
568
569 void set_origin(const std::string& origin) {
570 CheckRunOnValidThreadIfInitialized();
571 origin_ = origin;
572 }
pthatcher@webrtc.org0ba15332015-01-10 00:47:02 +0000573
Jonas Orelandbdcee282017-10-10 14:01:40 +0200574 webrtc::TurnCustomizer* turn_customizer() {
Qingsi Wanga2d60672018-04-11 16:57:45 -0700575 CheckRunOnValidThreadIfInitialized();
Jonas Orelandbdcee282017-10-10 14:01:40 +0200576 return turn_customizer_;
577 }
578
Qingsi Wang72a43a12018-02-20 16:03:18 -0800579 // Collect candidate stats from pooled allocator sessions. This can be used to
580 // collect candidate stats without creating an offer/answer or setting local
581 // description. After the local description is set, the ownership of the
582 // pooled session is taken by P2PTransportChannel, and the
583 // candidate stats can be collected from P2PTransportChannel::GetStats.
584 virtual void GetCandidateStatsFromPooledSessions(
585 CandidateStatsList* candidate_stats_list);
586
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200587 // Return IceParameters of the pooled sessions.
588 std::vector<IceParameters> GetPooledIceCredentials();
589
Qingsi Wangc129c352019-04-18 10:41:58 -0700590 // Fired when |candidate_filter_| changes.
591 sigslot::signal2<uint32_t /* prev_filter */, uint32_t /* cur_filter */>
592 SignalCandidateFilterChanged;
593
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000594 protected:
595 virtual PortAllocatorSession* CreateSessionInternal(
596 const std::string& content_name,
597 int component,
598 const std::string& ice_ufrag,
599 const std::string& ice_pwd) = 0;
600
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200601 const std::vector<std::unique_ptr<PortAllocatorSession>>& pooled_sessions() {
Honghai Zhangd93f50c2016-10-05 11:47:22 -0700602 return pooled_sessions_;
603 }
604
Qingsi Wang7627fdd2019-08-19 16:07:40 -0700605 // Returns true if there is an mDNS responder attached to the network manager.
606 virtual bool MdnsObfuscationEnabled() const { return false; }
607
Qingsi Wanga2d60672018-04-11 16:57:45 -0700608 // The following thread checks are only done in DCHECK for the consistency
609 // with the exsiting thread checks.
610 void CheckRunOnValidThreadIfInitialized() const {
Sebastian Janssonc01367d2019-04-08 15:20:44 +0200611 RTC_DCHECK(!initialized_ || thread_checker_.IsCurrent());
Qingsi Wanga2d60672018-04-11 16:57:45 -0700612 }
613
614 void CheckRunOnValidThreadAndInitialized() const {
Sebastian Janssonc01367d2019-04-08 15:20:44 +0200615 RTC_DCHECK(initialized_ && thread_checker_.IsCurrent());
Qingsi Wanga2d60672018-04-11 16:57:45 -0700616 }
617
618 bool initialized_ = false;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200619 uint32_t flags_;
deadbeeff137e972017-03-23 15:45:49 -0700620 std::string agent_;
621 rtc::ProxyInfo proxy_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000622 int min_port_;
623 int max_port_;
deadbeef3427f532017-07-26 16:09:33 -0700624 int max_ipv6_networks_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200625 uint32_t step_delay_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000626 bool allow_tcp_listen_;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200627 uint32_t candidate_filter_;
pthatcher@webrtc.org0ba15332015-01-10 00:47:02 +0000628 std::string origin_;
Qingsi Wanga2d60672018-04-11 16:57:45 -0700629 rtc::ThreadChecker thread_checker_;
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700630
631 private:
632 ServerAddresses stun_servers_;
633 std::vector<RelayServerConfig> turn_servers_;
deadbeef6de92f92016-12-12 18:49:32 -0800634 int candidate_pool_size_ = 0; // Last value passed into SetConfiguration.
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200635 std::vector<std::unique_ptr<PortAllocatorSession>> pooled_sessions_;
deadbeef42a42632017-03-10 15:18:00 -0800636 bool candidate_pool_frozen_ = false;
Honghai Zhangb9e7b4a2016-06-30 20:52:02 -0700637 bool prune_turn_ports_ = false;
Honghai Zhangd93f50c2016-10-05 11:47:22 -0700638
Jonas Orelandbdcee282017-10-10 14:01:40 +0200639 // Customizer for TURN messages.
640 // The instance is owned by application and will be shared among
641 // all TurnPort(s) created.
642 webrtc::TurnCustomizer* turn_customizer_ = nullptr;
Qingsi Wangdb53f8e2018-02-20 14:45:49 -0800643
Danil Chapovalov00c71832018-06-15 15:58:38 +0200644 absl::optional<int> stun_candidate_keepalive_interval_;
Jonas Oreland1cd39fa2018-10-11 07:47:12 +0200645
646 // If true, TakePooledSession() will only return sessions that has same ice
647 // credentials as requested.
648 bool restrict_ice_credentials_change_ = false;
649
650 // Returns iterator to pooled session with specified ice_credentials or first
651 // if ice_credentials is nullptr.
652 std::vector<std::unique_ptr<PortAllocatorSession>>::const_iterator
653 FindPooledSession(const IceParameters* ice_credentials = nullptr) const;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000654};
655
656} // namespace cricket
657
Steve Anton10542f22019-01-11 09:11:00 -0800658#endif // P2P_BASE_PORT_ALLOCATOR_H_