henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 1 | /* |
| 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 Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 11 | #ifndef P2P_BASE_PORT_ALLOCATOR_H_ |
| 12 | #define P2P_BASE_PORT_ALLOCATOR_H_ |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 13 | |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 14 | #include <deque> |
| 15 | #include <memory> |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 16 | #include <string> |
| 17 | #include <vector> |
| 18 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 19 | #include "p2p/base/port.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 20 | #include "p2p/base/port_interface.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 21 | #include "rtc_base/helpers.h" |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 22 | #include "rtc_base/proxy_info.h" |
| 23 | #include "rtc_base/ssl_certificate.h" |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 24 | #include "rtc_base/system/rtc_export.h" |
Artem Titov | e41c433 | 2018-07-25 15:04:28 +0200 | [diff] [blame] | 25 | #include "rtc_base/third_party/sigslot/sigslot.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 26 | #include "rtc_base/thread.h" |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 27 | #include "rtc_base/thread_checker.h" |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 28 | |
Honghai Zhang | d93f50c | 2016-10-05 11:47:22 -0700 | [diff] [blame] | 29 | namespace webrtc { |
Jonas Oreland | bdcee28 | 2017-10-10 14:01:40 +0200 | [diff] [blame] | 30 | class TurnCustomizer; |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 31 | } // namespace webrtc |
Honghai Zhang | d93f50c | 2016-10-05 11:47:22 -0700 | [diff] [blame] | 32 | |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 33 | namespace 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 | |
| 41 | enum { |
Guo-wei Shieh | 13d35f6 | 2015-08-26 15:32:56 -0700 | [diff] [blame] | 42 | // Disable local UDP ports. This doesn't impact how we connect to relay |
| 43 | // servers. |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 44 | PORTALLOCATOR_DISABLE_UDP = 0x01, |
| 45 | PORTALLOCATOR_DISABLE_STUN = 0x02, |
| 46 | PORTALLOCATOR_DISABLE_RELAY = 0x04, |
Guo-wei Shieh | 13d35f6 | 2015-08-26 15:32:56 -0700 | [diff] [blame] | 47 | // Disable local TCP ports. This doesn't impact how we connect to relay |
| 48 | // servers. |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 49 | PORTALLOCATOR_DISABLE_TCP = 0x08, |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 50 | PORTALLOCATOR_ENABLE_IPV6 = 0x40, |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 51 | PORTALLOCATOR_ENABLE_SHARED_SOCKET = 0x100, |
| 52 | PORTALLOCATOR_ENABLE_STUN_RETRANSMIT_ATTRIBUTE = 0x200, |
Guo-wei Shieh | 9af97f8 | 2015-11-10 14:47:39 -0800 | [diff] [blame] | 53 | // 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.org | f358aea | 2015-02-18 18:44:01 +0000 | [diff] [blame] | 56 | PORTALLOCATOR_DISABLE_ADAPTER_ENUMERATION = 0x400, |
Guo-wei Shieh | 9af97f8 | 2015-11-10 14:47:39 -0800 | [diff] [blame] | 57 | // 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 Shieh | 13d35f6 | 2015-08-26 15:32:56 -0700 | [diff] [blame] | 61 | // 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, |
honghaiz | 6034705 | 2016-05-31 18:29:12 -0700 | [diff] [blame] | 64 | |
| 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, |
zhihuang | b09b3f9 | 2017-03-07 14:40:51 -0800 | [diff] [blame] | 74 | |
| 75 | // When specified, do not collect IPv6 ICE candidates on Wi-Fi. |
| 76 | PORTALLOCATOR_ENABLE_IPV6_ON_WIFI = 0x4000, |
deadbeef | 1ee2125 | 2017-06-13 15:49:45 -0700 | [diff] [blame] | 77 | |
Mirko Bonadei | 5f4d47b | 2018-08-22 17:41:22 +0000 | [diff] [blame] | 78 | // 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 Wang | efbcb31 | 2018-08-21 23:23:26 +0000 | [diff] [blame] | 85 | PORTALLOCATOR_ENABLE_ANY_ADDRESS_PORTS = 0x8000, |
| 86 | |
Daniel Lazarenko | 2870b0a | 2018-01-25 10:30:22 +0100 | [diff] [blame] | 87 | // Exclude link-local network interfaces |
| 88 | // from considertaion after adapter enumeration. |
Qingsi Wang | efbcb31 | 2018-08-21 23:23:26 +0000 | [diff] [blame] | 89 | PORTALLOCATOR_DISABLE_LINK_LOCAL_NETWORKS = 0x10000, |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 90 | }; |
| 91 | |
Honghai Zhang | d93f50c | 2016-10-05 11:47:22 -0700 | [diff] [blame] | 92 | // Defines various reasons that have caused ICE regathering. |
Steve Anton | 300bf8e | 2017-07-14 10:13:10 -0700 | [diff] [blame] | 93 | enum 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 Zhang | d93f50c | 2016-10-05 11:47:22 -0700 | [diff] [blame] | 99 | |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 100 | const uint32_t kDefaultPortAllocatorFlags = 0; |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 101 | |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 102 | const uint32_t kDefaultStepDelay = 1000; // 1 sec step delay. |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 103 | // 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öm | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 105 | const uint32_t kMinimumStepDelay = 50; |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 106 | |
deadbeef | 3427f53 | 2017-07-26 16:09:33 -0700 | [diff] [blame] | 107 | // 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(). |
| 111 | constexpr int kDefaultMaxIPv6Networks = 5; |
| 112 | |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 113 | // CF = CANDIDATE FILTER |
Oleh Prypin | fd7df98 | 2017-12-21 16:25:19 +0100 | [diff] [blame] | 114 | enum : uint32_t { |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 115 | CF_NONE = 0x0, |
| 116 | CF_HOST = 0x1, |
| 117 | CF_REFLEXIVE = 0x2, |
| 118 | CF_RELAY = 0x4, |
| 119 | CF_ALL = 0x7, |
| 120 | }; |
| 121 | |
Sergey Silkin | 9c147dd | 2018-09-12 10:45:38 +0000 | [diff] [blame] | 122 | // TLS certificate policy. |
| 123 | enum 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 | |
deadbeef | 653b8e0 | 2015-11-11 12:55:10 -0800 | [diff] [blame] | 133 | // TODO(deadbeef): Rename to TurnCredentials (and username to ufrag). |
| 134 | struct RelayCredentials { |
| 135 | RelayCredentials() {} |
| 136 | RelayCredentials(const std::string& username, const std::string& password) |
| 137 | : username(username), password(password) {} |
| 138 | |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 139 | 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 | |
deadbeef | 653b8e0 | 2015-11-11 12:55:10 -0800 | [diff] [blame] | 144 | std::string username; |
| 145 | std::string password; |
| 146 | }; |
| 147 | |
| 148 | typedef std::vector<ProtocolAddress> PortList; |
| 149 | // TODO(deadbeef): Rename to TurnServerConfig. |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 150 | struct RTC_EXPORT RelayServerConfig { |
Steve Anton | 6c38cc7 | 2017-11-29 10:25:58 -0800 | [diff] [blame] | 151 | explicit RelayServerConfig(RelayType type); |
Emad Omara | dab1d2d | 2017-06-16 15:43:11 -0700 | [diff] [blame] | 152 | RelayServerConfig(const rtc::SocketAddress& address, |
| 153 | const std::string& username, |
| 154 | const std::string& password, |
Steve Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 155 | ProtocolType proto); |
Taylor Brandstetter | 0c7e9f5 | 2015-12-29 14:14:52 -0800 | [diff] [blame] | 156 | RelayServerConfig(const std::string& address, |
| 157 | int port, |
| 158 | const std::string& username, |
| 159 | const std::string& password, |
Steve Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 160 | ProtocolType proto); |
hnsl | 277b250 | 2016-12-13 05:17:23 -0800 | [diff] [blame] | 161 | // 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 Brandstetter | 0c7e9f5 | 2015-12-29 14:14:52 -0800 | [diff] [blame] | 166 | ProtocolType proto, |
Steve Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 167 | bool secure); |
| 168 | RelayServerConfig(const RelayServerConfig&); |
| 169 | ~RelayServerConfig(); |
Taylor Brandstetter | 0c7e9f5 | 2015-12-29 14:14:52 -0800 | [diff] [blame] | 170 | |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 171 | 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 | |
deadbeef | 653b8e0 | 2015-11-11 12:55:10 -0800 | [diff] [blame] | 177 | RelayType type; |
| 178 | PortList ports; |
| 179 | RelayCredentials credentials; |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 180 | int priority = 0; |
hnsl | 0483362 | 2017-01-09 08:35:45 -0800 | [diff] [blame] | 181 | TlsCertPolicy tls_cert_policy = TlsCertPolicy::TLS_CERT_POLICY_SECURE; |
Diogo Real | 1dca9d5 | 2017-08-29 12:18:32 -0700 | [diff] [blame] | 182 | std::vector<std::string> tls_alpn_protocols; |
Diogo Real | 7bd1f1b | 2017-09-08 12:50:41 -0700 | [diff] [blame] | 183 | std::vector<std::string> tls_elliptic_curves; |
Benjamin Wright | d6f86e8 | 2018-05-08 13:12:25 -0700 | [diff] [blame] | 184 | rtc::SSLCertificateVerifier* tls_cert_verifier = nullptr; |
Jonas Oreland | 3c02842 | 2019-08-22 16:16:35 +0200 | [diff] [blame^] | 185 | std::string turn_logging_id; |
deadbeef | 653b8e0 | 2015-11-11 12:55:10 -0800 | [diff] [blame] | 186 | }; |
| 187 | |
Mirko Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 188 | class RTC_EXPORT PortAllocatorSession : public sigslot::has_slots<> { |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 189 | public: |
| 190 | // Content name passed in mostly for logging and debugging. |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 191 | PortAllocatorSession(const std::string& content_name, |
| 192 | int component, |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 193 | const std::string& ice_ufrag, |
| 194 | const std::string& ice_pwd, |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 195 | uint32_t flags); |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 196 | |
| 197 | // Subclasses should clean up any ports created. |
Steve Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 198 | ~PortAllocatorSession() override; |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 199 | |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 200 | uint32_t flags() const { return flags_; } |
| 201 | void set_flags(uint32_t flags) { flags_ = flags; } |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 202 | std::string content_name() const { return content_name_; } |
| 203 | int component() const { return component_; } |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 204 | const std::string& ice_ufrag() const { return ice_ufrag_; } |
| 205 | const std::string& ice_pwd() const { return ice_pwd_; } |
Jonas Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 206 | bool pooled() const { return pooled_; } |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 207 | |
Taylor Brandstetter | 417eebe | 2016-05-23 16:02:19 -0700 | [diff] [blame] | 208 | // 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 | |
deadbeef | b60a819 | 2016-08-24 15:15:00 -0700 | [diff] [blame] | 215 | // Starts gathering ports and ICE candidates. |
Honghai Zhang | d8f6fc4 | 2016-07-01 17:31:12 -0700 | [diff] [blame] | 216 | virtual void StartGettingPorts() = 0; |
deadbeef | b60a819 | 2016-08-24 15:15:00 -0700 | [diff] [blame] | 217 | // Completely stops gathering. Will not gather again unless StartGettingPorts |
| 218 | // is called again. |
Honghai Zhang | d8f6fc4 | 2016-07-01 17:31:12 -0700 | [diff] [blame] | 219 | virtual void StopGettingPorts() = 0; |
Honghai Zhang | 5622c5e | 2016-07-01 13:59:29 -0700 | [diff] [blame] | 220 | // Whether the session is actively getting ports. |
Honghai Zhang | d8f6fc4 | 2016-07-01 17:31:12 -0700 | [diff] [blame] | 221 | virtual bool IsGettingPorts() = 0; |
deadbeef | b60a819 | 2016-08-24 15:15:00 -0700 | [diff] [blame] | 222 | |
| 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 Zhang | d8f6fc4 | 2016-07-01 17:31:12 -0700 | [diff] [blame] | 231 | virtual void ClearGettingPorts() = 0; |
Honghai Zhang | 5622c5e | 2016-07-01 13:59:29 -0700 | [diff] [blame] | 232 | // 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 Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 234 | virtual bool IsCleared() const; |
Honghai Zhang | 5622c5e | 2016-07-01 13:59:29 -0700 | [diff] [blame] | 235 | // Whether the session has completely stopped. |
Steve Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 236 | virtual bool IsStopped() const; |
Honghai Zhang | 5622c5e | 2016-07-01 13:59:29 -0700 | [diff] [blame] | 237 | // 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 Zhang | 5622c5e | 2016-07-01 13:59:29 -0700 | [diff] [blame] | 244 | virtual void RegatherOnAllNetworks() {} |
Qingsi Wang | 72a43a1 | 2018-02-20 16:03:18 -0800 | [diff] [blame] | 245 | // 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 Wang | 7627fdd | 2019-08-19 16:07:40 -0700 | [diff] [blame] | 248 | CandidateStatsList* candidate_stats_list) const {} |
Qingsi Wang | db53f8e | 2018-02-20 14:45:49 -0800 | [diff] [blame] | 249 | // 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 Chapovalov | 00c7183 | 2018-06-15 15:58:38 +0200 | [diff] [blame] | 254 | const absl::optional<int>& stun_keepalive_interval) {} |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 255 | // 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 Zhang | a74363c | 2016-07-28 18:06:15 -0700 | [diff] [blame] | 262 | // 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 Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 265 | |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 266 | sigslot::signal2<PortAllocatorSession*, PortInterface*> SignalPortReady; |
Honghai Zhang | 8eeecab | 2016-07-28 13:20:15 -0700 | [diff] [blame] | 267 | // 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 Zhang | 5622c5e | 2016-07-01 13:59:29 -0700 | [diff] [blame] | 271 | sigslot::signal2<PortAllocatorSession*, const std::vector<PortInterface*>&> |
Honghai Zhang | 8eeecab | 2016-07-28 13:20:15 -0700 | [diff] [blame] | 272 | SignalPortsPruned; |
Yves Gerey | 665174f | 2018-06-19 15:03:05 +0200 | [diff] [blame] | 273 | sigslot::signal2<PortAllocatorSession*, const std::vector<Candidate>&> |
| 274 | SignalCandidatesReady; |
Eldar Rello | da13ea2 | 2019-06-01 12:23:43 +0300 | [diff] [blame] | 275 | sigslot::signal2<PortAllocatorSession*, const IceCandidateErrorEvent&> |
| 276 | SignalCandidateError; |
Honghai Zhang | 5622c5e | 2016-07-01 13:59:29 -0700 | [diff] [blame] | 277 | // 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.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 281 | sigslot::signal1<PortAllocatorSession*> SignalCandidatesAllocationDone; |
| 282 | |
Honghai Zhang | d93f50c | 2016-10-05 11:47:22 -0700 | [diff] [blame] | 283 | sigslot::signal2<PortAllocatorSession*, IceRegatheringReason> |
| 284 | SignalIceRegathering; |
| 285 | |
Steve Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 286 | virtual uint32_t generation(); |
| 287 | virtual void set_generation(uint32_t generation); |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 288 | sigslot::signal1<PortAllocatorSession*> SignalDestroyed; |
| 289 | |
deadbeef | c55fb30 | 2016-05-12 12:51:38 -0700 | [diff] [blame] | 290 | protected: |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 291 | // 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 | |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 299 | // 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.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 303 | |
deadbeef | c55fb30 | 2016-05-12 12:51:38 -0700 | [diff] [blame] | 304 | private: |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 305 | 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 Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 316 | void set_pooled(bool value) { pooled_ = value; } |
| 317 | |
deadbeef | c55fb30 | 2016-05-12 12:51:38 -0700 | [diff] [blame] | 318 | uint32_t flags_; |
| 319 | uint32_t generation_; |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 320 | std::string content_name_; |
| 321 | int component_; |
deadbeef | cbecd35 | 2015-09-23 11:50:27 -0700 | [diff] [blame] | 322 | std::string ice_ufrag_; |
| 323 | std::string ice_pwd_; |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 324 | |
Jonas Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 325 | bool pooled_ = false; |
| 326 | |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 327 | // SetIceParameters is an implementation detail which only PortAllocator |
| 328 | // should be able to call. |
| 329 | friend class PortAllocator; |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 330 | }; |
| 331 | |
Taylor Brandstetter | f8e6577 | 2016-06-27 17:20:15 -0700 | [diff] [blame] | 332 | // Every method of PortAllocator (including the destructor) must be called on |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 333 | // the same thread after Initialize is called. |
Taylor Brandstetter | f8e6577 | 2016-06-27 17:20:15 -0700 | [diff] [blame] | 334 | // |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 335 | // 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 Bonadei | 3b56ee7 | 2018-10-15 17:15:12 +0200 | [diff] [blame] | 337 | class RTC_EXPORT PortAllocator : public sigslot::has_slots<> { |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 338 | public: |
Steve Anton | 7995d8c | 2017-10-30 16:23:38 -0700 | [diff] [blame] | 339 | PortAllocator(); |
| 340 | ~PortAllocator() override; |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 341 | |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 342 | // This MUST be called on the PortAllocator's thread after finishing |
| 343 | // constructing and configuring the PortAllocator subclasses. |
| 344 | virtual void Initialize(); |
Taylor Brandstetter | f8e6577 | 2016-06-27 17:20:15 -0700 | [diff] [blame] | 345 | |
Jonas Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 346 | // 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 Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 351 | // Set STUN and TURN servers to be used in future sessions, and set |
| 352 | // candidate pool size, as described in JSEP. |
| 353 | // |
deadbeef | 42a4263 | 2017-03-10 15:18:00 -0800 | [diff] [blame] | 354 | // 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 Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 357 | // |
deadbeef | 42a4263 | 2017-03-10 15:18:00 -0800 | [diff] [blame] | 358 | // 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. |
deadbeef | 6de92f9 | 2016-12-12 18:49:32 -0800 | [diff] [blame] | 361 | // |
| 362 | // Returns true if the configuration could successfully be changed. |
| 363 | bool SetConfiguration(const ServerAddresses& stun_servers, |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 364 | const std::vector<RelayServerConfig>& turn_servers, |
Honghai Zhang | b9e7b4a | 2016-06-30 20:52:02 -0700 | [diff] [blame] | 365 | int candidate_pool_size, |
Jonas Oreland | bdcee28 | 2017-10-10 14:01:40 +0200 | [diff] [blame] | 366 | bool prune_turn_ports, |
Qingsi Wang | db53f8e | 2018-02-20 14:45:49 -0800 | [diff] [blame] | 367 | webrtc::TurnCustomizer* turn_customizer = nullptr, |
Danil Chapovalov | 00c7183 | 2018-06-15 15:58:38 +0200 | [diff] [blame] | 368 | const absl::optional<int>& |
| 369 | stun_candidate_keepalive_interval = absl::nullopt); |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 370 | |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 371 | const ServerAddresses& stun_servers() const { |
| 372 | CheckRunOnValidThreadIfInitialized(); |
| 373 | return stun_servers_; |
| 374 | } |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 375 | |
| 376 | const std::vector<RelayServerConfig>& turn_servers() const { |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 377 | CheckRunOnValidThreadIfInitialized(); |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 378 | return turn_servers_; |
| 379 | } |
| 380 | |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 381 | int candidate_pool_size() const { |
| 382 | CheckRunOnValidThreadIfInitialized(); |
| 383 | return candidate_pool_size_; |
| 384 | } |
| 385 | |
Danil Chapovalov | 00c7183 | 2018-06-15 15:58:38 +0200 | [diff] [blame] | 386 | const absl::optional<int>& stun_candidate_keepalive_interval() const { |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 387 | CheckRunOnValidThreadIfInitialized(); |
Qingsi Wang | db53f8e | 2018-02-20 14:45:49 -0800 | [diff] [blame] | 388 | return stun_candidate_keepalive_interval_; |
| 389 | } |
deadbeef | 653b8e0 | 2015-11-11 12:55:10 -0800 | [diff] [blame] | 390 | |
Taylor Brandstetter | 0c7e9f5 | 2015-12-29 14:14:52 -0800 | [diff] [blame] | 391 | // 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 Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 398 | std::unique_ptr<PortAllocatorSession> CreateSession( |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 399 | const std::string& content_name, |
| 400 | int component, |
| 401 | const std::string& ice_ufrag, |
| 402 | const std::string& ice_pwd); |
| 403 | |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 404 | // Get an available pooled session and set the transport information on it. |
| 405 | // |
| 406 | // Caller takes ownership of the returned session. |
| 407 | // |
Jonas Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 408 | // If restrict_ice_credentials_change is TRUE, then it will only |
| 409 | // return a pooled session with matching ice credentials. |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 410 | // 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 Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 417 | // 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 Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 421 | |
deadbeef | 42a4263 | 2017-03-10 15:18:00 -0800 | [diff] [blame] | 422 | // 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 Wang | 7627fdd | 2019-08-19 16:07:40 -0700 | [diff] [blame] | 434 | // 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 Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 441 | 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.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 450 | |
deadbeef | f137e97 | 2017-03-23 15:45:49 -0700 | [diff] [blame] | 451 | // 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 Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 454 | 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 | |
deadbeef | f137e97 | 2017-03-23 15:45:49 -0700 | [diff] [blame] | 464 | void set_proxy(const std::string& agent, const rtc::ProxyInfo& proxy) { |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 465 | CheckRunOnValidThreadIfInitialized(); |
deadbeef | f137e97 | 2017-03-23 15:45:49 -0700 | [diff] [blame] | 466 | agent_ = agent; |
| 467 | proxy_ = proxy; |
| 468 | } |
| 469 | |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 470 | // Gets/Sets the port range to use when choosing client ports. |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 471 | 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.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 481 | bool SetPortRange(int min_port, int max_port) { |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 482 | CheckRunOnValidThreadIfInitialized(); |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 483 | 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 | |
deadbeef | 3427f53 | 2017-07-26 16:09:33 -0700 | [diff] [blame] | 492 | // 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 Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 500 | 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 | } |
deadbeef | 3427f53 | 2017-07-26 16:09:33 -0700 | [diff] [blame] | 509 | |
deadbeef | 1c5e6d0 | 2017-09-15 17:46:56 -0700 | [diff] [blame] | 510 | // 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 Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 516 | uint32_t step_delay() const { |
| 517 | CheckRunOnValidThreadIfInitialized(); |
| 518 | return step_delay_; |
| 519 | } |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 520 | |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 521 | 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.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 531 | void set_allow_tcp_listen(bool allow_tcp_listen) { |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 532 | CheckRunOnValidThreadIfInitialized(); |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 533 | allow_tcp_listen_ = allow_tcp_listen; |
| 534 | } |
| 535 | |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 536 | uint32_t candidate_filter() { |
| 537 | CheckRunOnValidThreadIfInitialized(); |
| 538 | return candidate_filter_; |
| 539 | } |
| 540 | |
Qingsi Wang | c129c35 | 2019-04-18 10:41:58 -0700 | [diff] [blame] | 541 | // 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.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 557 | |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 558 | bool prune_turn_ports() const { |
| 559 | CheckRunOnValidThreadIfInitialized(); |
| 560 | return prune_turn_ports_; |
| 561 | } |
Honghai Zhang | b9e7b4a | 2016-06-30 20:52:02 -0700 | [diff] [blame] | 562 | |
pthatcher@webrtc.org | 0ba1533 | 2015-01-10 00:47:02 +0000 | [diff] [blame] | 563 | // Gets/Sets the Origin value used for WebRTC STUN requests. |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 564 | 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.org | 0ba1533 | 2015-01-10 00:47:02 +0000 | [diff] [blame] | 573 | |
Jonas Oreland | bdcee28 | 2017-10-10 14:01:40 +0200 | [diff] [blame] | 574 | webrtc::TurnCustomizer* turn_customizer() { |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 575 | CheckRunOnValidThreadIfInitialized(); |
Jonas Oreland | bdcee28 | 2017-10-10 14:01:40 +0200 | [diff] [blame] | 576 | return turn_customizer_; |
| 577 | } |
| 578 | |
Qingsi Wang | 72a43a1 | 2018-02-20 16:03:18 -0800 | [diff] [blame] | 579 | // 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 Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 587 | // Return IceParameters of the pooled sessions. |
| 588 | std::vector<IceParameters> GetPooledIceCredentials(); |
| 589 | |
Qingsi Wang | c129c35 | 2019-04-18 10:41:58 -0700 | [diff] [blame] | 590 | // Fired when |candidate_filter_| changes. |
| 591 | sigslot::signal2<uint32_t /* prev_filter */, uint32_t /* cur_filter */> |
| 592 | SignalCandidateFilterChanged; |
| 593 | |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 594 | 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 Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 601 | const std::vector<std::unique_ptr<PortAllocatorSession>>& pooled_sessions() { |
Honghai Zhang | d93f50c | 2016-10-05 11:47:22 -0700 | [diff] [blame] | 602 | return pooled_sessions_; |
| 603 | } |
| 604 | |
Qingsi Wang | 7627fdd | 2019-08-19 16:07:40 -0700 | [diff] [blame] | 605 | // Returns true if there is an mDNS responder attached to the network manager. |
| 606 | virtual bool MdnsObfuscationEnabled() const { return false; } |
| 607 | |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 608 | // The following thread checks are only done in DCHECK for the consistency |
| 609 | // with the exsiting thread checks. |
| 610 | void CheckRunOnValidThreadIfInitialized() const { |
Sebastian Jansson | c01367d | 2019-04-08 15:20:44 +0200 | [diff] [blame] | 611 | RTC_DCHECK(!initialized_ || thread_checker_.IsCurrent()); |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 612 | } |
| 613 | |
| 614 | void CheckRunOnValidThreadAndInitialized() const { |
Sebastian Jansson | c01367d | 2019-04-08 15:20:44 +0200 | [diff] [blame] | 615 | RTC_DCHECK(initialized_ && thread_checker_.IsCurrent()); |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 616 | } |
| 617 | |
| 618 | bool initialized_ = false; |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 619 | uint32_t flags_; |
deadbeef | f137e97 | 2017-03-23 15:45:49 -0700 | [diff] [blame] | 620 | std::string agent_; |
| 621 | rtc::ProxyInfo proxy_; |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 622 | int min_port_; |
| 623 | int max_port_; |
deadbeef | 3427f53 | 2017-07-26 16:09:33 -0700 | [diff] [blame] | 624 | int max_ipv6_networks_; |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 625 | uint32_t step_delay_; |
henrike@webrtc.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 626 | bool allow_tcp_listen_; |
Peter Boström | 0c4e06b | 2015-10-07 12:23:21 +0200 | [diff] [blame] | 627 | uint32_t candidate_filter_; |
pthatcher@webrtc.org | 0ba1533 | 2015-01-10 00:47:02 +0000 | [diff] [blame] | 628 | std::string origin_; |
Qingsi Wang | a2d6067 | 2018-04-11 16:57:45 -0700 | [diff] [blame] | 629 | rtc::ThreadChecker thread_checker_; |
Taylor Brandstetter | a1c3035 | 2016-05-13 08:15:11 -0700 | [diff] [blame] | 630 | |
| 631 | private: |
| 632 | ServerAddresses stun_servers_; |
| 633 | std::vector<RelayServerConfig> turn_servers_; |
deadbeef | 6de92f9 | 2016-12-12 18:49:32 -0800 | [diff] [blame] | 634 | int candidate_pool_size_ = 0; // Last value passed into SetConfiguration. |
Jonas Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 635 | std::vector<std::unique_ptr<PortAllocatorSession>> pooled_sessions_; |
deadbeef | 42a4263 | 2017-03-10 15:18:00 -0800 | [diff] [blame] | 636 | bool candidate_pool_frozen_ = false; |
Honghai Zhang | b9e7b4a | 2016-06-30 20:52:02 -0700 | [diff] [blame] | 637 | bool prune_turn_ports_ = false; |
Honghai Zhang | d93f50c | 2016-10-05 11:47:22 -0700 | [diff] [blame] | 638 | |
Jonas Oreland | bdcee28 | 2017-10-10 14:01:40 +0200 | [diff] [blame] | 639 | // 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 Wang | db53f8e | 2018-02-20 14:45:49 -0800 | [diff] [blame] | 643 | |
Danil Chapovalov | 00c7183 | 2018-06-15 15:58:38 +0200 | [diff] [blame] | 644 | absl::optional<int> stun_candidate_keepalive_interval_; |
Jonas Oreland | 1cd39fa | 2018-10-11 07:47:12 +0200 | [diff] [blame] | 645 | |
| 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.org | 269fb4b | 2014-10-28 22:20:11 +0000 | [diff] [blame] | 654 | }; |
| 655 | |
| 656 | } // namespace cricket |
| 657 | |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 658 | #endif // P2P_BASE_PORT_ALLOCATOR_H_ |