Telegram-Android/TMessagesProj/jni/voip/webrtc/p2p/base/turn_server.cc

882 lines
31 KiB
C++
Raw Normal View History

2020-08-14 18:58:22 +02:00
/*
* Copyright 2012 The WebRTC Project Authors. All rights reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#include "p2p/base/turn_server.h"
2023-02-18 22:24:25 +01:00
#include <algorithm>
2020-08-14 18:58:22 +02:00
#include <memory>
#include <tuple> // for std::tie
#include <utility>
#include "absl/algorithm/container.h"
2021-06-25 02:43:10 +02:00
#include "absl/memory/memory.h"
2023-02-18 22:24:25 +01:00
#include "absl/strings/string_view.h"
#include "api/array_view.h"
2020-08-14 18:58:22 +02:00
#include "api/packet_socket_factory.h"
2023-02-18 22:24:25 +01:00
#include "api/task_queue/task_queue_base.h"
2020-08-14 18:58:22 +02:00
#include "api/transport/stun.h"
#include "p2p/base/async_stun_tcp_socket.h"
#include "rtc_base/byte_buffer.h"
#include "rtc_base/checks.h"
#include "rtc_base/helpers.h"
#include "rtc_base/logging.h"
#include "rtc_base/message_digest.h"
#include "rtc_base/socket_adapters.h"
#include "rtc_base/strings/string_builder.h"
namespace cricket {
2023-02-18 22:24:25 +01:00
namespace {
using ::webrtc::TimeDelta;
2020-08-14 18:58:22 +02:00
// TODO(juberti): Move this all to a future turnmessage.h
// static const int IPPROTO_UDP = 17;
2023-02-18 22:24:25 +01:00
constexpr TimeDelta kNonceTimeout = TimeDelta::Minutes(60);
constexpr TimeDelta kDefaultAllocationTimeout = TimeDelta::Minutes(10);
constexpr TimeDelta kPermissionTimeout = TimeDelta::Minutes(5);
constexpr TimeDelta kChannelTimeout = TimeDelta::Minutes(10);
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
constexpr int kMinChannelNumber = 0x4000;
constexpr int kMaxChannelNumber = 0x7FFF;
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
constexpr size_t kNonceKeySize = 16;
constexpr size_t kNonceSize = 48;
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
constexpr size_t TURN_CHANNEL_HEADER_SIZE = 4U;
2020-08-14 18:58:22 +02:00
// TODO(mallinath) - Move these to a common place.
2023-02-18 22:24:25 +01:00
bool IsTurnChannelData(uint16_t msg_type) {
2020-08-14 18:58:22 +02:00
// The first two bits of a channel data message are 0b01.
return ((msg_type & 0xC000) == 0x4000);
}
2023-02-18 22:24:25 +01:00
} // namespace
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
int GetStunSuccessResponseTypeOrZero(const StunMessage& req) {
const int resp_type = GetStunSuccessResponseType(req.type());
return resp_type == -1 ? 0 : resp_type;
}
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
int GetStunErrorResponseTypeOrZero(const StunMessage& req) {
const int resp_type = GetStunErrorResponseType(req.type());
return resp_type == -1 ? 0 : resp_type;
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
static void InitErrorResponse(int code,
absl::string_view reason,
2020-08-14 18:58:22 +02:00
StunMessage* resp) {
resp->AddAttribute(std::make_unique<cricket::StunErrorCodeAttribute>(
2023-02-18 22:24:25 +01:00
STUN_ATTR_ERROR_CODE, code, std::string(reason)));
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
TurnServer::TurnServer(webrtc::TaskQueueBase* thread)
2020-08-14 18:58:22 +02:00
: thread_(thread),
nonce_key_(rtc::CreateRandomString(kNonceKeySize)),
auth_hook_(NULL),
redirect_hook_(NULL),
enable_otu_nonce_(false) {}
TurnServer::~TurnServer() {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
for (InternalSocketMap::iterator it = server_sockets_.begin();
it != server_sockets_.end(); ++it) {
rtc::AsyncPacketSocket* socket = it->first;
delete socket;
}
for (ServerSocketMap::iterator it = server_listen_sockets_.begin();
it != server_listen_sockets_.end(); ++it) {
2022-03-11 17:49:54 +01:00
rtc::Socket* socket = it->first;
2020-08-14 18:58:22 +02:00
delete socket;
}
}
void TurnServer::AddInternalSocket(rtc::AsyncPacketSocket* socket,
ProtocolType proto) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
RTC_DCHECK(server_sockets_.end() == server_sockets_.find(socket));
server_sockets_[socket] = proto;
socket->SignalReadPacket.connect(this, &TurnServer::OnInternalPacket);
}
2022-03-11 17:49:54 +01:00
void TurnServer::AddInternalServerSocket(
rtc::Socket* socket,
ProtocolType proto,
std::unique_ptr<rtc::SSLAdapterFactory> ssl_adapter_factory) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2022-03-11 17:49:54 +01:00
2020-08-14 18:58:22 +02:00
RTC_DCHECK(server_listen_sockets_.end() ==
server_listen_sockets_.find(socket));
2022-03-11 17:49:54 +01:00
server_listen_sockets_[socket] = {proto, std::move(ssl_adapter_factory)};
2020-08-14 18:58:22 +02:00
socket->SignalReadEvent.connect(this, &TurnServer::OnNewInternalConnection);
}
void TurnServer::SetExternalSocketFactory(
rtc::PacketSocketFactory* factory,
const rtc::SocketAddress& external_addr) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
external_socket_factory_.reset(factory);
external_addr_ = external_addr;
}
2022-03-11 17:49:54 +01:00
void TurnServer::OnNewInternalConnection(rtc::Socket* socket) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
RTC_DCHECK(server_listen_sockets_.find(socket) !=
server_listen_sockets_.end());
AcceptConnection(socket);
}
2022-03-11 17:49:54 +01:00
void TurnServer::AcceptConnection(rtc::Socket* server_socket) {
2020-08-14 18:58:22 +02:00
// Check if someone is trying to connect to us.
rtc::SocketAddress accept_addr;
2022-03-11 17:49:54 +01:00
rtc::Socket* accepted_socket = server_socket->Accept(&accept_addr);
2020-08-14 18:58:22 +02:00
if (accepted_socket != NULL) {
2022-03-11 17:49:54 +01:00
const ServerSocketInfo& info = server_listen_sockets_[server_socket];
if (info.ssl_adapter_factory) {
rtc::SSLAdapter* ssl_adapter =
info.ssl_adapter_factory->CreateAdapter(accepted_socket);
ssl_adapter->StartSSL("");
accepted_socket = ssl_adapter;
}
2020-08-14 18:58:22 +02:00
cricket::AsyncStunTCPSocket* tcp_socket =
2022-03-11 17:49:54 +01:00
new cricket::AsyncStunTCPSocket(accepted_socket);
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
tcp_socket->SubscribeClose(this,
[this](rtc::AsyncPacketSocket* s, int err) {
OnInternalSocketClose(s, err);
});
2020-08-14 18:58:22 +02:00
// Finally add the socket so it can start communicating with the client.
2022-03-11 17:49:54 +01:00
AddInternalSocket(tcp_socket, info.proto);
2020-08-14 18:58:22 +02:00
}
}
void TurnServer::OnInternalSocketClose(rtc::AsyncPacketSocket* socket,
int err) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
DestroyInternalSocket(socket);
}
void TurnServer::OnInternalPacket(rtc::AsyncPacketSocket* socket,
const char* data,
size_t size,
const rtc::SocketAddress& addr,
const int64_t& /* packet_time_us */) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
// Fail if the packet is too small to even contain a channel header.
if (size < TURN_CHANNEL_HEADER_SIZE) {
return;
}
InternalSocketMap::iterator iter = server_sockets_.find(socket);
RTC_DCHECK(iter != server_sockets_.end());
TurnServerConnection conn(addr, iter->second, socket);
uint16_t msg_type = rtc::GetBE16(data);
if (!IsTurnChannelData(msg_type)) {
// This is a STUN message.
HandleStunMessage(&conn, data, size);
} else {
// This is a channel message; let the allocation handle it.
TurnServerAllocation* allocation = FindAllocation(&conn);
if (allocation) {
allocation->HandleChannelData(data, size);
}
if (stun_message_observer_ != nullptr) {
stun_message_observer_->ReceivedChannelData(data, size);
}
}
}
void TurnServer::HandleStunMessage(TurnServerConnection* conn,
const char* data,
size_t size) {
TurnMessage msg;
rtc::ByteBufferReader buf(data, size);
if (!msg.Read(&buf) || (buf.Length() > 0)) {
RTC_LOG(LS_WARNING) << "Received invalid STUN message";
return;
}
if (stun_message_observer_ != nullptr) {
stun_message_observer_->ReceivedMessage(&msg);
}
// If it's a STUN binding request, handle that specially.
if (msg.type() == STUN_BINDING_REQUEST) {
HandleBindingRequest(conn, &msg);
return;
}
if (redirect_hook_ != NULL && msg.type() == STUN_ALLOCATE_REQUEST) {
rtc::SocketAddress address;
if (redirect_hook_->ShouldRedirect(conn->src(), &address)) {
SendErrorResponseWithAlternateServer(conn, &msg, address);
return;
}
}
// Look up the key that we'll use to validate the M-I. If we have an
// existing allocation, the key will already be cached.
TurnServerAllocation* allocation = FindAllocation(conn);
std::string key;
if (!allocation) {
GetKey(&msg, &key);
} else {
key = allocation->key();
}
// Ensure the message is authorized; only needed for requests.
if (IsStunRequestType(msg.type())) {
if (!CheckAuthorization(conn, &msg, data, size, key)) {
return;
}
}
if (!allocation && msg.type() == STUN_ALLOCATE_REQUEST) {
HandleAllocateRequest(conn, &msg, key);
} else if (allocation &&
(msg.type() != STUN_ALLOCATE_REQUEST ||
msg.transaction_id() == allocation->transaction_id())) {
// This is a non-allocate request, or a retransmit of an allocate.
// Check that the username matches the previous username used.
if (IsStunRequestType(msg.type()) &&
2023-02-18 22:24:25 +01:00
msg.GetByteString(STUN_ATTR_USERNAME)->string_view() !=
2020-08-14 18:58:22 +02:00
allocation->username()) {
SendErrorResponse(conn, &msg, STUN_ERROR_WRONG_CREDENTIALS,
STUN_ERROR_REASON_WRONG_CREDENTIALS);
return;
}
allocation->HandleTurnMessage(&msg);
} else {
// Allocation mismatch.
SendErrorResponse(conn, &msg, STUN_ERROR_ALLOCATION_MISMATCH,
STUN_ERROR_REASON_ALLOCATION_MISMATCH);
}
}
bool TurnServer::GetKey(const StunMessage* msg, std::string* key) {
const StunByteStringAttribute* username_attr =
msg->GetByteString(STUN_ATTR_USERNAME);
if (!username_attr) {
return false;
}
2023-02-18 22:24:25 +01:00
return (auth_hook_ != NULL &&
auth_hook_->GetKey(std::string(username_attr->string_view()), realm_,
key));
2020-08-14 18:58:22 +02:00
}
bool TurnServer::CheckAuthorization(TurnServerConnection* conn,
2021-06-25 02:43:10 +02:00
StunMessage* msg,
2020-08-14 18:58:22 +02:00
const char* data,
size_t size,
2023-02-18 22:24:25 +01:00
absl::string_view key) {
2020-08-14 18:58:22 +02:00
// RFC 5389, 10.2.2.
RTC_DCHECK(IsStunRequestType(msg->type()));
const StunByteStringAttribute* mi_attr =
msg->GetByteString(STUN_ATTR_MESSAGE_INTEGRITY);
const StunByteStringAttribute* username_attr =
msg->GetByteString(STUN_ATTR_USERNAME);
const StunByteStringAttribute* realm_attr =
msg->GetByteString(STUN_ATTR_REALM);
const StunByteStringAttribute* nonce_attr =
msg->GetByteString(STUN_ATTR_NONCE);
2021-06-25 02:43:10 +02:00
// Fail if no MESSAGE_INTEGRITY.
2020-08-14 18:58:22 +02:00
if (!mi_attr) {
SendErrorResponseWithRealmAndNonce(conn, msg, STUN_ERROR_UNAUTHORIZED,
STUN_ERROR_REASON_UNAUTHORIZED);
return false;
}
2021-06-25 02:43:10 +02:00
// Fail if there is MESSAGE_INTEGRITY but no username, nonce, or realm.
2020-08-14 18:58:22 +02:00
if (!username_attr || !realm_attr || !nonce_attr) {
SendErrorResponse(conn, msg, STUN_ERROR_BAD_REQUEST,
STUN_ERROR_REASON_BAD_REQUEST);
return false;
}
// Fail if bad nonce.
2023-02-18 22:24:25 +01:00
if (!ValidateNonce(nonce_attr->string_view())) {
2020-08-14 18:58:22 +02:00
SendErrorResponseWithRealmAndNonce(conn, msg, STUN_ERROR_STALE_NONCE,
STUN_ERROR_REASON_STALE_NONCE);
return false;
}
2021-06-25 02:43:10 +02:00
// Fail if bad MESSAGE_INTEGRITY.
2023-02-18 22:24:25 +01:00
if (key.empty() || msg->ValidateMessageIntegrity(std::string(key)) !=
2021-06-25 02:43:10 +02:00
StunMessage::IntegrityStatus::kIntegrityOk) {
2020-08-14 18:58:22 +02:00
SendErrorResponseWithRealmAndNonce(conn, msg, STUN_ERROR_UNAUTHORIZED,
STUN_ERROR_REASON_UNAUTHORIZED);
return false;
}
// Fail if one-time-use nonce feature is enabled.
TurnServerAllocation* allocation = FindAllocation(conn);
if (enable_otu_nonce_ && allocation &&
2023-02-18 22:24:25 +01:00
allocation->last_nonce() == nonce_attr->string_view()) {
2020-08-14 18:58:22 +02:00
SendErrorResponseWithRealmAndNonce(conn, msg, STUN_ERROR_STALE_NONCE,
STUN_ERROR_REASON_STALE_NONCE);
return false;
}
if (allocation) {
2023-02-18 22:24:25 +01:00
allocation->set_last_nonce(nonce_attr->string_view());
2020-08-14 18:58:22 +02:00
}
// Success.
return true;
}
void TurnServer::HandleBindingRequest(TurnServerConnection* conn,
const StunMessage* req) {
2023-02-18 22:24:25 +01:00
StunMessage response(GetStunSuccessResponseTypeOrZero(*req),
req->transaction_id());
2020-08-14 18:58:22 +02:00
// Tell the user the address that we received their request from.
auto mapped_addr_attr = std::make_unique<StunXorAddressAttribute>(
STUN_ATTR_XOR_MAPPED_ADDRESS, conn->src());
response.AddAttribute(std::move(mapped_addr_attr));
SendStun(conn, &response);
}
void TurnServer::HandleAllocateRequest(TurnServerConnection* conn,
const TurnMessage* msg,
2023-02-18 22:24:25 +01:00
absl::string_view key) {
2020-08-14 18:58:22 +02:00
// Check the parameters in the request.
const StunUInt32Attribute* transport_attr =
msg->GetUInt32(STUN_ATTR_REQUESTED_TRANSPORT);
if (!transport_attr) {
SendErrorResponse(conn, msg, STUN_ERROR_BAD_REQUEST,
STUN_ERROR_REASON_BAD_REQUEST);
return;
}
// Only UDP is supported right now.
int proto = transport_attr->value() >> 24;
if (proto != IPPROTO_UDP) {
SendErrorResponse(conn, msg, STUN_ERROR_UNSUPPORTED_PROTOCOL,
STUN_ERROR_REASON_UNSUPPORTED_PROTOCOL);
return;
}
// Create the allocation and let it send the success response.
// If the actual socket allocation fails, send an internal error.
TurnServerAllocation* alloc = CreateAllocation(conn, proto, key);
if (alloc) {
alloc->HandleTurnMessage(msg);
} else {
SendErrorResponse(conn, msg, STUN_ERROR_SERVER_ERROR,
"Failed to allocate socket");
}
}
std::string TurnServer::GenerateNonce(int64_t now) const {
// Generate a nonce of the form hex(now + HMAC-MD5(nonce_key_, now))
std::string input(reinterpret_cast<const char*>(&now), sizeof(now));
2023-02-18 22:24:25 +01:00
std::string nonce = rtc::hex_encode(input);
2020-08-14 18:58:22 +02:00
nonce += rtc::ComputeHmac(rtc::DIGEST_MD5, nonce_key_, input);
RTC_DCHECK(nonce.size() == kNonceSize);
return nonce;
}
2023-02-18 22:24:25 +01:00
bool TurnServer::ValidateNonce(absl::string_view nonce) const {
2020-08-14 18:58:22 +02:00
// Check the size.
if (nonce.size() != kNonceSize) {
return false;
}
// Decode the timestamp.
int64_t then;
char* p = reinterpret_cast<char*>(&then);
2023-02-18 22:24:25 +01:00
size_t len = rtc::hex_decode(rtc::ArrayView<char>(p, sizeof(then)),
nonce.substr(0, sizeof(then) * 2));
2020-08-14 18:58:22 +02:00
if (len != sizeof(then)) {
return false;
}
// Verify the HMAC.
if (nonce.substr(sizeof(then) * 2) !=
rtc::ComputeHmac(rtc::DIGEST_MD5, nonce_key_,
std::string(p, sizeof(then)))) {
return false;
}
// Validate the timestamp.
2023-02-18 22:24:25 +01:00
return TimeDelta::Millis(rtc::TimeMillis() - then) < kNonceTimeout;
2020-08-14 18:58:22 +02:00
}
TurnServerAllocation* TurnServer::FindAllocation(TurnServerConnection* conn) {
AllocationMap::const_iterator it = allocations_.find(*conn);
return (it != allocations_.end()) ? it->second.get() : nullptr;
}
TurnServerAllocation* TurnServer::CreateAllocation(TurnServerConnection* conn,
int proto,
2023-02-18 22:24:25 +01:00
absl::string_view key) {
2020-08-14 18:58:22 +02:00
rtc::AsyncPacketSocket* external_socket =
(external_socket_factory_)
? external_socket_factory_->CreateUdpSocket(external_addr_, 0, 0)
: NULL;
if (!external_socket) {
return NULL;
}
// The Allocation takes ownership of the socket.
TurnServerAllocation* allocation =
new TurnServerAllocation(this, thread_, *conn, external_socket, key);
allocations_[*conn].reset(allocation);
return allocation;
}
void TurnServer::SendErrorResponse(TurnServerConnection* conn,
const StunMessage* req,
int code,
2023-02-18 22:24:25 +01:00
absl::string_view reason) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2023-02-18 22:24:25 +01:00
TurnMessage resp(GetStunErrorResponseTypeOrZero(*req), req->transaction_id());
InitErrorResponse(code, reason, &resp);
2020-08-14 18:58:22 +02:00
RTC_LOG(LS_INFO) << "Sending error response, type=" << resp.type()
<< ", code=" << code << ", reason=" << reason;
SendStun(conn, &resp);
}
void TurnServer::SendErrorResponseWithRealmAndNonce(TurnServerConnection* conn,
const StunMessage* msg,
int code,
2023-02-18 22:24:25 +01:00
absl::string_view reason) {
TurnMessage resp(GetStunErrorResponseTypeOrZero(*msg), msg->transaction_id());
InitErrorResponse(code, reason, &resp);
2020-08-14 18:58:22 +02:00
int64_t timestamp = rtc::TimeMillis();
if (ts_for_next_nonce_) {
timestamp = ts_for_next_nonce_;
ts_for_next_nonce_ = 0;
}
resp.AddAttribute(std::make_unique<StunByteStringAttribute>(
STUN_ATTR_NONCE, GenerateNonce(timestamp)));
resp.AddAttribute(
std::make_unique<StunByteStringAttribute>(STUN_ATTR_REALM, realm_));
SendStun(conn, &resp);
}
void TurnServer::SendErrorResponseWithAlternateServer(
TurnServerConnection* conn,
const StunMessage* msg,
const rtc::SocketAddress& addr) {
2023-02-18 22:24:25 +01:00
TurnMessage resp(GetStunErrorResponseTypeOrZero(*msg), msg->transaction_id());
InitErrorResponse(STUN_ERROR_TRY_ALTERNATE,
2020-08-14 18:58:22 +02:00
STUN_ERROR_REASON_TRY_ALTERNATE_SERVER, &resp);
resp.AddAttribute(
std::make_unique<StunAddressAttribute>(STUN_ATTR_ALTERNATE_SERVER, addr));
SendStun(conn, &resp);
}
void TurnServer::SendStun(TurnServerConnection* conn, StunMessage* msg) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
rtc::ByteBufferWriter buf;
// Add a SOFTWARE attribute if one is set.
if (!software_.empty()) {
msg->AddAttribute(std::make_unique<StunByteStringAttribute>(
STUN_ATTR_SOFTWARE, software_));
}
msg->Write(&buf);
Send(conn, buf);
}
void TurnServer::Send(TurnServerConnection* conn,
const rtc::ByteBufferWriter& buf) {
2021-06-25 02:43:10 +02:00
RTC_DCHECK_RUN_ON(thread_);
2020-08-14 18:58:22 +02:00
rtc::PacketOptions options;
conn->socket()->SendTo(buf.Data(), buf.Length(), conn->src(), options);
}
2023-02-18 22:24:25 +01:00
void TurnServer::DestroyAllocation(TurnServerAllocation* allocation) {
2020-08-14 18:58:22 +02:00
// Removing the internal socket if the connection is not udp.
rtc::AsyncPacketSocket* socket = allocation->conn()->socket();
InternalSocketMap::iterator iter = server_sockets_.find(socket);
// Skip if the socket serving this allocation is UDP, as this will be shared
// by all allocations.
// Note: We may not find a socket if it's a TCP socket that was closed, and
// the allocation is only now timing out.
if (iter != server_sockets_.end() && iter->second != cricket::PROTO_UDP) {
DestroyInternalSocket(socket);
}
2023-02-18 22:24:25 +01:00
allocations_.erase(*(allocation->conn()));
2020-08-14 18:58:22 +02:00
}
void TurnServer::DestroyInternalSocket(rtc::AsyncPacketSocket* socket) {
InternalSocketMap::iterator iter = server_sockets_.find(socket);
if (iter != server_sockets_.end()) {
rtc::AsyncPacketSocket* socket = iter->first;
2023-02-18 22:24:25 +01:00
socket->UnsubscribeClose(this);
2020-08-14 18:58:22 +02:00
socket->SignalReadPacket.disconnect(this);
server_sockets_.erase(iter);
2021-06-25 02:43:10 +02:00
std::unique_ptr<rtc::AsyncPacketSocket> socket_to_delete =
absl::WrapUnique(socket);
2020-08-14 18:58:22 +02:00
// We must destroy the socket async to avoid invalidating the sigslot
// callback list iterator inside a sigslot callback. (In other words,
// deleting an object from within a callback from that object).
2023-02-18 22:24:25 +01:00
thread_->PostTask([socket_to_delete = std::move(socket_to_delete)] {});
2020-08-14 18:58:22 +02:00
}
}
TurnServerConnection::TurnServerConnection(const rtc::SocketAddress& src,
ProtocolType proto,
rtc::AsyncPacketSocket* socket)
: src_(src),
dst_(socket->GetRemoteAddress()),
proto_(proto),
socket_(socket) {}
bool TurnServerConnection::operator==(const TurnServerConnection& c) const {
return src_ == c.src_ && dst_ == c.dst_ && proto_ == c.proto_;
}
bool TurnServerConnection::operator<(const TurnServerConnection& c) const {
return std::tie(src_, dst_, proto_) < std::tie(c.src_, c.dst_, c.proto_);
}
std::string TurnServerConnection::ToString() const {
const char* const kProtos[] = {"unknown", "udp", "tcp", "ssltcp"};
rtc::StringBuilder ost;
ost << src_.ToSensitiveString() << "-" << dst_.ToSensitiveString() << ":"
<< kProtos[proto_];
return ost.Release();
}
TurnServerAllocation::TurnServerAllocation(TurnServer* server,
2023-02-18 22:24:25 +01:00
webrtc::TaskQueueBase* thread,
2020-08-14 18:58:22 +02:00
const TurnServerConnection& conn,
rtc::AsyncPacketSocket* socket,
2023-02-18 22:24:25 +01:00
absl::string_view key)
2020-08-14 18:58:22 +02:00
: server_(server),
thread_(thread),
conn_(conn),
external_socket_(socket),
key_(key) {
external_socket_->SignalReadPacket.connect(
this, &TurnServerAllocation::OnExternalPacket);
}
TurnServerAllocation::~TurnServerAllocation() {
2023-02-18 22:24:25 +01:00
channels_.clear();
perms_.clear();
2020-08-14 18:58:22 +02:00
RTC_LOG(LS_INFO) << ToString() << ": Allocation destroyed";
}
std::string TurnServerAllocation::ToString() const {
rtc::StringBuilder ost;
ost << "Alloc[" << conn_.ToString() << "]";
return ost.Release();
}
void TurnServerAllocation::HandleTurnMessage(const TurnMessage* msg) {
RTC_DCHECK(msg != NULL);
switch (msg->type()) {
case STUN_ALLOCATE_REQUEST:
HandleAllocateRequest(msg);
break;
case TURN_REFRESH_REQUEST:
HandleRefreshRequest(msg);
break;
case TURN_SEND_INDICATION:
HandleSendIndication(msg);
break;
case TURN_CREATE_PERMISSION_REQUEST:
HandleCreatePermissionRequest(msg);
break;
case TURN_CHANNEL_BIND_REQUEST:
HandleChannelBindRequest(msg);
break;
default:
// Not sure what to do with this, just eat it.
RTC_LOG(LS_WARNING) << ToString()
<< ": Invalid TURN message type received: "
<< msg->type();
}
}
void TurnServerAllocation::HandleAllocateRequest(const TurnMessage* msg) {
// Copy the important info from the allocate request.
transaction_id_ = msg->transaction_id();
const StunByteStringAttribute* username_attr =
msg->GetByteString(STUN_ATTR_USERNAME);
RTC_DCHECK(username_attr != NULL);
2023-02-18 22:24:25 +01:00
username_ = std::string(username_attr->string_view());
2020-08-14 18:58:22 +02:00
// Figure out the lifetime and start the allocation timer.
2023-02-18 22:24:25 +01:00
TimeDelta lifetime = ComputeLifetime(*msg);
PostDeleteSelf(lifetime);
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
RTC_LOG(LS_INFO) << ToString() << ": Created allocation with lifetime="
<< lifetime.seconds();
2020-08-14 18:58:22 +02:00
// We've already validated all the important bits; just send a response here.
2023-02-18 22:24:25 +01:00
TurnMessage response(GetStunSuccessResponseTypeOrZero(*msg),
msg->transaction_id());
2020-08-14 18:58:22 +02:00
auto mapped_addr_attr = std::make_unique<StunXorAddressAttribute>(
STUN_ATTR_XOR_MAPPED_ADDRESS, conn_.src());
auto relayed_addr_attr = std::make_unique<StunXorAddressAttribute>(
STUN_ATTR_XOR_RELAYED_ADDRESS, external_socket_->GetLocalAddress());
2023-02-18 22:24:25 +01:00
auto lifetime_attr = std::make_unique<StunUInt32Attribute>(
STUN_ATTR_LIFETIME, lifetime.seconds());
2020-08-14 18:58:22 +02:00
response.AddAttribute(std::move(mapped_addr_attr));
response.AddAttribute(std::move(relayed_addr_attr));
response.AddAttribute(std::move(lifetime_attr));
SendResponse(&response);
}
void TurnServerAllocation::HandleRefreshRequest(const TurnMessage* msg) {
// Figure out the new lifetime.
2023-02-18 22:24:25 +01:00
TimeDelta lifetime = ComputeLifetime(*msg);
2020-08-14 18:58:22 +02:00
// Reset the expiration timer.
2023-02-18 22:24:25 +01:00
safety_.reset();
PostDeleteSelf(lifetime);
2020-08-14 18:58:22 +02:00
RTC_LOG(LS_INFO) << ToString()
2023-02-18 22:24:25 +01:00
<< ": Refreshed allocation, lifetime=" << lifetime.seconds();
2020-08-14 18:58:22 +02:00
// Send a success response with a LIFETIME attribute.
2023-02-18 22:24:25 +01:00
TurnMessage response(GetStunSuccessResponseTypeOrZero(*msg),
msg->transaction_id());
2020-08-14 18:58:22 +02:00
2023-02-18 22:24:25 +01:00
auto lifetime_attr = std::make_unique<StunUInt32Attribute>(
STUN_ATTR_LIFETIME, lifetime.seconds());
2020-08-14 18:58:22 +02:00
response.AddAttribute(std::move(lifetime_attr));
SendResponse(&response);
}
void TurnServerAllocation::HandleSendIndication(const TurnMessage* msg) {
// Check mandatory attributes.
const StunByteStringAttribute* data_attr = msg->GetByteString(STUN_ATTR_DATA);
const StunAddressAttribute* peer_attr =
msg->GetAddress(STUN_ATTR_XOR_PEER_ADDRESS);
if (!data_attr || !peer_attr) {
RTC_LOG(LS_WARNING) << ToString() << ": Received invalid send indication";
return;
}
// If a permission exists, send the data on to the peer.
if (HasPermission(peer_attr->GetAddress().ipaddr())) {
SendExternal(data_attr->bytes(), data_attr->length(),
peer_attr->GetAddress());
} else {
RTC_LOG(LS_WARNING) << ToString()
<< ": Received send indication without permission"
" peer="
<< peer_attr->GetAddress().ToSensitiveString();
}
}
void TurnServerAllocation::HandleCreatePermissionRequest(
const TurnMessage* msg) {
// Check mandatory attributes.
const StunAddressAttribute* peer_attr =
msg->GetAddress(STUN_ATTR_XOR_PEER_ADDRESS);
if (!peer_attr) {
SendBadRequestResponse(msg);
return;
}
if (server_->reject_private_addresses_ &&
rtc::IPIsPrivate(peer_attr->GetAddress().ipaddr())) {
SendErrorResponse(msg, STUN_ERROR_FORBIDDEN, STUN_ERROR_REASON_FORBIDDEN);
return;
}
// Add this permission.
AddPermission(peer_attr->GetAddress().ipaddr());
RTC_LOG(LS_INFO) << ToString() << ": Created permission, peer="
<< peer_attr->GetAddress().ToSensitiveString();
// Send a success response.
2023-02-18 22:24:25 +01:00
TurnMessage response(GetStunSuccessResponseTypeOrZero(*msg),
msg->transaction_id());
2020-08-14 18:58:22 +02:00
SendResponse(&response);
}
void TurnServerAllocation::HandleChannelBindRequest(const TurnMessage* msg) {
// Check mandatory attributes.
const StunUInt32Attribute* channel_attr =
msg->GetUInt32(STUN_ATTR_CHANNEL_NUMBER);
const StunAddressAttribute* peer_attr =
msg->GetAddress(STUN_ATTR_XOR_PEER_ADDRESS);
if (!channel_attr || !peer_attr) {
SendBadRequestResponse(msg);
return;
}
// Check that channel id is valid.
int channel_id = channel_attr->value() >> 16;
if (channel_id < kMinChannelNumber || channel_id > kMaxChannelNumber) {
SendBadRequestResponse(msg);
return;
}
// Check that this channel id isn't bound to another transport address, and
// that this transport address isn't bound to another channel id.
2023-02-18 22:24:25 +01:00
auto channel1 = FindChannel(channel_id);
auto channel2 = FindChannel(peer_attr->GetAddress());
2020-08-14 18:58:22 +02:00
if (channel1 != channel2) {
SendBadRequestResponse(msg);
return;
}
// Add or refresh this channel.
2023-02-18 22:24:25 +01:00
if (channel1 == channels_.end()) {
channel1 = channels_.insert(
channels_.end(), {.id = channel_id, .peer = peer_attr->GetAddress()});
2020-08-14 18:58:22 +02:00
} else {
2023-02-18 22:24:25 +01:00
channel1->pending_delete.reset();
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
thread_->PostDelayedTask(
SafeTask(channel1->pending_delete.flag(),
[this, channel1] { channels_.erase(channel1); }),
kChannelTimeout);
2020-08-14 18:58:22 +02:00
// Channel binds also refresh permissions.
AddPermission(peer_attr->GetAddress().ipaddr());
RTC_LOG(LS_INFO) << ToString() << ": Bound channel, id=" << channel_id
<< ", peer=" << peer_attr->GetAddress().ToSensitiveString();
// Send a success response.
2023-02-18 22:24:25 +01:00
TurnMessage response(GetStunSuccessResponseTypeOrZero(*msg),
msg->transaction_id());
2020-08-14 18:58:22 +02:00
SendResponse(&response);
}
void TurnServerAllocation::HandleChannelData(const char* data, size_t size) {
// Extract the channel number from the data.
uint16_t channel_id = rtc::GetBE16(data);
2023-02-18 22:24:25 +01:00
auto channel = FindChannel(channel_id);
if (channel != channels_.end()) {
2020-08-14 18:58:22 +02:00
// Send the data to the peer address.
SendExternal(data + TURN_CHANNEL_HEADER_SIZE,
2023-02-18 22:24:25 +01:00
size - TURN_CHANNEL_HEADER_SIZE, channel->peer);
2020-08-14 18:58:22 +02:00
} else {
RTC_LOG(LS_WARNING) << ToString()
<< ": Received channel data for invalid channel, id="
<< channel_id;
}
}
void TurnServerAllocation::OnExternalPacket(
rtc::AsyncPacketSocket* socket,
const char* data,
size_t size,
const rtc::SocketAddress& addr,
const int64_t& /* packet_time_us */) {
RTC_DCHECK(external_socket_.get() == socket);
2023-02-18 22:24:25 +01:00
auto channel = FindChannel(addr);
if (channel != channels_.end()) {
2020-08-14 18:58:22 +02:00
// There is a channel bound to this address. Send as a channel message.
rtc::ByteBufferWriter buf;
2023-02-18 22:24:25 +01:00
buf.WriteUInt16(channel->id);
2020-08-14 18:58:22 +02:00
buf.WriteUInt16(static_cast<uint16_t>(size));
buf.WriteBytes(data, size);
server_->Send(&conn_, buf);
} else if (!server_->enable_permission_checks_ ||
HasPermission(addr.ipaddr())) {
// No channel, but a permission exists. Send as a data indication.
2023-02-18 22:24:25 +01:00
TurnMessage msg(TURN_DATA_INDICATION);
2020-08-14 18:58:22 +02:00
msg.AddAttribute(std::make_unique<StunXorAddressAttribute>(
STUN_ATTR_XOR_PEER_ADDRESS, addr));
msg.AddAttribute(
std::make_unique<StunByteStringAttribute>(STUN_ATTR_DATA, data, size));
server_->SendStun(&conn_, &msg);
} else {
RTC_LOG(LS_WARNING)
<< ToString() << ": Received external packet without permission, peer="
<< addr.ToSensitiveString();
}
}
2023-02-18 22:24:25 +01:00
TimeDelta TurnServerAllocation::ComputeLifetime(const TurnMessage& msg) {
if (const StunUInt32Attribute* attr = msg.GetUInt32(STUN_ATTR_LIFETIME)) {
return std::min(TimeDelta::Seconds(static_cast<int>(attr->value())),
kDefaultAllocationTimeout);
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
return kDefaultAllocationTimeout;
2020-08-14 18:58:22 +02:00
}
bool TurnServerAllocation::HasPermission(const rtc::IPAddress& addr) {
2023-02-18 22:24:25 +01:00
return FindPermission(addr) != perms_.end();
2020-08-14 18:58:22 +02:00
}
void TurnServerAllocation::AddPermission(const rtc::IPAddress& addr) {
2023-02-18 22:24:25 +01:00
auto perm = FindPermission(addr);
if (perm == perms_.end()) {
perm = perms_.insert(perms_.end(), {.peer = addr});
2020-08-14 18:58:22 +02:00
} else {
2023-02-18 22:24:25 +01:00
perm->pending_delete.reset();
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
thread_->PostDelayedTask(SafeTask(perm->pending_delete.flag(),
[this, perm] { perms_.erase(perm); }),
kPermissionTimeout);
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
TurnServerAllocation::PermissionList::iterator
TurnServerAllocation::FindPermission(const rtc::IPAddress& addr) {
return absl::c_find_if(perms_,
[&](const Permission& p) { return p.peer == addr; });
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
TurnServerAllocation::ChannelList::iterator TurnServerAllocation::FindChannel(
int channel_id) {
return absl::c_find_if(channels_,
[&](const Channel& c) { return c.id == channel_id; });
2020-08-14 18:58:22 +02:00
}
2023-02-18 22:24:25 +01:00
TurnServerAllocation::ChannelList::iterator TurnServerAllocation::FindChannel(
const rtc::SocketAddress& addr) {
return absl::c_find_if(channels_,
[&](const Channel& c) { return c.peer == addr; });
2020-08-14 18:58:22 +02:00
}
void TurnServerAllocation::SendResponse(TurnMessage* msg) {
// Success responses always have M-I.
msg->AddMessageIntegrity(key_);
server_->SendStun(&conn_, msg);
}
void TurnServerAllocation::SendBadRequestResponse(const TurnMessage* req) {
SendErrorResponse(req, STUN_ERROR_BAD_REQUEST, STUN_ERROR_REASON_BAD_REQUEST);
}
void TurnServerAllocation::SendErrorResponse(const TurnMessage* req,
int code,
2023-02-18 22:24:25 +01:00
absl::string_view reason) {
2020-08-14 18:58:22 +02:00
server_->SendErrorResponse(&conn_, req, code, reason);
}
void TurnServerAllocation::SendExternal(const void* data,
size_t size,
const rtc::SocketAddress& peer) {
rtc::PacketOptions options;
external_socket_->SendTo(data, size, peer, options);
}
2023-02-18 22:24:25 +01:00
void TurnServerAllocation::PostDeleteSelf(TimeDelta delay) {
auto delete_self = [this] {
RTC_DCHECK_RUN_ON(server_->thread_);
server_->DestroyAllocation(this);
};
thread_->PostDelayedTask(SafeTask(safety_.flag(), std::move(delete_self)),
delay);
2020-08-14 18:58:22 +02:00
}
} // namespace cricket