blob: 903f13d7a6ad360187efeb81f0a745d53c225e94 [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
11#include "webrtc/p2p/base/port.h"
12
13#include <algorithm>
14#include <vector>
15
16#include "webrtc/p2p/base/common.h"
17#include "webrtc/p2p/base/portallocator.h"
18#include "webrtc/base/base64.h"
19#include "webrtc/base/crc32.h"
20#include "webrtc/base/helpers.h"
21#include "webrtc/base/logging.h"
22#include "webrtc/base/messagedigest.h"
honghaize3c6c822016-02-17 13:00:28 -080023#include "webrtc/base/network.h"
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000024#include "webrtc/base/stringencode.h"
25#include "webrtc/base/stringutils.h"
26
27namespace {
28
29// Determines whether we have seen at least the given maximum number of
30// pings fail to have a response.
31inline bool TooManyFailures(
Peter Thatcher1cf6f812015-05-15 10:40:45 -070032 const std::vector<cricket::Connection::SentPing>& pings_since_last_response,
Peter Boström0c4e06b2015-10-07 12:23:21 +020033 uint32_t maximum_failures,
honghaiz34b11eb2016-03-16 08:55:44 -070034 int rtt_estimate,
35 int64_t now) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000036 // If we haven't sent that many pings, then we can't have failed that many.
37 if (pings_since_last_response.size() < maximum_failures)
38 return false;
39
40 // Check if the window in which we would expect a response to the ping has
41 // already elapsed.
honghaiz34b11eb2016-03-16 08:55:44 -070042 int64_t expected_response_time =
Peter Thatcher1cf6f812015-05-15 10:40:45 -070043 pings_since_last_response[maximum_failures - 1].sent_time + rtt_estimate;
44 return now > expected_response_time;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000045}
46
47// Determines whether we have gone too long without seeing any response.
48inline bool TooLongWithoutResponse(
Peter Thatcher1cf6f812015-05-15 10:40:45 -070049 const std::vector<cricket::Connection::SentPing>& pings_since_last_response,
honghaiz34b11eb2016-03-16 08:55:44 -070050 int64_t maximum_time,
51 int64_t now) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000052 if (pings_since_last_response.size() == 0)
53 return false;
54
Peter Thatcher1cf6f812015-05-15 10:40:45 -070055 auto first = pings_since_last_response[0];
56 return now > (first.sent_time + maximum_time);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000057}
58
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000059// We will restrict RTT estimates (when used for determining state) to be
60// within a reasonable range.
honghaiz34b11eb2016-03-16 08:55:44 -070061const int MINIMUM_RTT = 100; // 0.1 seconds
62const int MAXIMUM_RTT = 3000; // 3 seconds
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000063
64// When we don't have any RTT data, we have to pick something reasonable. We
65// use a large value just in case the connection is really slow.
honghaiz34b11eb2016-03-16 08:55:44 -070066const int DEFAULT_RTT = MAXIMUM_RTT;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000067
68// Computes our estimate of the RTT given the current estimate.
honghaiz34b11eb2016-03-16 08:55:44 -070069inline int ConservativeRTTEstimate(int rtt) {
andresp@webrtc.orgff689be2015-02-12 11:54:26 +000070 return std::max(MINIMUM_RTT, std::min(MAXIMUM_RTT, 2 * rtt));
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000071}
72
73// Weighting of the old rtt value to new data.
74const int RTT_RATIO = 3; // 3 : 1
75
76// The delay before we begin checking if this port is useless.
77const int kPortTimeoutDelay = 30 * 1000; // 30 seconds
Honghai Zhang351d77b2016-05-20 15:08:29 -070078} // namespace
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +000079
80namespace cricket {
81
82// TODO(ronghuawu): Use "host", "srflx", "prflx" and "relay". But this requires
83// the signaling part be updated correspondingly as well.
84const char LOCAL_PORT_TYPE[] = "local";
85const char STUN_PORT_TYPE[] = "stun";
86const char PRFLX_PORT_TYPE[] = "prflx";
87const char RELAY_PORT_TYPE[] = "relay";
88
89const char UDP_PROTOCOL_NAME[] = "udp";
90const char TCP_PROTOCOL_NAME[] = "tcp";
91const char SSLTCP_PROTOCOL_NAME[] = "ssltcp";
92
93static const char* const PROTO_NAMES[] = { UDP_PROTOCOL_NAME,
94 TCP_PROTOCOL_NAME,
95 SSLTCP_PROTOCOL_NAME };
96
97const char* ProtoToString(ProtocolType proto) {
98 return PROTO_NAMES[proto];
99}
100
101bool StringToProto(const char* value, ProtocolType* proto) {
102 for (size_t i = 0; i <= PROTO_LAST; ++i) {
103 if (_stricmp(PROTO_NAMES[i], value) == 0) {
104 *proto = static_cast<ProtocolType>(i);
105 return true;
106 }
107 }
108 return false;
109}
110
111// RFC 6544, TCP candidate encoding rules.
112const int DISCARD_PORT = 9;
113const char TCPTYPE_ACTIVE_STR[] = "active";
114const char TCPTYPE_PASSIVE_STR[] = "passive";
115const char TCPTYPE_SIMOPEN_STR[] = "so";
116
117// Foundation: An arbitrary string that is the same for two candidates
118// that have the same type, base IP address, protocol (UDP, TCP,
119// etc.), and STUN or TURN server. If any of these are different,
120// then the foundation will be different. Two candidate pairs with
121// the same foundation pairs are likely to have similar network
122// characteristics. Foundations are used in the frozen algorithm.
Honghai Zhang80f1db92016-01-27 11:54:45 -0800123static std::string ComputeFoundation(const std::string& type,
124 const std::string& protocol,
125 const std::string& relay_protocol,
126 const rtc::SocketAddress& base_address) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000127 std::ostringstream ost;
Honghai Zhang80f1db92016-01-27 11:54:45 -0800128 ost << type << base_address.ipaddr().ToString() << protocol << relay_protocol;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200129 return rtc::ToString<uint32_t>(rtc::ComputeCrc32(ost.str()));
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000130}
131
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000132Port::Port(rtc::Thread* thread,
Honghai Zhangd00c0572016-06-28 09:44:47 -0700133 const std::string& type,
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000134 rtc::PacketSocketFactory* factory,
135 rtc::Network* network,
136 const rtc::IPAddress& ip,
137 const std::string& username_fragment,
138 const std::string& password)
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000139 : thread_(thread),
140 factory_(factory),
Honghai Zhangd00c0572016-06-28 09:44:47 -0700141 type_(type),
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000142 send_retransmit_count_attribute_(false),
143 network_(network),
144 ip_(ip),
145 min_port_(0),
146 max_port_(0),
147 component_(ICE_CANDIDATE_COMPONENT_DEFAULT),
148 generation_(0),
149 ice_username_fragment_(username_fragment),
150 password_(password),
151 timeout_delay_(kPortTimeoutDelay),
152 enable_port_packets_(false),
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000153 ice_role_(ICEROLE_UNKNOWN),
154 tiebreaker_(0),
Taylor Brandstetter417eebe2016-05-23 16:02:19 -0700155 shared_socket_(true) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000156 Construct();
157}
158
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000159Port::Port(rtc::Thread* thread,
160 const std::string& type,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000161 rtc::PacketSocketFactory* factory,
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000162 rtc::Network* network,
163 const rtc::IPAddress& ip,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200164 uint16_t min_port,
165 uint16_t max_port,
pkasting@chromium.org332331f2014-11-06 20:19:22 +0000166 const std::string& username_fragment,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000167 const std::string& password)
168 : thread_(thread),
169 factory_(factory),
170 type_(type),
171 send_retransmit_count_attribute_(false),
172 network_(network),
173 ip_(ip),
174 min_port_(min_port),
175 max_port_(max_port),
176 component_(ICE_CANDIDATE_COMPONENT_DEFAULT),
177 generation_(0),
178 ice_username_fragment_(username_fragment),
179 password_(password),
180 timeout_delay_(kPortTimeoutDelay),
181 enable_port_packets_(false),
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000182 ice_role_(ICEROLE_UNKNOWN),
183 tiebreaker_(0),
Taylor Brandstetter417eebe2016-05-23 16:02:19 -0700184 shared_socket_(false) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000185 ASSERT(factory_ != NULL);
186 Construct();
187}
188
189void Port::Construct() {
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700190 // TODO(pthatcher): Remove this old behavior once we're sure no one
191 // relies on it. If the username_fragment and password are empty,
192 // we should just create one.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000193 if (ice_username_fragment_.empty()) {
194 ASSERT(password_.empty());
195 ice_username_fragment_ = rtc::CreateRandomString(ICE_UFRAG_LENGTH);
196 password_ = rtc::CreateRandomString(ICE_PWD_LENGTH);
197 }
Honghai Zhang351d77b2016-05-20 15:08:29 -0700198 network_->SignalTypeChanged.connect(this, &Port::OnNetworkTypeChanged);
199 network_cost_ = network_->GetCost();
honghaize1a0c942016-02-16 14:54:56 -0800200
Honghai Zhang351d77b2016-05-20 15:08:29 -0700201 LOG_J(LS_INFO, this) << "Port created with network cost " << network_cost_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000202}
203
204Port::~Port() {
205 // Delete all of the remaining connections. We copy the list up front
206 // because each deletion will cause it to be modified.
207
208 std::vector<Connection*> list;
209
210 AddressMap::iterator iter = connections_.begin();
211 while (iter != connections_.end()) {
212 list.push_back(iter->second);
213 ++iter;
214 }
215
Peter Boström0c4e06b2015-10-07 12:23:21 +0200216 for (uint32_t i = 0; i < list.size(); i++)
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000217 delete list[i];
218}
219
Taylor Brandstettera1c30352016-05-13 08:15:11 -0700220void Port::SetIceParameters(int component,
221 const std::string& username_fragment,
222 const std::string& password) {
223 component_ = component;
224 ice_username_fragment_ = username_fragment;
225 password_ = password;
226 for (Candidate& c : candidates_) {
227 c.set_component(component);
228 c.set_username(username_fragment);
229 c.set_password(password);
230 }
231}
232
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000233Connection* Port::GetConnection(const rtc::SocketAddress& remote_addr) {
234 AddressMap::const_iterator iter = connections_.find(remote_addr);
235 if (iter != connections_.end())
236 return iter->second;
237 else
238 return NULL;
239}
240
241void Port::AddAddress(const rtc::SocketAddress& address,
242 const rtc::SocketAddress& base_address,
243 const rtc::SocketAddress& related_address,
244 const std::string& protocol,
Guo-wei Shieh3d564c12015-08-19 16:51:15 -0700245 const std::string& relay_protocol,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000246 const std::string& tcptype,
247 const std::string& type,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200248 uint32_t type_preference,
249 uint32_t relay_preference,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000250 bool final) {
251 if (protocol == TCP_PROTOCOL_NAME && type == LOCAL_PORT_TYPE) {
252 ASSERT(!tcptype.empty());
253 }
254
honghaiza0c44ea2016-03-23 16:07:48 -0700255 std::string foundation =
256 ComputeFoundation(type, protocol, relay_protocol, base_address);
257 Candidate c(component_, protocol, address, 0U, username_fragment(), password_,
258 type, generation_, foundation, network_->id(), network_cost_);
259 c.set_priority(
260 c.GetPriority(type_preference, network_->preference(), relay_preference));
Guo-wei Shieh3d564c12015-08-19 16:51:15 -0700261 c.set_relay_protocol(relay_protocol);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000262 c.set_tcptype(tcptype);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000263 c.set_network_name(network_->name());
guoweis@webrtc.org950c5182014-12-16 23:01:31 +0000264 c.set_network_type(network_->type());
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000265 c.set_related_address(related_address);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000266 candidates_.push_back(c);
267 SignalCandidateReady(this, c);
268
269 if (final) {
270 SignalPortComplete(this);
271 }
272}
273
honghaiz36f50e82016-06-01 15:57:03 -0700274void Port::AddOrReplaceConnection(Connection* conn) {
275 auto ret = connections_.insert(
276 std::make_pair(conn->remote_candidate().address(), conn));
277 // If there is a different connection on the same remote address, replace
278 // it with the new one and destroy the old one.
279 if (ret.second == false && ret.first->second != conn) {
280 LOG_J(LS_WARNING, this)
281 << "A new connection was created on an existing remote address. "
282 << "New remote candidate: " << conn->remote_candidate().ToString();
283 ret.first->second->SignalDestroyed.disconnect(this);
284 ret.first->second->Destroy();
285 ret.first->second = conn;
286 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000287 conn->SignalDestroyed.connect(this, &Port::OnConnectionDestroyed);
288 SignalConnectionCreated(this, conn);
289}
290
291void Port::OnReadPacket(
292 const char* data, size_t size, const rtc::SocketAddress& addr,
293 ProtocolType proto) {
294 // If the user has enabled port packets, just hand this over.
295 if (enable_port_packets_) {
296 SignalReadPacket(this, data, size, addr);
297 return;
298 }
299
300 // If this is an authenticated STUN request, then signal unknown address and
301 // send back a proper binding response.
kwiberg3ec46792016-04-27 07:22:53 -0700302 std::unique_ptr<IceMessage> msg;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000303 std::string remote_username;
kwiberg6baec032016-03-15 11:09:39 -0700304 if (!GetStunMessage(data, size, addr, &msg, &remote_username)) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000305 LOG_J(LS_ERROR, this) << "Received non-STUN packet from unknown address ("
306 << addr.ToSensitiveString() << ")";
307 } else if (!msg) {
308 // STUN message handled already
309 } else if (msg->type() == STUN_BINDING_REQUEST) {
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700310 LOG(LS_INFO) << "Received STUN ping "
311 << " id=" << rtc::hex_encode(msg->transaction_id())
312 << " from unknown address " << addr.ToSensitiveString();
313
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000314 // Check for role conflicts.
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700315 if (!MaybeIceRoleConflict(addr, msg.get(), remote_username)) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000316 LOG(LS_INFO) << "Received conflicting role from the peer.";
317 return;
318 }
319
320 SignalUnknownAddress(this, addr, proto, msg.get(), remote_username, false);
321 } else {
322 // NOTE(tschmelcher): STUN_BINDING_RESPONSE is benign. It occurs if we
323 // pruned a connection for this port while it had STUN requests in flight,
324 // because we then get back responses for them, which this code correctly
325 // does not handle.
326 if (msg->type() != STUN_BINDING_RESPONSE) {
327 LOG_J(LS_ERROR, this) << "Received unexpected STUN message type ("
328 << msg->type() << ") from unknown address ("
329 << addr.ToSensitiveString() << ")";
330 }
331 }
332}
333
334void Port::OnReadyToSend() {
335 AddressMap::iterator iter = connections_.begin();
336 for (; iter != connections_.end(); ++iter) {
337 iter->second->OnReadyToSend();
338 }
339}
340
341size_t Port::AddPrflxCandidate(const Candidate& local) {
342 candidates_.push_back(local);
343 return (candidates_.size() - 1);
344}
345
kwiberg6baec032016-03-15 11:09:39 -0700346bool Port::GetStunMessage(const char* data,
347 size_t size,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000348 const rtc::SocketAddress& addr,
kwiberg3ec46792016-04-27 07:22:53 -0700349 std::unique_ptr<IceMessage>* out_msg,
kwiberg6baec032016-03-15 11:09:39 -0700350 std::string* out_username) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000351 // NOTE: This could clearly be optimized to avoid allocating any memory.
352 // However, at the data rates we'll be looking at on the client side,
353 // this probably isn't worth worrying about.
354 ASSERT(out_msg != NULL);
355 ASSERT(out_username != NULL);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000356 out_username->clear();
357
358 // Don't bother parsing the packet if we can tell it's not STUN.
359 // In ICE mode, all STUN packets will have a valid fingerprint.
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700360 if (!StunMessage::ValidateFingerprint(data, size)) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000361 return false;
362 }
363
364 // Parse the request message. If the packet is not a complete and correct
365 // STUN message, then ignore it.
kwiberg3ec46792016-04-27 07:22:53 -0700366 std::unique_ptr<IceMessage> stun_msg(new IceMessage());
jbauchf1f87202016-03-30 06:43:37 -0700367 rtc::ByteBufferReader buf(data, size);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000368 if (!stun_msg->Read(&buf) || (buf.Length() > 0)) {
369 return false;
370 }
371
372 if (stun_msg->type() == STUN_BINDING_REQUEST) {
373 // Check for the presence of USERNAME and MESSAGE-INTEGRITY (if ICE) first.
374 // If not present, fail with a 400 Bad Request.
375 if (!stun_msg->GetByteString(STUN_ATTR_USERNAME) ||
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700376 !stun_msg->GetByteString(STUN_ATTR_MESSAGE_INTEGRITY)) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000377 LOG_J(LS_ERROR, this) << "Received STUN request without username/M-I "
378 << "from " << addr.ToSensitiveString();
379 SendBindingErrorResponse(stun_msg.get(), addr, STUN_ERROR_BAD_REQUEST,
380 STUN_ERROR_REASON_BAD_REQUEST);
381 return true;
382 }
383
384 // If the username is bad or unknown, fail with a 401 Unauthorized.
385 std::string local_ufrag;
386 std::string remote_ufrag;
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700387 if (!ParseStunUsername(stun_msg.get(), &local_ufrag, &remote_ufrag) ||
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000388 local_ufrag != username_fragment()) {
389 LOG_J(LS_ERROR, this) << "Received STUN request with bad local username "
390 << local_ufrag << " from "
391 << addr.ToSensitiveString();
392 SendBindingErrorResponse(stun_msg.get(), addr, STUN_ERROR_UNAUTHORIZED,
393 STUN_ERROR_REASON_UNAUTHORIZED);
394 return true;
395 }
396
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000397 // If ICE, and the MESSAGE-INTEGRITY is bad, fail with a 401 Unauthorized
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700398 if (!stun_msg->ValidateMessageIntegrity(data, size, password_)) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000399 LOG_J(LS_ERROR, this) << "Received STUN request with bad M-I "
jiayl@webrtc.orgdacdd942015-01-23 17:33:34 +0000400 << "from " << addr.ToSensitiveString()
401 << ", password_=" << password_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000402 SendBindingErrorResponse(stun_msg.get(), addr, STUN_ERROR_UNAUTHORIZED,
403 STUN_ERROR_REASON_UNAUTHORIZED);
404 return true;
405 }
406 out_username->assign(remote_ufrag);
407 } else if ((stun_msg->type() == STUN_BINDING_RESPONSE) ||
408 (stun_msg->type() == STUN_BINDING_ERROR_RESPONSE)) {
409 if (stun_msg->type() == STUN_BINDING_ERROR_RESPONSE) {
410 if (const StunErrorCodeAttribute* error_code = stun_msg->GetErrorCode()) {
411 LOG_J(LS_ERROR, this) << "Received STUN binding error:"
412 << " class=" << error_code->eclass()
413 << " number=" << error_code->number()
414 << " reason='" << error_code->reason() << "'"
415 << " from " << addr.ToSensitiveString();
416 // Return message to allow error-specific processing
417 } else {
418 LOG_J(LS_ERROR, this) << "Received STUN binding error without a error "
419 << "code from " << addr.ToSensitiveString();
420 return true;
421 }
422 }
423 // NOTE: Username should not be used in verifying response messages.
424 out_username->clear();
425 } else if (stun_msg->type() == STUN_BINDING_INDICATION) {
426 LOG_J(LS_VERBOSE, this) << "Received STUN binding indication:"
427 << " from " << addr.ToSensitiveString();
428 out_username->clear();
429 // No stun attributes will be verified, if it's stun indication message.
430 // Returning from end of the this method.
431 } else {
432 LOG_J(LS_ERROR, this) << "Received STUN packet with invalid type ("
433 << stun_msg->type() << ") from "
434 << addr.ToSensitiveString();
435 return true;
436 }
437
438 // Return the STUN message found.
kwiberg6baec032016-03-15 11:09:39 -0700439 *out_msg = std::move(stun_msg);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000440 return true;
441}
442
443bool Port::IsCompatibleAddress(const rtc::SocketAddress& addr) {
444 int family = ip().family();
445 // We use single-stack sockets, so families must match.
446 if (addr.family() != family) {
447 return false;
448 }
449 // Link-local IPv6 ports can only connect to other link-local IPv6 ports.
Peter Thatcherb8b01432015-07-07 16:45:53 -0700450 if (family == AF_INET6 &&
451 (IPIsLinkLocal(ip()) != IPIsLinkLocal(addr.ipaddr()))) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000452 return false;
453 }
454 return true;
455}
456
457bool Port::ParseStunUsername(const StunMessage* stun_msg,
458 std::string* local_ufrag,
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700459 std::string* remote_ufrag) const {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000460 // The packet must include a username that either begins or ends with our
461 // fragment. It should begin with our fragment if it is a request and it
462 // should end with our fragment if it is a response.
463 local_ufrag->clear();
464 remote_ufrag->clear();
465 const StunByteStringAttribute* username_attr =
466 stun_msg->GetByteString(STUN_ATTR_USERNAME);
467 if (username_attr == NULL)
468 return false;
469
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700470 // RFRAG:LFRAG
471 const std::string username = username_attr->GetString();
472 size_t colon_pos = username.find(":");
473 if (colon_pos == std::string::npos) {
474 return false;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000475 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000476
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700477 *local_ufrag = username.substr(0, colon_pos);
478 *remote_ufrag = username.substr(colon_pos + 1, username.size());
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000479 return true;
480}
481
482bool Port::MaybeIceRoleConflict(
483 const rtc::SocketAddress& addr, IceMessage* stun_msg,
484 const std::string& remote_ufrag) {
485 // Validate ICE_CONTROLLING or ICE_CONTROLLED attributes.
486 bool ret = true;
487 IceRole remote_ice_role = ICEROLE_UNKNOWN;
Peter Boström0c4e06b2015-10-07 12:23:21 +0200488 uint64_t remote_tiebreaker = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000489 const StunUInt64Attribute* stun_attr =
490 stun_msg->GetUInt64(STUN_ATTR_ICE_CONTROLLING);
491 if (stun_attr) {
492 remote_ice_role = ICEROLE_CONTROLLING;
493 remote_tiebreaker = stun_attr->value();
494 }
495
496 // If |remote_ufrag| is same as port local username fragment and
497 // tie breaker value received in the ping message matches port
498 // tiebreaker value this must be a loopback call.
499 // We will treat this as valid scenario.
500 if (remote_ice_role == ICEROLE_CONTROLLING &&
501 username_fragment() == remote_ufrag &&
502 remote_tiebreaker == IceTiebreaker()) {
503 return true;
504 }
505
506 stun_attr = stun_msg->GetUInt64(STUN_ATTR_ICE_CONTROLLED);
507 if (stun_attr) {
508 remote_ice_role = ICEROLE_CONTROLLED;
509 remote_tiebreaker = stun_attr->value();
510 }
511
512 switch (ice_role_) {
513 case ICEROLE_CONTROLLING:
514 if (ICEROLE_CONTROLLING == remote_ice_role) {
515 if (remote_tiebreaker >= tiebreaker_) {
516 SignalRoleConflict(this);
517 } else {
518 // Send Role Conflict (487) error response.
519 SendBindingErrorResponse(stun_msg, addr,
520 STUN_ERROR_ROLE_CONFLICT, STUN_ERROR_REASON_ROLE_CONFLICT);
521 ret = false;
522 }
523 }
524 break;
525 case ICEROLE_CONTROLLED:
526 if (ICEROLE_CONTROLLED == remote_ice_role) {
527 if (remote_tiebreaker < tiebreaker_) {
528 SignalRoleConflict(this);
529 } else {
530 // Send Role Conflict (487) error response.
531 SendBindingErrorResponse(stun_msg, addr,
532 STUN_ERROR_ROLE_CONFLICT, STUN_ERROR_REASON_ROLE_CONFLICT);
533 ret = false;
534 }
535 }
536 break;
537 default:
538 ASSERT(false);
539 }
540 return ret;
541}
542
543void Port::CreateStunUsername(const std::string& remote_username,
544 std::string* stun_username_attr_str) const {
545 stun_username_attr_str->clear();
546 *stun_username_attr_str = remote_username;
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700547 stun_username_attr_str->append(":");
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000548 stun_username_attr_str->append(username_fragment());
549}
550
551void Port::SendBindingResponse(StunMessage* request,
552 const rtc::SocketAddress& addr) {
553 ASSERT(request->type() == STUN_BINDING_REQUEST);
554
555 // Retrieve the username from the request.
556 const StunByteStringAttribute* username_attr =
557 request->GetByteString(STUN_ATTR_USERNAME);
558 ASSERT(username_attr != NULL);
559 if (username_attr == NULL) {
560 // No valid username, skip the response.
561 return;
562 }
563
564 // Fill in the response message.
565 StunMessage response;
566 response.SetType(STUN_BINDING_RESPONSE);
567 response.SetTransactionID(request->transaction_id());
568 const StunUInt32Attribute* retransmit_attr =
569 request->GetUInt32(STUN_ATTR_RETRANSMIT_COUNT);
570 if (retransmit_attr) {
571 // Inherit the incoming retransmit value in the response so the other side
572 // can see our view of lost pings.
573 response.AddAttribute(new StunUInt32Attribute(
574 STUN_ATTR_RETRANSMIT_COUNT, retransmit_attr->value()));
575
576 if (retransmit_attr->value() > CONNECTION_WRITE_CONNECT_FAILURES) {
577 LOG_J(LS_INFO, this)
578 << "Received a remote ping with high retransmit count: "
579 << retransmit_attr->value();
580 }
581 }
582
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700583 response.AddAttribute(
584 new StunXorAddressAttribute(STUN_ATTR_XOR_MAPPED_ADDRESS, addr));
585 response.AddMessageIntegrity(password_);
586 response.AddFingerprint();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000587
588 // Send the response message.
jbauchf1f87202016-03-30 06:43:37 -0700589 rtc::ByteBufferWriter buf;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000590 response.Write(&buf);
591 rtc::PacketOptions options(DefaultDscpValue());
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700592 auto err = SendTo(buf.Data(), buf.Length(), addr, options, false);
593 if (err < 0) {
594 LOG_J(LS_ERROR, this)
595 << "Failed to send STUN ping response"
596 << ", to=" << addr.ToSensitiveString()
597 << ", err=" << err
598 << ", id=" << rtc::hex_encode(response.transaction_id());
599 } else {
600 // Log at LS_INFO if we send a stun ping response on an unwritable
601 // connection.
honghaiz9b5ee9c2015-11-11 13:19:17 -0800602 Connection* conn = GetConnection(addr);
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700603 rtc::LoggingSeverity sev = (conn && !conn->writable()) ?
604 rtc::LS_INFO : rtc::LS_VERBOSE;
605 LOG_JV(sev, this)
606 << "Sent STUN ping response"
607 << ", to=" << addr.ToSensitiveString()
608 << ", id=" << rtc::hex_encode(response.transaction_id());
zhihuang5ecf16c2016-06-01 17:09:15 -0700609
610 conn->stats_.sent_ping_responses++;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000611 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000612}
613
614void Port::SendBindingErrorResponse(StunMessage* request,
615 const rtc::SocketAddress& addr,
616 int error_code, const std::string& reason) {
617 ASSERT(request->type() == STUN_BINDING_REQUEST);
618
619 // Fill in the response message.
620 StunMessage response;
621 response.SetType(STUN_BINDING_ERROR_RESPONSE);
622 response.SetTransactionID(request->transaction_id());
623
624 // When doing GICE, we need to write out the error code incorrectly to
625 // maintain backwards compatiblility.
626 StunErrorCodeAttribute* error_attr = StunAttribute::CreateErrorCode();
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700627 error_attr->SetCode(error_code);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000628 error_attr->SetReason(reason);
629 response.AddAttribute(error_attr);
630
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700631 // Per Section 10.1.2, certain error cases don't get a MESSAGE-INTEGRITY,
632 // because we don't have enough information to determine the shared secret.
633 if (error_code != STUN_ERROR_BAD_REQUEST &&
634 error_code != STUN_ERROR_UNAUTHORIZED)
635 response.AddMessageIntegrity(password_);
636 response.AddFingerprint();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000637
638 // Send the response message.
jbauchf1f87202016-03-30 06:43:37 -0700639 rtc::ByteBufferWriter buf;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000640 response.Write(&buf);
641 rtc::PacketOptions options(DefaultDscpValue());
642 SendTo(buf.Data(), buf.Length(), addr, options, false);
643 LOG_J(LS_INFO, this) << "Sending STUN binding error: reason=" << reason
644 << " to " << addr.ToSensitiveString();
645}
646
647void Port::OnMessage(rtc::Message *pmsg) {
honghaizd0b31432015-09-30 12:42:17 -0700648 ASSERT(pmsg->message_id == MSG_DEAD);
649 if (dead()) {
650 Destroy();
651 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000652}
653
Honghai Zhang351d77b2016-05-20 15:08:29 -0700654void Port::OnNetworkTypeChanged(const rtc::Network* network) {
655 ASSERT(network == network_);
656
657 UpdateNetworkCost();
658}
659
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000660std::string Port::ToString() const {
661 std::stringstream ss;
honghaize3c6c822016-02-17 13:00:28 -0800662 ss << "Port[" << std::hex << this << std::dec << ":" << content_name_ << ":"
663 << component_ << ":" << generation_ << ":" << type_ << ":"
664 << network_->ToString() << "]";
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000665 return ss.str();
666}
667
Honghai Zhang351d77b2016-05-20 15:08:29 -0700668// TODO(honghaiz): Make the network cost configurable from user setting.
669void Port::UpdateNetworkCost() {
670 uint16_t new_cost = network_->GetCost();
671 if (network_cost_ == new_cost) {
672 return;
673 }
674 LOG(LS_INFO) << "Network cost changed from " << network_cost_
675 << " to " << new_cost
676 << ". Number of candidates created: " << candidates_.size()
677 << ". Number of connections created: " << connections_.size();
678 network_cost_ = new_cost;
679 for (cricket::Candidate& candidate : candidates_) {
680 candidate.set_network_cost(network_cost_);
681 }
682 // Network cost change will affect the connection selection criteria.
683 // Signal the connection state change on each connection to force a
684 // re-sort in P2PTransportChannel.
685 for (auto kv : connections_) {
686 Connection* conn = kv.second;
687 conn->SignalStateChange(conn);
688 }
689}
690
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000691void Port::EnablePortPackets() {
692 enable_port_packets_ = true;
693}
694
695void Port::OnConnectionDestroyed(Connection* conn) {
696 AddressMap::iterator iter =
697 connections_.find(conn->remote_candidate().address());
698 ASSERT(iter != connections_.end());
699 connections_.erase(iter);
honghaiz36f50e82016-06-01 15:57:03 -0700700 HandleConnectionDestroyed(conn);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000701
honghaizd0b31432015-09-30 12:42:17 -0700702 // On the controlled side, ports time out after all connections fail.
703 // Note: If a new connection is added after this message is posted, but it
704 // fails and is removed before kPortTimeoutDelay, then this message will
705 // still cause the Port to be destroyed.
706 if (dead()) {
Taylor Brandstetter5d97a9a2016-06-10 14:17:27 -0700707 thread_->PostDelayed(RTC_FROM_HERE, timeout_delay_, this, MSG_DEAD);
honghaizd0b31432015-09-30 12:42:17 -0700708 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000709}
710
711void Port::Destroy() {
712 ASSERT(connections_.empty());
713 LOG_J(LS_INFO, this) << "Port deleted";
714 SignalDestroyed(this);
715 delete this;
716}
717
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000718const std::string Port::username_fragment() const {
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700719 return ice_username_fragment_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000720}
721
722// A ConnectionRequest is a simple STUN ping used to determine writability.
723class ConnectionRequest : public StunRequest {
724 public:
725 explicit ConnectionRequest(Connection* connection)
726 : StunRequest(new IceMessage()),
727 connection_(connection) {
728 }
729
730 virtual ~ConnectionRequest() {
731 }
732
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700733 void Prepare(StunMessage* request) override {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000734 request->SetType(STUN_BINDING_REQUEST);
735 std::string username;
736 connection_->port()->CreateStunUsername(
737 connection_->remote_candidate().username(), &username);
738 request->AddAttribute(
739 new StunByteStringAttribute(STUN_ATTR_USERNAME, username));
740
741 // connection_ already holds this ping, so subtract one from count.
742 if (connection_->port()->send_retransmit_count_attribute()) {
743 request->AddAttribute(new StunUInt32Attribute(
744 STUN_ATTR_RETRANSMIT_COUNT,
Peter Boström0c4e06b2015-10-07 12:23:21 +0200745 static_cast<uint32_t>(connection_->pings_since_last_response_.size() -
746 1)));
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000747 }
honghaiza0c44ea2016-03-23 16:07:48 -0700748 uint32_t network_info = connection_->port()->Network()->id();
749 network_info = (network_info << 16) | connection_->port()->network_cost();
750 request->AddAttribute(
751 new StunUInt32Attribute(STUN_ATTR_NETWORK_INFO, network_info));
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000752
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700753 // Adding ICE_CONTROLLED or ICE_CONTROLLING attribute based on the role.
754 if (connection_->port()->GetIceRole() == ICEROLE_CONTROLLING) {
755 request->AddAttribute(new StunUInt64Attribute(
756 STUN_ATTR_ICE_CONTROLLING, connection_->port()->IceTiebreaker()));
757 // Since we are trying aggressive nomination, sending USE-CANDIDATE
758 // attribute in every ping.
759 // If we are dealing with a ice-lite end point, nomination flag
760 // in Connection will be set to false by default. Once the connection
761 // becomes "best connection", nomination flag will be turned on.
762 if (connection_->use_candidate_attr()) {
763 request->AddAttribute(new StunByteStringAttribute(
764 STUN_ATTR_USE_CANDIDATE));
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000765 }
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700766 } else if (connection_->port()->GetIceRole() == ICEROLE_CONTROLLED) {
767 request->AddAttribute(new StunUInt64Attribute(
768 STUN_ATTR_ICE_CONTROLLED, connection_->port()->IceTiebreaker()));
769 } else {
770 ASSERT(false);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000771 }
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700772
773 // Adding PRIORITY Attribute.
774 // Changing the type preference to Peer Reflexive and local preference
775 // and component id information is unchanged from the original priority.
776 // priority = (2^24)*(type preference) +
777 // (2^8)*(local preference) +
778 // (2^0)*(256 - component ID)
Peter Boström0c4e06b2015-10-07 12:23:21 +0200779 uint32_t prflx_priority =
780 ICE_TYPE_PREFERENCE_PRFLX << 24 |
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700781 (connection_->local_candidate().priority() & 0x00FFFFFF);
782 request->AddAttribute(
783 new StunUInt32Attribute(STUN_ATTR_PRIORITY, prflx_priority));
784
785 // Adding Message Integrity attribute.
786 request->AddMessageIntegrity(connection_->remote_candidate().password());
787 // Adding Fingerprint.
788 request->AddFingerprint();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000789 }
790
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700791 void OnResponse(StunMessage* response) override {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000792 connection_->OnConnectionRequestResponse(this, response);
793 }
794
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700795 void OnErrorResponse(StunMessage* response) override {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000796 connection_->OnConnectionRequestErrorResponse(this, response);
797 }
798
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700799 void OnTimeout() override {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000800 connection_->OnConnectionRequestTimeout(this);
801 }
802
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700803 void OnSent() override {
804 connection_->OnConnectionRequestSent(this);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000805 // Each request is sent only once. After a single delay , the request will
806 // time out.
807 timeout_ = true;
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700808 }
809
810 int resend_delay() override {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000811 return CONNECTION_RESPONSE_TIMEOUT;
812 }
813
814 private:
815 Connection* connection_;
816};
817
818//
819// Connection
820//
821
guoweis@webrtc.org930e0042014-11-17 19:42:14 +0000822Connection::Connection(Port* port,
823 size_t index,
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000824 const Candidate& remote_candidate)
guoweis@webrtc.org930e0042014-11-17 19:42:14 +0000825 : port_(port),
826 local_candidate_index_(index),
827 remote_candidate_(remote_candidate),
guoweis@webrtc.org930e0042014-11-17 19:42:14 +0000828 write_state_(STATE_WRITE_INIT),
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700829 receiving_(false),
guoweis@webrtc.org930e0042014-11-17 19:42:14 +0000830 connected_(true),
831 pruned_(false),
832 use_candidate_attr_(false),
honghaiz5a3acd82015-08-20 15:53:17 -0700833 nominated_(false),
guoweis@webrtc.org930e0042014-11-17 19:42:14 +0000834 remote_ice_mode_(ICEMODE_FULL),
835 requests_(port->thread()),
836 rtt_(DEFAULT_RTT),
837 last_ping_sent_(0),
838 last_ping_received_(0),
839 last_data_received_(0),
840 last_ping_response_received_(0),
Honghai Zhang82d78622016-05-06 11:29:15 -0700841 recv_rate_tracker_(100, 10u),
842 send_rate_tracker_(100, 10u),
guoweis@webrtc.org930e0042014-11-17 19:42:14 +0000843 reported_(false),
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700844 state_(STATE_WAITING),
Honghai Zhang2b342bf2015-09-30 09:51:58 -0700845 receiving_timeout_(WEAK_CONNECTION_RECEIVE_TIMEOUT),
nisse1bffc1d2016-05-02 08:18:55 -0700846 time_created_ms_(rtc::TimeMillis()) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000847 // All of our connections start in WAITING state.
848 // TODO(mallinath) - Start connections from STATE_FROZEN.
849 // Wire up to send stun packets
850 requests_.SignalSendPacket.connect(this, &Connection::OnSendStunPacket);
851 LOG_J(LS_INFO, this) << "Connection created";
852}
853
854Connection::~Connection() {
855}
856
857const Candidate& Connection::local_candidate() const {
858 ASSERT(local_candidate_index_ < port_->Candidates().size());
859 return port_->Candidates()[local_candidate_index_];
860}
861
Honghai Zhangcc411c02016-03-29 17:27:21 -0700862const Candidate& Connection::remote_candidate() const {
863 return remote_candidate_;
864}
865
Peter Boström0c4e06b2015-10-07 12:23:21 +0200866uint64_t Connection::priority() const {
867 uint64_t priority = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000868 // RFC 5245 - 5.7.2. Computing Pair Priority and Ordering Pairs
869 // Let G be the priority for the candidate provided by the controlling
870 // agent. Let D be the priority for the candidate provided by the
871 // controlled agent.
872 // pair priority = 2^32*MIN(G,D) + 2*MAX(G,D) + (G>D?1:0)
873 IceRole role = port_->GetIceRole();
874 if (role != ICEROLE_UNKNOWN) {
Peter Boström0c4e06b2015-10-07 12:23:21 +0200875 uint32_t g = 0;
876 uint32_t d = 0;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000877 if (role == ICEROLE_CONTROLLING) {
878 g = local_candidate().priority();
879 d = remote_candidate_.priority();
880 } else {
881 g = remote_candidate_.priority();
882 d = local_candidate().priority();
883 }
andresp@webrtc.orgff689be2015-02-12 11:54:26 +0000884 priority = std::min(g, d);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000885 priority = priority << 32;
andresp@webrtc.orgff689be2015-02-12 11:54:26 +0000886 priority += 2 * std::max(g, d) + (g > d ? 1 : 0);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000887 }
888 return priority;
889}
890
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000891void Connection::set_write_state(WriteState value) {
892 WriteState old_value = write_state_;
893 write_state_ = value;
894 if (value != old_value) {
guoweis@webrtc.org8c9ff202014-12-04 07:56:02 +0000895 LOG_J(LS_VERBOSE, this) << "set_write_state from: " << old_value << " to "
896 << value;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000897 SignalStateChange(this);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000898 }
899}
900
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700901void Connection::set_receiving(bool value) {
902 if (value != receiving_) {
903 LOG_J(LS_VERBOSE, this) << "set_receiving to " << value;
904 receiving_ = value;
905 SignalStateChange(this);
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700906 }
907}
908
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000909void Connection::set_state(State state) {
910 State old_state = state_;
911 state_ = state;
912 if (state != old_state) {
913 LOG_J(LS_VERBOSE, this) << "set_state";
914 }
915}
916
917void Connection::set_connected(bool value) {
918 bool old_value = connected_;
919 connected_ = value;
920 if (value != old_value) {
Guo-wei Shiehbe508a12015-04-06 12:48:47 -0700921 LOG_J(LS_VERBOSE, this) << "set_connected from: " << old_value << " to "
922 << value;
Taylor Brandstetterb825aee2016-06-29 13:07:16 -0700923 SignalStateChange(this);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000924 }
925}
926
927void Connection::set_use_candidate_attr(bool enable) {
928 use_candidate_attr_ = enable;
929}
930
931void Connection::OnSendStunPacket(const void* data, size_t size,
932 StunRequest* req) {
933 rtc::PacketOptions options(port_->DefaultDscpValue());
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700934 auto err = port_->SendTo(
935 data, size, remote_candidate_.address(), options, false);
936 if (err < 0) {
937 LOG_J(LS_WARNING, this) << "Failed to send STUN ping "
938 << " err=" << err
939 << " id=" << rtc::hex_encode(req->id());
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000940 }
941}
942
943void Connection::OnReadPacket(
944 const char* data, size_t size, const rtc::PacketTime& packet_time) {
kwiberg3ec46792016-04-27 07:22:53 -0700945 std::unique_ptr<IceMessage> msg;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000946 std::string remote_ufrag;
947 const rtc::SocketAddress& addr(remote_candidate_.address());
kwiberg6baec032016-03-15 11:09:39 -0700948 if (!port_->GetStunMessage(data, size, addr, &msg, &remote_ufrag)) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000949 // The packet did not parse as a valid STUN message
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700950 // This is a data packet, pass it along.
951 set_receiving(true);
nisse1bffc1d2016-05-02 08:18:55 -0700952 last_data_received_ = rtc::TimeMillis();
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700953 recv_rate_tracker_.AddSamples(size);
954 SignalReadPacket(this, data, size, packet_time);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000955
Peter Thatcher04ac81f2015-09-21 11:48:28 -0700956 // If timed out sending writability checks, start up again
957 if (!pruned_ && (write_state_ == STATE_WRITE_TIMEOUT)) {
958 LOG(LS_WARNING) << "Received a data packet on a timed-out Connection. "
959 << "Resetting state to STATE_WRITE_INIT.";
960 set_write_state(STATE_WRITE_INIT);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000961 }
962 } else if (!msg) {
963 // The packet was STUN, but failed a check and was handled internally.
964 } else {
965 // The packet is STUN and passed the Port checks.
966 // Perform our own checks to ensure this packet is valid.
honghaizd0b31432015-09-30 12:42:17 -0700967 // If this is a STUN request, then update the receiving bit and respond.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000968 // If this is a STUN response, then update the writable bit.
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700969 // Log at LS_INFO if we receive a ping on an unwritable connection.
970 rtc::LoggingSeverity sev = (!writable() ? rtc::LS_INFO : rtc::LS_VERBOSE);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000971 switch (msg->type()) {
972 case STUN_BINDING_REQUEST:
Peter Thatcher1cf6f812015-05-15 10:40:45 -0700973 LOG_JV(sev, this) << "Received STUN ping"
974 << ", id=" << rtc::hex_encode(msg->transaction_id());
975
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000976 if (remote_ufrag == remote_candidate_.username()) {
honghaiz9b5ee9c2015-11-11 13:19:17 -0800977 HandleBindingRequest(msg.get());
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000978 } else {
979 // The packet had the right local username, but the remote username
980 // was not the right one for the remote address.
981 LOG_J(LS_ERROR, this)
982 << "Received STUN request with bad remote username "
983 << remote_ufrag;
984 port_->SendBindingErrorResponse(msg.get(), addr,
985 STUN_ERROR_UNAUTHORIZED,
986 STUN_ERROR_REASON_UNAUTHORIZED);
987
988 }
989 break;
990
991 // Response from remote peer. Does it match request sent?
992 // This doesn't just check, it makes callbacks if transaction
993 // id's match.
994 case STUN_BINDING_RESPONSE:
995 case STUN_BINDING_ERROR_RESPONSE:
Peter Thatcher7cbd1882015-09-17 18:54:52 -0700996 if (msg->ValidateMessageIntegrity(
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +0000997 data, size, remote_candidate().password())) {
998 requests_.CheckResponse(msg.get());
999 }
1000 // Otherwise silently discard the response message.
1001 break;
1002
honghaizd0b31432015-09-30 12:42:17 -07001003 // Remote end point sent an STUN indication instead of regular binding
1004 // request. In this case |last_ping_received_| will be updated but no
1005 // response will be sent.
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001006 case STUN_BINDING_INDICATION:
Peter Thatcher04ac81f2015-09-21 11:48:28 -07001007 ReceivedPing();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001008 break;
1009
1010 default:
1011 ASSERT(false);
1012 break;
1013 }
1014 }
1015}
1016
honghaiz9b5ee9c2015-11-11 13:19:17 -08001017void Connection::HandleBindingRequest(IceMessage* msg) {
1018 // This connection should now be receiving.
1019 ReceivedPing();
1020
1021 const rtc::SocketAddress& remote_addr = remote_candidate_.address();
1022 const std::string& remote_ufrag = remote_candidate_.username();
1023 // Check for role conflicts.
1024 if (!port_->MaybeIceRoleConflict(remote_addr, msg, remote_ufrag)) {
1025 // Received conflicting role from the peer.
1026 LOG(LS_INFO) << "Received conflicting role from the peer.";
1027 return;
1028 }
1029
zhihuang5ecf16c2016-06-01 17:09:15 -07001030 stats_.recv_ping_requests++;
1031
honghaiz9b5ee9c2015-11-11 13:19:17 -08001032 // This is a validated stun request from remote peer.
1033 port_->SendBindingResponse(msg, remote_addr);
1034
1035 // If it timed out on writing check, start up again
1036 if (!pruned_ && write_state_ == STATE_WRITE_TIMEOUT) {
1037 set_write_state(STATE_WRITE_INIT);
1038 }
1039
1040 if (port_->GetIceRole() == ICEROLE_CONTROLLED) {
1041 const StunByteStringAttribute* use_candidate_attr =
1042 msg->GetByteString(STUN_ATTR_USE_CANDIDATE);
1043 if (use_candidate_attr) {
1044 set_nominated(true);
1045 SignalNominated(this);
1046 }
1047 }
Honghai Zhang351d77b2016-05-20 15:08:29 -07001048 // Set the remote cost if the network_info attribute is available.
1049 // Note: If packets are re-ordered, we may get incorrect network cost
1050 // temporarily, but it should get the correct value shortly after that.
1051 const StunUInt32Attribute* network_attr =
1052 msg->GetUInt32(STUN_ATTR_NETWORK_INFO);
1053 if (network_attr) {
1054 uint32_t network_info = network_attr->value();
1055 uint16_t network_cost = static_cast<uint16_t>(network_info);
1056 if (network_cost != remote_candidate_.network_cost()) {
1057 remote_candidate_.set_network_cost(network_cost);
1058 // Network cost change will affect the connection ranking, so signal
1059 // state change to force a re-sort in P2PTransportChannel.
1060 SignalStateChange(this);
1061 }
1062 }
honghaiz9b5ee9c2015-11-11 13:19:17 -08001063}
1064
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001065void Connection::OnReadyToSend() {
1066 if (write_state_ == STATE_WRITABLE) {
1067 SignalReadyToSend(this);
1068 }
1069}
1070
1071void Connection::Prune() {
Honghai Zhang2b342bf2015-09-30 09:51:58 -07001072 if (!pruned_ || active()) {
Honghai Zhang1590c392016-05-24 13:15:02 -07001073 LOG_J(LS_INFO, this) << "Connection pruned";
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001074 pruned_ = true;
1075 requests_.Clear();
1076 set_write_state(STATE_WRITE_TIMEOUT);
1077 }
1078}
1079
1080void Connection::Destroy() {
1081 LOG_J(LS_VERBOSE, this) << "Connection destroyed";
Taylor Brandstetter5d97a9a2016-06-10 14:17:27 -07001082 port_->thread()->Post(RTC_FROM_HERE, this, MSG_DELETE);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001083}
1084
deadbeef376e1232015-11-25 09:00:08 -08001085void Connection::FailAndDestroy() {
1086 set_state(Connection::STATE_FAILED);
1087 Destroy();
1088}
1089
honghaiz079a7a12016-06-22 16:26:29 -07001090void Connection::FailAndPrune() {
1091 set_state(Connection::STATE_FAILED);
1092 Prune();
1093}
1094
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001095void Connection::PrintPingsSinceLastResponse(std::string* s, size_t max) {
1096 std::ostringstream oss;
1097 oss << std::boolalpha;
1098 if (pings_since_last_response_.size() > max) {
1099 for (size_t i = 0; i < max; i++) {
1100 const SentPing& ping = pings_since_last_response_[i];
1101 oss << rtc::hex_encode(ping.id) << " ";
1102 }
1103 oss << "... " << (pings_since_last_response_.size() - max) << " more";
1104 } else {
1105 for (const SentPing& ping : pings_since_last_response_) {
1106 oss << rtc::hex_encode(ping.id) << " ";
1107 }
1108 }
1109 *s = oss.str();
1110}
1111
honghaiz34b11eb2016-03-16 08:55:44 -07001112void Connection::UpdateState(int64_t now) {
1113 int rtt = ConservativeRTTEstimate(rtt_);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001114
Peter Thatcherb2d26232015-05-15 11:25:14 -07001115 if (LOG_CHECK_LEVEL(LS_VERBOSE)) {
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001116 std::string pings;
1117 PrintPingsSinceLastResponse(&pings, 5);
1118 LOG_J(LS_VERBOSE, this) << "UpdateState()"
1119 << ", ms since last received response="
1120 << now - last_ping_response_received_
1121 << ", ms since last received data="
1122 << now - last_data_received_
1123 << ", rtt=" << rtt
1124 << ", pings_since_last_response=" << pings;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001125 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001126
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001127 // Check the writable state. (The order of these checks is important.)
1128 //
1129 // Before becoming unwritable, we allow for a fixed number of pings to fail
1130 // (i.e., receive no response). We also have to give the response time to
1131 // get back, so we include a conservative estimate of this.
1132 //
1133 // Before timing out writability, we give a fixed amount of time. This is to
1134 // allow for changes in network conditions.
1135
1136 if ((write_state_ == STATE_WRITABLE) &&
1137 TooManyFailures(pings_since_last_response_,
1138 CONNECTION_WRITE_CONNECT_FAILURES,
1139 rtt,
1140 now) &&
1141 TooLongWithoutResponse(pings_since_last_response_,
1142 CONNECTION_WRITE_CONNECT_TIMEOUT,
1143 now)) {
Peter Boström0c4e06b2015-10-07 12:23:21 +02001144 uint32_t max_pings = CONNECTION_WRITE_CONNECT_FAILURES;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001145 LOG_J(LS_INFO, this) << "Unwritable after " << max_pings
1146 << " ping failures and "
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001147 << now - pings_since_last_response_[0].sent_time
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001148 << " ms without a response,"
1149 << " ms since last received ping="
1150 << now - last_ping_received_
1151 << " ms since last received data="
1152 << now - last_data_received_
1153 << " rtt=" << rtt;
1154 set_write_state(STATE_WRITE_UNRELIABLE);
1155 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001156 if ((write_state_ == STATE_WRITE_UNRELIABLE ||
1157 write_state_ == STATE_WRITE_INIT) &&
1158 TooLongWithoutResponse(pings_since_last_response_,
1159 CONNECTION_WRITE_TIMEOUT,
1160 now)) {
1161 LOG_J(LS_INFO, this) << "Timed out after "
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001162 << now - pings_since_last_response_[0].sent_time
1163 << " ms without a response"
1164 << ", rtt=" << rtt;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001165 set_write_state(STATE_WRITE_TIMEOUT);
1166 }
Peter Thatcher04ac81f2015-09-21 11:48:28 -07001167
1168 // Check the receiving state.
honghaiz34b11eb2016-03-16 08:55:44 -07001169 int64_t last_recv_time = last_received();
Peter Thatcher04ac81f2015-09-21 11:48:28 -07001170 bool receiving = now <= last_recv_time + receiving_timeout_;
1171 set_receiving(receiving);
Honghai Zhang2b342bf2015-09-30 09:51:58 -07001172 if (dead(now)) {
1173 Destroy();
1174 }
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001175}
1176
honghaiz34b11eb2016-03-16 08:55:44 -07001177void Connection::Ping(int64_t now) {
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001178 last_ping_sent_ = now;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001179 ConnectionRequest *req = new ConnectionRequest(this);
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001180 pings_since_last_response_.push_back(SentPing(req->id(), now));
1181 LOG_J(LS_VERBOSE, this) << "Sending STUN ping "
1182 << ", id=" << rtc::hex_encode(req->id());
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001183 requests_.Send(req);
1184 state_ = STATE_INPROGRESS;
honghaiz524ecc22016-05-25 12:48:31 -07001185 num_pings_sent_++;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001186}
1187
1188void Connection::ReceivedPing() {
Peter Thatcher04ac81f2015-09-21 11:48:28 -07001189 set_receiving(true);
nisse1bffc1d2016-05-02 08:18:55 -07001190 last_ping_received_ = rtc::TimeMillis();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001191}
1192
zhihuang435264a2016-06-21 11:28:38 -07001193void Connection::ReceivedPingResponse(int rtt) {
Peter Thatcher1fe120a2015-06-10 11:33:17 -07001194 // We've already validated that this is a STUN binding response with
1195 // the correct local and remote username for this connection.
1196 // So if we're not already, become writable. We may be bringing a pruned
1197 // connection back to life, but if we don't really want it, we can always
1198 // prune it again.
Peter Thatcher04ac81f2015-09-21 11:48:28 -07001199 set_receiving(true);
Peter Thatcher1fe120a2015-06-10 11:33:17 -07001200 set_write_state(STATE_WRITABLE);
1201 set_state(STATE_SUCCEEDED);
1202 pings_since_last_response_.clear();
nisse1bffc1d2016-05-02 08:18:55 -07001203 last_ping_response_received_ = rtc::TimeMillis();
zhihuang435264a2016-06-21 11:28:38 -07001204 rtt_samples_++;
1205 rtt_ = (RTT_RATIO * rtt_ + rtt) / (RTT_RATIO + 1);
Peter Thatcher1fe120a2015-06-10 11:33:17 -07001206}
1207
honghaiz34b11eb2016-03-16 08:55:44 -07001208bool Connection::dead(int64_t now) const {
honghaiz37389b42016-01-04 21:57:33 -08001209 if (last_received() > 0) {
1210 // If it has ever received anything, we keep it alive until it hasn't
1211 // received anything for DEAD_CONNECTION_RECEIVE_TIMEOUT. This covers the
1212 // normal case of a successfully used connection that stops working. This
1213 // also allows a remote peer to continue pinging over a locally inactive
1214 // (pruned) connection.
1215 return (now > (last_received() + DEAD_CONNECTION_RECEIVE_TIMEOUT));
1216 }
1217
1218 if (active()) {
1219 // If it has never received anything, keep it alive as long as it is
1220 // actively pinging and not pruned. Otherwise, the connection might be
1221 // deleted before it has a chance to ping. This is the normal case for a
1222 // new connection that is pinging but hasn't received anything yet.
Honghai Zhang2b342bf2015-09-30 09:51:58 -07001223 return false;
1224 }
1225
honghaiz37389b42016-01-04 21:57:33 -08001226 // If it has never received anything and is not actively pinging (pruned), we
1227 // keep it around for at least MIN_CONNECTION_LIFETIME to prevent connections
1228 // from being pruned too quickly during a network change event when two
1229 // networks would be up simultaneously but only for a brief period.
1230 return now > (time_created_ms_ + MIN_CONNECTION_LIFETIME);
Honghai Zhang2b342bf2015-09-30 09:51:58 -07001231}
1232
Taylor Brandstetterb825aee2016-06-29 13:07:16 -07001233bool Connection::stable(int64_t now) const {
zhihuang435264a2016-06-21 11:28:38 -07001234 // A connection is stable if it's RTT has converged and it isn't missing any
1235 // responses. We should send pings at a higher rate until the RTT converges
1236 // and whenever a ping response is missing (so that we can detect
1237 // unwritability faster)
1238 return rtt_converged() && !missing_responses(now);
1239}
1240
guoweis@webrtc.org8c9ff202014-12-04 07:56:02 +00001241std::string Connection::ToDebugId() const {
1242 std::stringstream ss;
1243 ss << std::hex << this;
1244 return ss.str();
1245}
1246
honghaize1a0c942016-02-16 14:54:56 -08001247uint32_t Connection::ComputeNetworkCost() const {
1248 // TODO(honghaiz): Will add rtt as part of the network cost.
Honghai Zhang351d77b2016-05-20 15:08:29 -07001249 return port()->network_cost() + remote_candidate_.network_cost();
honghaize1a0c942016-02-16 14:54:56 -08001250}
1251
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001252std::string Connection::ToString() const {
1253 const char CONNECT_STATE_ABBREV[2] = {
1254 '-', // not connected (false)
1255 'C', // connected (true)
1256 };
Peter Thatcher04ac81f2015-09-21 11:48:28 -07001257 const char RECEIVE_STATE_ABBREV[2] = {
1258 '-', // not receiving (false)
1259 'R', // receiving (true)
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001260 };
1261 const char WRITE_STATE_ABBREV[4] = {
1262 'W', // STATE_WRITABLE
1263 'w', // STATE_WRITE_UNRELIABLE
1264 '-', // STATE_WRITE_INIT
1265 'x', // STATE_WRITE_TIMEOUT
1266 };
1267 const std::string ICESTATE[4] = {
1268 "W", // STATE_WAITING
1269 "I", // STATE_INPROGRESS
1270 "S", // STATE_SUCCEEDED
1271 "F" // STATE_FAILED
1272 };
1273 const Candidate& local = local_candidate();
1274 const Candidate& remote = remote_candidate();
1275 std::stringstream ss;
guoweis@webrtc.org8c9ff202014-12-04 07:56:02 +00001276 ss << "Conn[" << ToDebugId()
1277 << ":" << port_->content_name()
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001278 << ":" << local.id() << ":" << local.component()
1279 << ":" << local.generation()
1280 << ":" << local.type() << ":" << local.protocol()
1281 << ":" << local.address().ToSensitiveString()
1282 << "->" << remote.id() << ":" << remote.component()
1283 << ":" << remote.priority()
1284 << ":" << remote.type() << ":"
1285 << remote.protocol() << ":" << remote.address().ToSensitiveString() << "|"
1286 << CONNECT_STATE_ABBREV[connected()]
Peter Thatcher04ac81f2015-09-21 11:48:28 -07001287 << RECEIVE_STATE_ABBREV[receiving()]
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001288 << WRITE_STATE_ABBREV[write_state()]
1289 << ICESTATE[state()] << "|"
1290 << priority() << "|";
1291 if (rtt_ < DEFAULT_RTT) {
1292 ss << rtt_ << "]";
1293 } else {
1294 ss << "-]";
1295 }
1296 return ss.str();
1297}
1298
1299std::string Connection::ToSensitiveString() const {
1300 return ToString();
1301}
1302
1303void Connection::OnConnectionRequestResponse(ConnectionRequest* request,
1304 StunMessage* response) {
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001305 // Log at LS_INFO if we receive a ping response on an unwritable
1306 // connection.
1307 rtc::LoggingSeverity sev = !writable() ? rtc::LS_INFO : rtc::LS_VERBOSE;
1308
honghaiz34b11eb2016-03-16 08:55:44 -07001309 int rtt = request->Elapsed();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001310
zhihuang435264a2016-06-21 11:28:38 -07001311 ReceivedPingResponse(rtt);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001312
Peter Thatcherb2d26232015-05-15 11:25:14 -07001313 if (LOG_CHECK_LEVEL_V(sev)) {
Peter Thatcher42af6ca2015-05-15 12:23:27 -07001314 bool use_candidate = (
1315 response->GetByteString(STUN_ATTR_USE_CANDIDATE) != nullptr);
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001316 std::string pings;
1317 PrintPingsSinceLastResponse(&pings, 5);
1318 LOG_JV(sev, this) << "Received STUN ping response"
Peter Thatcher42af6ca2015-05-15 12:23:27 -07001319 << ", id=" << rtc::hex_encode(request->id())
1320 << ", code=0" // Makes logging easier to parse.
1321 << ", rtt=" << rtt
1322 << ", use_candidate=" << use_candidate
1323 << ", pings_since_last_response=" << pings;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001324 }
1325
zhihuang5ecf16c2016-06-01 17:09:15 -07001326 stats_.recv_ping_responses++;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001327
Peter Thatcher7cbd1882015-09-17 18:54:52 -07001328 MaybeAddPrflxCandidate(request, response);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001329}
1330
1331void Connection::OnConnectionRequestErrorResponse(ConnectionRequest* request,
1332 StunMessage* response) {
1333 const StunErrorCodeAttribute* error_attr = response->GetErrorCode();
1334 int error_code = STUN_ERROR_GLOBAL_FAILURE;
1335 if (error_attr) {
Peter Thatcher7cbd1882015-09-17 18:54:52 -07001336 error_code = error_attr->code();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001337 }
1338
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001339 LOG_J(LS_INFO, this) << "Received STUN error response"
1340 << " id=" << rtc::hex_encode(request->id())
1341 << " code=" << error_code
1342 << " rtt=" << request->Elapsed();
1343
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001344 if (error_code == STUN_ERROR_UNKNOWN_ATTRIBUTE ||
1345 error_code == STUN_ERROR_SERVER_ERROR ||
1346 error_code == STUN_ERROR_UNAUTHORIZED) {
1347 // Recoverable error, retry
1348 } else if (error_code == STUN_ERROR_STALE_CREDENTIALS) {
1349 // Race failure, retry
1350 } else if (error_code == STUN_ERROR_ROLE_CONFLICT) {
1351 HandleRoleConflictFromPeer();
1352 } else {
1353 // This is not a valid connection.
1354 LOG_J(LS_ERROR, this) << "Received STUN error response, code="
1355 << error_code << "; killing connection";
deadbeef376e1232015-11-25 09:00:08 -08001356 FailAndDestroy();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001357 }
1358}
1359
1360void Connection::OnConnectionRequestTimeout(ConnectionRequest* request) {
1361 // Log at LS_INFO if we miss a ping on a writable connection.
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001362 rtc::LoggingSeverity sev = writable() ? rtc::LS_INFO : rtc::LS_VERBOSE;
1363 LOG_JV(sev, this) << "Timing-out STUN ping "
1364 << rtc::hex_encode(request->id())
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001365 << " after " << request->Elapsed() << " ms";
1366}
1367
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001368void Connection::OnConnectionRequestSent(ConnectionRequest* request) {
1369 // Log at LS_INFO if we send a ping on an unwritable connection.
1370 rtc::LoggingSeverity sev = !writable() ? rtc::LS_INFO : rtc::LS_VERBOSE;
Peter Thatcher42af6ca2015-05-15 12:23:27 -07001371 bool use_candidate = use_candidate_attr();
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001372 LOG_JV(sev, this) << "Sent STUN ping"
Peter Thatcher42af6ca2015-05-15 12:23:27 -07001373 << ", id=" << rtc::hex_encode(request->id())
1374 << ", use_candidate=" << use_candidate;
zhihuang5ecf16c2016-06-01 17:09:15 -07001375 stats_.sent_ping_requests_total++;
1376 if (stats_.recv_ping_responses == 0) {
1377 stats_.sent_ping_requests_before_first_response++;
1378 }
Peter Thatcher1cf6f812015-05-15 10:40:45 -07001379}
1380
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001381void Connection::HandleRoleConflictFromPeer() {
1382 port_->SignalRoleConflict(port_);
1383}
1384
Taylor Brandstetter0a1bc532016-04-19 18:03:26 -07001385void Connection::MaybeSetRemoteIceCredentialsAndGeneration(
1386 const std::string& ice_ufrag,
1387 const std::string& ice_pwd,
1388 int generation) {
jiayl@webrtc.orgdacdd942015-01-23 17:33:34 +00001389 if (remote_candidate_.username() == ice_ufrag &&
1390 remote_candidate_.password().empty()) {
1391 remote_candidate_.set_password(ice_pwd);
1392 }
Taylor Brandstetter0a1bc532016-04-19 18:03:26 -07001393 // TODO(deadbeef): A value of '0' for the generation is used for both
1394 // generation 0 and "generation unknown". It should be changed to an
1395 // rtc::Optional to fix this.
1396 if (remote_candidate_.username() == ice_ufrag &&
1397 remote_candidate_.password() == ice_pwd &&
1398 remote_candidate_.generation() == 0) {
1399 remote_candidate_.set_generation(generation);
1400 }
jiayl@webrtc.orgdacdd942015-01-23 17:33:34 +00001401}
1402
1403void Connection::MaybeUpdatePeerReflexiveCandidate(
1404 const Candidate& new_candidate) {
1405 if (remote_candidate_.type() == PRFLX_PORT_TYPE &&
1406 new_candidate.type() != PRFLX_PORT_TYPE &&
1407 remote_candidate_.protocol() == new_candidate.protocol() &&
1408 remote_candidate_.address() == new_candidate.address() &&
1409 remote_candidate_.username() == new_candidate.username() &&
1410 remote_candidate_.password() == new_candidate.password() &&
1411 remote_candidate_.generation() == new_candidate.generation()) {
1412 remote_candidate_ = new_candidate;
1413 }
1414}
1415
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001416void Connection::OnMessage(rtc::Message *pmsg) {
1417 ASSERT(pmsg->message_id == MSG_DELETE);
honghaiz18f9da02016-06-01 23:53:01 -07001418 LOG(LS_INFO) << "Connection deleted with number of pings sent: "
1419 << num_pings_sent_;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001420 SignalDestroyed(this);
1421 delete this;
1422}
1423
honghaiz34b11eb2016-03-16 08:55:44 -07001424int64_t Connection::last_received() const {
Peter Thatcher54360512015-07-08 11:08:35 -07001425 return std::max(last_data_received_,
1426 std::max(last_ping_received_, last_ping_response_received_));
1427}
1428
zhihuang5ecf16c2016-06-01 17:09:15 -07001429ConnectionInfo Connection::stats() {
1430 stats_.recv_bytes_second = round(recv_rate_tracker_.ComputeRate());
1431 stats_.recv_total_bytes = recv_rate_tracker_.TotalSampleCount();
1432 stats_.sent_bytes_second = round(send_rate_tracker_.ComputeRate());
1433 stats_.sent_total_bytes = send_rate_tracker_.TotalSampleCount();
1434 return stats_;
guoweis@webrtc.org930e0042014-11-17 19:42:14 +00001435}
1436
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001437void Connection::MaybeAddPrflxCandidate(ConnectionRequest* request,
1438 StunMessage* response) {
1439 // RFC 5245
1440 // The agent checks the mapped address from the STUN response. If the
1441 // transport address does not match any of the local candidates that the
1442 // agent knows about, the mapped address represents a new candidate -- a
1443 // peer reflexive candidate.
1444 const StunAddressAttribute* addr =
1445 response->GetAddress(STUN_ATTR_XOR_MAPPED_ADDRESS);
1446 if (!addr) {
1447 LOG(LS_WARNING) << "Connection::OnConnectionRequestResponse - "
1448 << "No MAPPED-ADDRESS or XOR-MAPPED-ADDRESS found in the "
1449 << "stun response message";
1450 return;
1451 }
1452
1453 bool known_addr = false;
1454 for (size_t i = 0; i < port_->Candidates().size(); ++i) {
1455 if (port_->Candidates()[i].address() == addr->GetAddress()) {
1456 known_addr = true;
1457 break;
1458 }
1459 }
1460 if (known_addr) {
1461 return;
1462 }
1463
1464 // RFC 5245
1465 // Its priority is set equal to the value of the PRIORITY attribute
1466 // in the Binding request.
1467 const StunUInt32Attribute* priority_attr =
1468 request->msg()->GetUInt32(STUN_ATTR_PRIORITY);
1469 if (!priority_attr) {
1470 LOG(LS_WARNING) << "Connection::OnConnectionRequestResponse - "
1471 << "No STUN_ATTR_PRIORITY found in the "
1472 << "stun response message";
1473 return;
1474 }
Peter Boström0c4e06b2015-10-07 12:23:21 +02001475 const uint32_t priority = priority_attr->value();
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001476 std::string id = rtc::CreateRandomString(8);
1477
1478 Candidate new_local_candidate;
1479 new_local_candidate.set_id(id);
1480 new_local_candidate.set_component(local_candidate().component());
1481 new_local_candidate.set_type(PRFLX_PORT_TYPE);
1482 new_local_candidate.set_protocol(local_candidate().protocol());
1483 new_local_candidate.set_address(addr->GetAddress());
1484 new_local_candidate.set_priority(priority);
1485 new_local_candidate.set_username(local_candidate().username());
1486 new_local_candidate.set_password(local_candidate().password());
1487 new_local_candidate.set_network_name(local_candidate().network_name());
guoweis@webrtc.org950c5182014-12-16 23:01:31 +00001488 new_local_candidate.set_network_type(local_candidate().network_type());
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001489 new_local_candidate.set_related_address(local_candidate().address());
Taylor Brandstetterf7c15a92016-06-22 13:13:55 -07001490 new_local_candidate.set_generation(local_candidate().generation());
Honghai Zhang80f1db92016-01-27 11:54:45 -08001491 new_local_candidate.set_foundation(ComputeFoundation(
1492 PRFLX_PORT_TYPE, local_candidate().protocol(),
1493 local_candidate().relay_protocol(), local_candidate().address()));
honghaiza0c44ea2016-03-23 16:07:48 -07001494 new_local_candidate.set_network_id(local_candidate().network_id());
1495 new_local_candidate.set_network_cost(local_candidate().network_cost());
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001496
1497 // Change the local candidate of this Connection to the new prflx candidate.
1498 local_candidate_index_ = port_->AddPrflxCandidate(new_local_candidate);
1499
1500 // SignalStateChange to force a re-sort in P2PTransportChannel as this
1501 // Connection's local candidate has changed.
1502 SignalStateChange(this);
1503}
1504
Taylor Brandstetterb825aee2016-06-29 13:07:16 -07001505bool Connection::rtt_converged() const {
zhihuang435264a2016-06-21 11:28:38 -07001506 return rtt_samples_ > (RTT_RATIO + 1);
1507}
1508
Taylor Brandstetterb825aee2016-06-29 13:07:16 -07001509bool Connection::missing_responses(int64_t now) const {
zhihuang435264a2016-06-21 11:28:38 -07001510 if (pings_since_last_response_.empty()) {
1511 return false;
1512 }
1513
1514 int64_t waiting = now - pings_since_last_response_[0].sent_time;
1515 return waiting > 2 * rtt();
1516}
1517
deadbeef376e1232015-11-25 09:00:08 -08001518ProxyConnection::ProxyConnection(Port* port,
1519 size_t index,
1520 const Candidate& remote_candidate)
1521 : Connection(port, index, remote_candidate) {}
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001522
1523int ProxyConnection::Send(const void* data, size_t size,
1524 const rtc::PacketOptions& options) {
zhihuang5ecf16c2016-06-01 17:09:15 -07001525 stats_.sent_total_packets++;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001526 int sent = port_->SendTo(data, size, remote_candidate_.address(),
1527 options, true);
1528 if (sent <= 0) {
1529 ASSERT(sent < 0);
1530 error_ = port_->GetError();
zhihuang5ecf16c2016-06-01 17:09:15 -07001531 stats_.sent_discarded_packets++;
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001532 } else {
Tim Psiaki63046262015-09-14 10:38:08 -07001533 send_rate_tracker_.AddSamples(sent);
henrike@webrtc.org269fb4b2014-10-28 22:20:11 +00001534 }
1535 return sent;
1536}
1537
1538} // namespace cricket