| /* |
| * 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. |
| */ |
| |
| #ifndef P2P_BASE_TURN_PORT_H_ |
| #define P2P_BASE_TURN_PORT_H_ |
| |
| #include <stdio.h> |
| |
| #include <map> |
| #include <memory> |
| #include <set> |
| #include <string> |
| #include <vector> |
| |
| #include "absl/memory/memory.h" |
| #include "absl/strings/string_view.h" |
| #include "api/async_dns_resolver.h" |
| #include "api/task_queue/pending_task_safety_flag.h" |
| #include "api/task_queue/task_queue_base.h" |
| #include "p2p/base/port.h" |
| #include "p2p/base/port_allocator.h" |
| #include "p2p/client/relay_port_factory_interface.h" |
| #include "rtc_base/async_packet_socket.h" |
| #include "rtc_base/network/received_packet.h" |
| #include "rtc_base/ssl_certificate.h" |
| |
| namespace webrtc { |
| class TurnCustomizer; |
| } |
| |
| namespace cricket { |
| |
| const int kMaxTurnUsernameLength = 509; // RFC 8489 section 14.3 |
| |
| extern const int STUN_ATTR_TURN_LOGGING_ID; |
| extern const char TURN_PORT_TYPE[]; |
| class TurnAllocateRequest; |
| class TurnEntry; |
| |
| class TurnPort : public Port { |
| public: |
| enum PortState { |
| STATE_CONNECTING, // Initial state, cannot send any packets. |
| STATE_CONNECTED, // Socket connected, ready to send stun requests. |
| STATE_READY, // Received allocate success, can send any packets. |
| STATE_RECEIVEONLY, // Had REFRESH_REQUEST error, cannot send any packets. |
| STATE_DISCONNECTED, // TCP connection died, cannot send/receive any |
| // packets. |
| }; |
| |
| static bool Validate(const CreateRelayPortArgs& args) { |
| // Do basic parameter validation. |
| if (args.config->credentials.username.size() > kMaxTurnUsernameLength) { |
| RTC_LOG(LS_ERROR) << "Attempt to use TURN with a too long username " |
| << "of length " |
| << args.config->credentials.username.size(); |
| return false; |
| } |
| // Do not connect to low-numbered ports. The default STUN port is 3478. |
| if (!AllowedTurnPort(args.server_address->address.port(), |
| args.field_trials)) { |
| RTC_LOG(LS_ERROR) << "Attempt to use TURN to connect to port " |
| << args.server_address->address.port(); |
| return false; |
| } |
| return true; |
| } |
| |
| // Create a TURN port using the shared UDP socket, `socket`. |
| static std::unique_ptr<TurnPort> Create(const CreateRelayPortArgs& args, |
| rtc::AsyncPacketSocket* socket) { |
| if (!Validate(args)) { |
| return nullptr; |
| } |
| // Using `new` to access a non-public constructor. |
| return absl::WrapUnique( |
| new TurnPort({.network_thread = args.network_thread, |
| .socket_factory = args.socket_factory, |
| .network = args.network, |
| .ice_username_fragment = args.username, |
| .ice_password = args.password, |
| .field_trials = args.field_trials}, |
| socket, *args.server_address, args.config->credentials, |
| args.relative_priority, args.config->tls_alpn_protocols, |
| args.config->tls_elliptic_curves, args.turn_customizer, |
| args.config->tls_cert_verifier)); |
| } |
| |
| // Create a TURN port that will use a new socket, bound to `network` and |
| // using a port in the range between `min_port` and `max_port`. |
| static std::unique_ptr<TurnPort> Create(const CreateRelayPortArgs& args, |
| int min_port, |
| int max_port) { |
| if (!Validate(args)) { |
| return nullptr; |
| } |
| // Using `new` to access a non-public constructor. |
| return absl::WrapUnique(new TurnPort( |
| {.network_thread = args.network_thread, |
| .socket_factory = args.socket_factory, |
| .network = args.network, |
| .ice_username_fragment = args.username, |
| .ice_password = args.password, |
| .field_trials = args.field_trials}, |
| min_port, max_port, *args.server_address, args.config->credentials, |
| args.relative_priority, args.config->tls_alpn_protocols, |
| args.config->tls_elliptic_curves, args.turn_customizer, |
| args.config->tls_cert_verifier)); |
| } |
| |
| ~TurnPort() override; |
| |
| const ProtocolAddress& server_address() const { return server_address_; } |
| // Returns an empty address if the local address has not been assigned. |
| rtc::SocketAddress GetLocalAddress() const; |
| |
| bool ready() const { return state_ == STATE_READY; } |
| bool connected() const { |
| return state_ == STATE_READY || state_ == STATE_CONNECTED; |
| } |
| const RelayCredentials& credentials() const { return credentials_; } |
| |
| ProtocolType GetProtocol() const override; |
| |
| virtual TlsCertPolicy GetTlsCertPolicy() const; |
| virtual void SetTlsCertPolicy(TlsCertPolicy tls_cert_policy); |
| |
| void SetTurnLoggingId(absl::string_view turn_logging_id); |
| |
| virtual std::vector<std::string> GetTlsAlpnProtocols() const; |
| virtual std::vector<std::string> GetTlsEllipticCurves() const; |
| |
| // Release a TURN allocation by sending a refresh with lifetime 0. |
| // Sets state to STATE_RECEIVEONLY. |
| void Release(); |
| |
| void PrepareAddress() override; |
| Connection* CreateConnection(const Candidate& c, |
| PortInterface::CandidateOrigin origin) override; |
| int SendTo(const void* data, |
| size_t size, |
| const rtc::SocketAddress& addr, |
| const rtc::PacketOptions& options, |
| bool payload) override; |
| int SetOption(rtc::Socket::Option opt, int value) override; |
| int GetOption(rtc::Socket::Option opt, int* value) override; |
| int GetError() override; |
| |
| bool HandleIncomingPacket(rtc::AsyncPacketSocket* socket, |
| const rtc::ReceivedPacket& packet) override; |
| bool CanHandleIncomingPacketsFrom( |
| const rtc::SocketAddress& addr) const override; |
| |
| // Checks if a connection exists for `addr` before forwarding the call to |
| // the base class. |
| void SendBindingErrorResponse(StunMessage* message, |
| const rtc::SocketAddress& addr, |
| int error_code, |
| absl::string_view reason) override; |
| |
| virtual void OnReadPacket(rtc::AsyncPacketSocket* socket, |
| const rtc::ReceivedPacket& packet); |
| |
| void OnSentPacket(rtc::AsyncPacketSocket* socket, |
| const rtc::SentPacket& sent_packet) override; |
| virtual void OnReadyToSend(rtc::AsyncPacketSocket* socket); |
| bool SupportsProtocol(absl::string_view protocol) const override; |
| |
| void OnSocketConnect(rtc::AsyncPacketSocket* socket); |
| void OnSocketClose(rtc::AsyncPacketSocket* socket, int error); |
| |
| const std::string& hash() const { return hash_; } |
| const std::string& nonce() const { return nonce_; } |
| |
| int error() const { return error_; } |
| |
| void OnAllocateMismatch(); |
| |
| rtc::AsyncPacketSocket* socket() const { return socket_; } |
| StunRequestManager& request_manager() { return request_manager_; } |
| |
| bool HasRequests() { return !request_manager_.empty(); } |
| void set_credentials(const RelayCredentials& credentials) { |
| credentials_ = credentials; |
| } |
| |
| void HandleConnectionDestroyed(Connection* conn) override; |
| |
| void CloseForTest() { Close(); } |
| |
| // TODO(solenberg): Tests should be refactored to not peek at internal state. |
| class CallbacksForTest { |
| public: |
| virtual ~CallbacksForTest() {} |
| virtual void OnTurnCreatePermissionResult(int code) = 0; |
| virtual void OnTurnRefreshResult(int code) = 0; |
| virtual void OnTurnPortClosed() = 0; |
| }; |
| void SetCallbacksForTest(CallbacksForTest* callbacks); |
| |
| protected: |
| TurnPort(const PortParametersRef& args, |
| rtc::AsyncPacketSocket* socket, |
| const ProtocolAddress& server_address, |
| const RelayCredentials& credentials, |
| int server_priority, |
| const std::vector<std::string>& tls_alpn_protocols, |
| const std::vector<std::string>& tls_elliptic_curves, |
| webrtc::TurnCustomizer* customizer, |
| rtc::SSLCertificateVerifier* tls_cert_verifier = nullptr); |
| |
| TurnPort(const PortParametersRef& args, |
| uint16_t min_port, |
| uint16_t max_port, |
| const ProtocolAddress& server_address, |
| const RelayCredentials& credentials, |
| int server_priority, |
| const std::vector<std::string>& tls_alpn_protocols, |
| const std::vector<std::string>& tls_elliptic_curves, |
| webrtc::TurnCustomizer* customizer, |
| rtc::SSLCertificateVerifier* tls_cert_verifier = nullptr); |
| |
| [[deprecated("Pass arguments using PortParametersRef")]] TurnPort( |
| webrtc::TaskQueueBase* thread, |
| rtc::PacketSocketFactory* factory, |
| const rtc::Network* network, |
| rtc::AsyncPacketSocket* socket, |
| absl::string_view username, |
| absl::string_view password, |
| const ProtocolAddress& server_address, |
| const RelayCredentials& credentials, |
| int server_priority, |
| const std::vector<std::string>& tls_alpn_protocols, |
| const std::vector<std::string>& tls_elliptic_curves, |
| webrtc::TurnCustomizer* customizer, |
| rtc::SSLCertificateVerifier* tls_cert_verifier = nullptr, |
| const webrtc::FieldTrialsView* field_trials = nullptr); |
| |
| [[deprecated("Pass arguments using PortParametersRef")]] TurnPort( |
| webrtc::TaskQueueBase* thread, |
| rtc::PacketSocketFactory* factory, |
| const rtc::Network* network, |
| uint16_t min_port, |
| uint16_t max_port, |
| absl::string_view username, |
| absl::string_view password, |
| const ProtocolAddress& server_address, |
| const RelayCredentials& credentials, |
| int server_priority, |
| const std::vector<std::string>& tls_alpn_protocols, |
| const std::vector<std::string>& tls_elliptic_curves, |
| webrtc::TurnCustomizer* customizer, |
| rtc::SSLCertificateVerifier* tls_cert_verifier = nullptr, |
| const webrtc::FieldTrialsView* field_trials = nullptr); |
| |
| // NOTE: This method needs to be accessible for StunPort |
| // return true if entry was created (i.e channel_number consumed). |
| bool CreateOrRefreshEntry(Connection* conn, int channel_number); |
| |
| rtc::DiffServCodePoint StunDscpValue() const override; |
| |
| // Shuts down the turn port, frees requests and deletes connections. |
| void Close(); |
| |
| private: |
| typedef std::map<rtc::Socket::Option, int> SocketOptionsMap; |
| typedef std::set<rtc::SocketAddress> AttemptedServerSet; |
| |
| static bool AllowedTurnPort(int port, |
| const webrtc::FieldTrialsView* field_trials); |
| void TryAlternateServer(); |
| |
| bool CreateTurnClientSocket(); |
| |
| void set_nonce(absl::string_view nonce) { nonce_ = std::string(nonce); } |
| void set_realm(absl::string_view realm); |
| |
| void OnRefreshError(); |
| void HandleRefreshError(); |
| bool SetAlternateServer(const rtc::SocketAddress& address); |
| void ResolveTurnAddress(const rtc::SocketAddress& address); |
| void OnResolveResult(const webrtc::AsyncDnsResolverResult& result); |
| |
| void AddRequestAuthInfo(StunMessage* msg); |
| void OnSendStunPacket(const void* data, size_t size, StunRequest* request); |
| // Stun address from allocate success response. |
| // Currently used only for testing. |
| void OnStunAddress(const rtc::SocketAddress& address); |
| void OnAllocateSuccess(const rtc::SocketAddress& address, |
| const rtc::SocketAddress& stun_address); |
| void OnAllocateError(int error_code, absl::string_view reason); |
| void OnAllocateRequestTimeout(); |
| |
| void HandleDataIndication(const char* data, |
| size_t size, |
| int64_t packet_time_us); |
| void HandleChannelData(uint16_t channel_id, |
| const char* data, |
| size_t size, |
| int64_t packet_time_us); |
| void DispatchPacket(const char* data, |
| size_t size, |
| const rtc::SocketAddress& remote_addr, |
| ProtocolType proto, |
| int64_t packet_time_us); |
| |
| bool ScheduleRefresh(uint32_t lifetime); |
| void SendRequest(StunRequest* request, int delay); |
| int Send(const void* data, size_t size, const rtc::PacketOptions& options); |
| void UpdateHash(); |
| bool UpdateNonce(StunMessage* response); |
| void ResetNonce(); |
| |
| bool HasPermission(const rtc::IPAddress& ipaddr) const; |
| TurnEntry* FindEntry(const rtc::SocketAddress& address) const; |
| TurnEntry* FindEntry(uint16_t channel_id) const; |
| |
| // Marks the connection with remote address `address` failed and |
| // pruned (a.k.a. write-timed-out). Returns true if a connection is found. |
| bool FailAndPruneConnection(const rtc::SocketAddress& address); |
| |
| void MaybeAddTurnLoggingId(StunMessage* message); |
| |
| void TurnCustomizerMaybeModifyOutgoingStunMessage(StunMessage* message); |
| bool TurnCustomizerAllowChannelData(const void* data, |
| size_t size, |
| bool payload); |
| |
| ProtocolAddress server_address_; |
| // Reconstruct the URL of the server which the candidate is gathered from. |
| // A copy needs to be stored as server_address_ will resolve and clear its |
| // hostname field. |
| std::string ReconstructServerUrl(); |
| std::string server_url_; |
| |
| TlsCertPolicy tls_cert_policy_ = TlsCertPolicy::TLS_CERT_POLICY_SECURE; |
| std::vector<std::string> tls_alpn_protocols_; |
| std::vector<std::string> tls_elliptic_curves_; |
| rtc::SSLCertificateVerifier* tls_cert_verifier_; |
| RelayCredentials credentials_; |
| AttemptedServerSet attempted_server_addresses_; |
| |
| rtc::AsyncPacketSocket* socket_; |
| SocketOptionsMap socket_options_; |
| std::unique_ptr<webrtc::AsyncDnsResolverInterface> resolver_; |
| int error_; |
| rtc::DiffServCodePoint stun_dscp_value_; |
| |
| StunRequestManager request_manager_; |
| std::string realm_; // From 401/438 response message. |
| std::string nonce_; // From 401/438 response message. |
| std::string hash_; // Digest of username:realm:password |
| |
| int next_channel_number_; |
| std::vector<std::unique_ptr<TurnEntry>> entries_; |
| |
| PortState state_; |
| // By default the value will be set to 0. This value will be used in |
| // calculating the candidate priority. |
| int server_priority_; |
| |
| // The number of retries made due to allocate mismatch error. |
| size_t allocate_mismatch_retries_; |
| |
| // Optional TurnCustomizer that can modify outgoing messages. Once set, this |
| // must outlive the TurnPort's lifetime. |
| webrtc::TurnCustomizer* turn_customizer_ = nullptr; |
| |
| // Optional TurnLoggingId. |
| // An identifier set by application that is added to TURN_ALLOCATE_REQUEST |
| // and can be used to match client/backend logs. |
| // TODO(jonaso): This should really be initialized in constructor, |
| // but that is currently so terrible. Fix once constructor is changed |
| // to be more easy to work with. |
| std::string turn_logging_id_; |
| |
| webrtc::ScopedTaskSafety task_safety_; |
| |
| CallbacksForTest* callbacks_for_test_ = nullptr; |
| |
| friend class TurnEntry; |
| friend class TurnAllocateRequest; |
| friend class TurnRefreshRequest; |
| friend class TurnCreatePermissionRequest; |
| friend class TurnChannelBindRequest; |
| }; |
| |
| } // namespace cricket |
| |
| #endif // P2P_BASE_TURN_PORT_H_ |