mirror of
https://github.com/resiprocate/resiprocate.git
synced 2026-01-12 00:05:02 +08:00
e5eb4da757
This updates usage of Asio for compatibility with version 1.34 and newer, where a number of previously deprecated APIs were removed.
260 lines
11 KiB
C++
260 lines
11 KiB
C++
#if !defined(Flow_hxx)
|
|
#define Flow_hxx
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include "config.h"
|
|
#endif
|
|
|
|
#include <map>
|
|
#include <rutil/TimeLimitFifo.hxx>
|
|
#include <rutil/Mutex.hxx>
|
|
|
|
#include "Srtp2Helper.hxx"
|
|
|
|
#include "reTurn/client/TurnAsyncUdpSocket.hxx"
|
|
#include "reTurn/client/TurnAsyncTcpSocket.hxx"
|
|
#include "reTurn/client/TurnAsyncTlsSocket.hxx"
|
|
#include "reTurn/client/TurnAsyncSocketHandler.hxx"
|
|
#include "reTurn/StunMessage.hxx"
|
|
#include "FakeSelectSocketDescriptor.hxx"
|
|
#include "dtls_wrapper/DtlsSocket.hxx"
|
|
|
|
#include "FlowContext.hxx"
|
|
#include "RTCPEventLoggingHandler.hxx"
|
|
|
|
#include <memory>
|
|
#include <utility>
|
|
|
|
using namespace reTurn;
|
|
|
|
namespace flowmanager
|
|
{
|
|
|
|
/**
|
|
This class represents a Flow that is created by the Flow Manager. A flow is a
|
|
bi-directional stream of data for communicating with an endpoint, that may use
|
|
UDP, TCP or TLS over TCP. A flow may also use a Turn Allocation to transmit
|
|
data to/from an endpoint.
|
|
|
|
Author: Scott Godin (sgodin AT SipSpectrum DOT com)
|
|
*/
|
|
class MediaStream;
|
|
class Flow;
|
|
|
|
class Flow : public TurnAsyncSocketHandler
|
|
{
|
|
public:
|
|
|
|
static int maxReceiveFifoDuration;
|
|
static int maxReceiveFifoSize;
|
|
|
|
enum FlowState
|
|
{
|
|
Unconnected,
|
|
ConnectingServer,
|
|
Connecting,
|
|
Binding,
|
|
Allocating,
|
|
Connected,
|
|
Ready
|
|
};
|
|
|
|
Flow(asio::io_context& ioService,
|
|
asio::ssl::context& sslContext,
|
|
unsigned int componentId,
|
|
const StunTuple& localBinding,
|
|
MediaStream& mediaStream,
|
|
bool forceCOMedia,
|
|
std::shared_ptr<RTCPEventLoggingHandler> rtcpEventLoggingHandler = nullptr,
|
|
std::shared_ptr<FlowContext> context = nullptr);
|
|
~Flow();
|
|
|
|
void activateFlow(uint8_t allocationProps = StunMessage::PropsNone);
|
|
void activateFlow(uint64_t reservationToken);
|
|
|
|
bool isReady() { return mFlowState == Ready; }
|
|
|
|
/// Returns a socket descriptor that can be used in a select call
|
|
/// WARNING - this descriptor should not be used for any other purpose
|
|
/// - do NOT set socket options, or send, receive from this descriptor,
|
|
/// instead use the Flow api's
|
|
unsigned int getSelectSocketDescriptor();
|
|
|
|
unsigned int getSocketDescriptor(); // returns the real socket descriptor - used to correlate callbacks
|
|
|
|
/// Turn Send Methods
|
|
/// WARNING - if using Secure media, then there must be room at the
|
|
/// end of the passed in buffer for the SRTP HMAC code to be appended
|
|
/// ***It would be good to make this safer***
|
|
void send(char* buffer, unsigned int size);
|
|
void sendTo(const asio::ip::address& address, unsigned short port, char* buffer, unsigned int size);
|
|
void rawSendTo(const asio::ip::address& address, unsigned short port, const char* buffer, unsigned int size);
|
|
|
|
/// Receive Methods
|
|
asio::error_code receive(char* buffer, unsigned int& size, unsigned int timeout, asio::ip::address* sourceAddress=0, unsigned short* sourcePort=0);
|
|
asio::error_code receiveFrom(const asio::ip::address& address, unsigned short port, char* buffer, unsigned int& size, unsigned int timeout);
|
|
|
|
/// Used to set where this flow should be sending to
|
|
void setActiveDestination(const char* address, unsigned short port);
|
|
|
|
/// Dtls-Srtp Methods
|
|
|
|
/// Starts the dtls client handshake process - (must call setActiveDestination first)
|
|
/// Call this method if this client has negotiated the "Active" role via SDP
|
|
void startDtlsClient(const char* address, unsigned short port);
|
|
|
|
/// This method should be called when remote fingerprint is discovered
|
|
/// via SDP negotiation. After this is called only dtls-srtp connections
|
|
/// with a matching fingerprint will be maintained.
|
|
void setRemoteSDPFingerprint(const resip::Data& fingerprint);
|
|
|
|
/// Retrieves the stored remote SDP Fingerprint.
|
|
const resip::Data getRemoteSDPFingerprint();
|
|
|
|
const StunTuple& getLocalTuple();
|
|
StunTuple getSessionTuple(); // returns either local, reflexive, or relay tuple depending on NatTraversalMode
|
|
StunTuple getRelayTuple();
|
|
StunTuple getReflexiveTuple();
|
|
uint64_t getReservationToken();
|
|
unsigned int getComponentId() { return mComponentId; }
|
|
|
|
private:
|
|
asio::io_context& mIOService;
|
|
asio::ssl::context& mSslContext;
|
|
|
|
// Note: these member variables are set at creation time and never changed, thus
|
|
// they do not require mutex protection
|
|
unsigned int mComponentId;
|
|
StunTuple mLocalBinding;
|
|
|
|
// MediaStream that this Flow belongs too
|
|
MediaStream& mMediaStream;
|
|
|
|
// Use peer's RTP source IP instead of the peer's SDP connection IP
|
|
bool mForceCOMedia;
|
|
|
|
// Logging handler, if set
|
|
std::shared_ptr<RTCPEventLoggingHandler> mRtcpEventLoggingHandler;
|
|
|
|
// Flow context from application layer
|
|
std::shared_ptr<FlowContext> mFlowContext;
|
|
|
|
// mTurnSocket has it's own threading protection
|
|
std::shared_ptr<TurnAsyncSocket> mTurnSocket;
|
|
bool mPrivatePeer;
|
|
|
|
// These are only set once, then accessed - thus they do not require mutex protection
|
|
uint8_t mAllocationProps;
|
|
uint64_t mReservationToken;
|
|
|
|
// Mutex to protect the following members that may be get/set from multiple threads
|
|
resip::Mutex mMutex;
|
|
StunTuple mReflexiveTuple;
|
|
StunTuple mRelayTuple;
|
|
resip::Data mRemoteSDPFingerprint;
|
|
asio::ip::address mActiveDestinationAddress;
|
|
unsigned short mActiveDestinationPort;
|
|
|
|
// Map to store all DtlsSockets - in forking cases there can be more than one
|
|
std::map<reTurn::StunTuple, dtls::DtlsSocket*> mDtlsSockets;
|
|
dtls::DtlsSocket* getDtlsSocket(const reTurn::StunTuple& endpoint);
|
|
dtls::DtlsSocket* createDtlsSocketClient(const StunTuple& endpoint);
|
|
dtls::DtlsSocket* createDtlsSocketServer(const StunTuple& endpoint);
|
|
|
|
volatile FlowState mFlowState;
|
|
void changeFlowState(FlowState newState);
|
|
const char* flowStateToString(FlowState state);
|
|
|
|
class ReceivedData
|
|
{
|
|
public:
|
|
ReceivedData(const asio::ip::address& address, unsigned short port, std::shared_ptr<DataBuffer> data) :
|
|
mAddress(address), mPort(port), mData(data) {}
|
|
|
|
asio::ip::address mAddress;
|
|
unsigned short mPort;
|
|
std::shared_ptr<DataBuffer> mData;
|
|
};
|
|
// FIFO for received data
|
|
typedef resip::TimeLimitFifo<ReceivedData> ReceivedDataFifo;
|
|
ReceivedDataFifo mReceivedDataFifo;
|
|
|
|
// Helpers to perform SRTP protection/unprotection
|
|
bool processSendData(char* buffer, unsigned int& size, const asio::ip::address& address, unsigned short port);
|
|
asio::error_code processReceivedData(char* buffer, unsigned int& size, ReceivedData* receivedData, asio::ip::address* sourceAddress=0, unsigned short* sourcePort=0);
|
|
FakeSelectSocketDescriptor mFakeSelectSocketDescriptor;
|
|
|
|
virtual void onConnectSuccess(unsigned int socketDesc, const asio::ip::address& address, unsigned short port);
|
|
virtual void onConnectFailure(unsigned int socketDesc, const asio::error_code& e);
|
|
|
|
virtual void onSharedSecretSuccess(unsigned int socketDesc, const char* username, unsigned int usernameSize, const char* password, unsigned int passwordSize);
|
|
virtual void onSharedSecretFailure(unsigned int socketDesc, const asio::error_code& e);
|
|
|
|
virtual void onBindSuccess(unsigned int socketDesc, const StunTuple& reflexiveTuple, const StunTuple& stunServerTuple);
|
|
virtual void onBindFailure(unsigned int socketDesc, const asio::error_code& e, const StunTuple& stunServerTuple);
|
|
|
|
virtual void onAllocationSuccess(unsigned int socketDesc, const StunTuple& reflexiveTuple, const StunTuple& relayTuple, unsigned int lifetime, unsigned int bandwidth, uint64_t reservationToken);
|
|
virtual void onAllocationFailure(unsigned int socketDesc, const asio::error_code& e);
|
|
|
|
virtual void onRefreshSuccess(unsigned int socketDesc, unsigned int lifetime);
|
|
virtual void onRefreshFailure(unsigned int socketDesc, const asio::error_code& e);
|
|
|
|
virtual void onSetActiveDestinationSuccess(unsigned int socketDesc);
|
|
virtual void onSetActiveDestinationFailure(unsigned int socketDesc, const asio::error_code &e);
|
|
virtual void onClearActiveDestinationSuccess(unsigned int socketDesc);
|
|
virtual void onClearActiveDestinationFailure(unsigned int socketDesc, const asio::error_code &e);
|
|
|
|
virtual void onChannelBindRequestSent(unsigned int socketDesc, unsigned short channelNumber);
|
|
virtual void onChannelBindSuccess(unsigned int socketDesc, unsigned short channelNumber);
|
|
virtual void onChannelBindFailure(unsigned int socketDesc, const asio::error_code& e);
|
|
|
|
//virtual void onReceiveSuccess(unsigned int socketDesc, const asio::ip::address& address, unsigned short port, const char* buffer, unsigned int size);
|
|
virtual void onReceiveSuccess(unsigned int socketDesc, const asio::ip::address& address, unsigned short port, const std::shared_ptr<DataBuffer>& data);
|
|
virtual void onReceiveFailure(unsigned int socketDesc, const asio::error_code& e);
|
|
|
|
virtual void onSendSuccess(unsigned int socketDesc);
|
|
virtual void onSendFailure(unsigned int socketDesc, const asio::error_code& e);
|
|
|
|
virtual void onIncomingBindRequestProcessed(unsigned int socketDesc, const StunTuple& sourceTuple);
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
/* ====================================================================
|
|
|
|
Copyright (c) 2007-2023, SIP Spectrum, Inc. http://sipspectrum.com
|
|
Copyright (c) 2007-2008, Plantronics, Inc.
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:
|
|
|
|
1. Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
|
|
2. Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
|
|
3. Neither the name of Plantronics nor the names of its contributors
|
|
may be used to endorse or promote products derived from this
|
|
software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
==================================================================== */
|