|
Bayonne2 / Common C++ 2 Framework
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Bayonne2 / Common C++ 2 Framework
|
GNU ccRTP extension to support GNU ZRTP. More...
#include <ZrtpQueue.h>
Public Types | |
| enum | Tos { tosBestEffort, tosEnhanced } |
| rtp.h cc++/rtp.h More... | |
Public Member Functions | |
| int32_t | initialize (const char *zidFilename, bool autoEnable=true, ZrtpConfigure *config=NULL) |
| Initialize the ZrtpQueue. More... | |
| void | setEnableZrtp (bool onOff) |
| Enable or disable ZRTP processing. More... | |
| bool | isEnableZrtp () |
| Return the state of ZRTP enable state. More... | |
| void | SASVerified () |
| Set SAS as verified. More... | |
| void | resetSASVerified () |
| Reset the SAS verfied flag for the current user's retained secrets. More... | |
| void | goClearOk () |
| To confirm a go clear request. More... | |
| void | requestGoClear () |
| Request to switch off secure mode. More... | |
| void | setAuxSecret (uint8_t *data, int32_t length) |
| Set the auxilliary secret. More... | |
| void | setUserCallback (ZrtpUserCallback *ucb) |
| Set the application's callback class. More... | |
| void | setClientId (std::string id) |
| Set the client ID for ZRTP Hello message. More... | |
| std::string | getHelloHash () |
| Get the ZRTP Hello Hash data. More... | |
| std::string | getPeerHelloHash () |
| Get the peer's ZRTP Hello Hash data. More... | |
| std::string | getMultiStrParams () |
| Get Multi-stream parameters. More... | |
| void | setMultiStrParams (std::string parameters) |
| Set Multi-stream parameters. More... | |
| bool | isMultiStream () |
| Check if this ZRTP use Multi-stream. More... | |
| bool | isMultiStreamAvailable () |
| Check if the other ZRTP client supports Multi-stream. More... | |
| void | acceptEnrollment (bool accepted) |
| Accept a PBX enrollment request. More... | |
| std::string | getSasType () |
| Get the commited SAS rendering algorithm for this ZRTP session. More... | |
| uint8_t * | getSasHash () |
| Get the computed SAS hash for this ZRTP session. More... | |
| bool | sendSASRelayPacket (uint8_t *sh, std::string render) |
| Send the SAS relay packet. More... | |
| bool | isMitmMode () |
| Check the state of the MitM mode flag. More... | |
| void | setMitmMode (bool mitmMode) |
| Set the state of the MitM mode flag. More... | |
| void | setParanoidMode (bool yesNo) |
| Enable or disable paranoid mode. More... | |
| bool | isParanoidMode () |
| Check status of paranoid mode. More... | |
| bool | isEnrollmentMode () |
| Check the state of the enrollment mode. More... | |
| void | setEnrollmentMode (bool enrollmentMode) |
| Check the state of the enrollment mode. More... | |
| void | setPBXEnrollment (bool enrollmentMode) |
| Backwards compatible api fix... More... | |
| bool | isPeerEnrolled () |
| Check if a peer's cache entry has a vaild MitM key. More... | |
| void | setSignSas (bool sasSignMode) |
| Set the state of the SAS signature mode flag. More... | |
| bool | setSignatureData (uint8 *data, int32 length) |
| Set signature data. More... | |
| const uint8 * | getSignatureData () |
| Get signature data. More... | |
| int32 | getSignatureLength () |
| Get length of signature data. More... | |
| void | putData (uint32 stamp, const unsigned char *data=NULL, size_t len=0) |
| Put data into the RTP output queue. More... | |
| void | sendImmediate (uint32 stamp, const unsigned char *data=NULL, size_t len=0) |
| Immediatly send a data packet. More... | |
| void | startZrtp () |
| Starts the ZRTP protocol engine. More... | |
| void | stopZrtp () |
| Stops the ZRTP protocol engine. More... | |
| int32 | getPeerZid (uint8 *data) |
| Get other party's ZID (ZRTP Identifier) data. More... | |
| void | setControlBandwidth (float fraction) |
| Specify the bandwith available for control (RTCP) packets. More... | |
| float | getControlBandwidth () const |
| RTCPSenderInfo * | getMRSenderInfo (SyncSource &src) |
| Get the most recent sender report received from a synchronization source. More... | |
| RTCPReceiverInfo * | getMRReceiverInfo (SyncSource &srcFrom) |
| Ask for the info in the most recent receiver report about the local source received from the source given as parameter. More... | |
| void | setLeavingDelay (microtimeout_t delay) |
| Set how much time the stack will wait before deleting a synchronization source that has sent an RTCP BYE packet. More... | |
| void | setEnd2EndDelay (microtimeout_t t) |
| This method sets the maximum end to end delay allowed. More... | |
| microtimeout_t | getDefaultEnd2EndDelay () const |
| microtimeout_t | getEnd2EndDelay () const |
| void | setSendersControlFraction (float fraction) |
| Specify the fraction of the total control bandwith to be dedicated to senders reports. More... | |
| void | setMinRTCPInterval (microtimeout_t interval) |
| Manually set the minimum interval for sending RTP compound packets. More... | |
| uint32 | getSendRTCPPacketCount () const |
| Get the total number of RTCP packets sent until now. More... | |
| void | setSDESItem (Participant *part, SDESItemType item, const std::string &val) |
| void | setPRIVPrefix (Participant *part, const std::string val) |
| void | setTypeOfService (Tos tos) |
| Specify the kind of service the application expects to use. More... | |
| void | enableStack () |
| Enable packet queue processing in the stack. More... | |
| void | disableStack () |
| Disable packet queue processing in the stack. More... | |
| bool | isActive () const |
| Get active connection state flag. More... | |
| uint32 | getCurrentTimestamp () const |
| Get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time. More... | |
| void | setSessionBandwidth (uint32 bw) |
| Specify the bandwidth of the current session. More... | |
| uint32 | getDefaultSessionBandwidth () const |
| uint32 | getSessionBandwidth () const |
| void | setTimeclock () |
| Set the packet timeclock for synchronizing timestamps. More... | |
| timeout_t | getTimeclock () const |
| Get the packet timeclock for synchronizing timestamps. More... | |
| SyncSourcesIterator | begin () |
| SyncSourcesIterator | end () |
| const AppDataUnit * | getData (uint32 stamp, const SyncSource *src=NULL) |
| Retreive data from a specific timestamped packet if such a packet is currently available in the receive buffer. More... | |
| bool | isWaiting (const SyncSource *src=NULL) const |
| Determine if packets are waiting in the reception queue. More... | |
| uint32 | getFirstTimestamp (const SyncSource *src=NULL) const |
| Get timestamp of first packet waiting in the queue. More... | |
| void | setMinValidPacketSequence (uint8 packets) |
| When receiving packets from a new source, it may be convenient to reject a first few packets before we are really sure the source is valid. More... | |
| uint8 | getDefaultMinValidPacketSequence () const |
| uint8 | getMinValidPacketSequence () const |
| Get the minimun number of consecutive packets that must be received from a source before accepting its data packets. More... | |
| void | setMaxPacketMisorder (uint16 packets) |
| uint16 | getDefaultMaxPacketMisorder () const |
| uint16 | getMaxPacketMisorder () const |
| void | setMaxPacketDropout (uint16 packets) |
| It also prevents packets sent after a restart of the source being immediately accepted. More... | |
| uint16 | getDefaultMaxPacketDropout () const |
| uint16 | getMaxPacketDropout () const |
| void | setInQueueCryptoContext (CryptoContext *cc) |
| Set input queue CryptoContext. More... | |
| void | removeInQueueCryptoContext (CryptoContext *cc) |
| Remove input queue CryptoContext. More... | |
| CryptoContext * | getInQueueCryptoContext (uint32 ssrc) |
| Get an input queue CryptoContext identified by SSRC. More... | |
| size_t | getDefaultMaxRecvPacketSize () const |
| size_t | getMaxRecvPacketSize () const |
| void | setMaxRecvPacketSize (size_t maxsize) |
| bool | setPayloadFormat (const PayloadFormat &pf) |
| Set the payload format in use, for timing and payload type identification purposes. More... | |
| uint32 | getLocalSSRC () const |
| uint32 | getCurrentRTPClockRate () const |
| Get the clock rate in RTP clock units (for instance, 8000 units per second for PCMU, or 90000 units per second for MP2T). More... | |
| PayloadType | getCurrentPayloadType () const |
| timeval | getInitialTime () const |
| bool | addDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) |
| bool | addDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) |
| bool | forgetDestination (const InetHostAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) |
| bool | forgetDestination (const InetMcastAddress &ia, tpport_t dataPort=DefaultRTPDataPort, tpport_t controlPort=0) |
| void | addContributor (uint32 csrc) |
| Add csrc as the CSRC identifier of a new contributor. More... | |
| bool | removeContributor (uint32 csrc) |
| Remove CSRC from the list of contributors. More... | |
| bool | isSending () const |
| Determine if outgoing packets are waiting to send. More... | |
| void | setPadding (uint8 paddinglen) |
| Set padding. More... | |
| void | setMark (bool mark) |
| Set marker bit for the packet in which the next data provided will be send. More... | |
| bool | getMark () const |
| Get wheter the mark bit will be set in the next packet. More... | |
| size_t | setPartial (uint32 timestamp, unsigned char *data, size_t offset, size_t max) |
| Set partial data for an already queued packet. More... | |
| microtimeout_t | getDefaultSchedulingTimeout () const |
| void | setSchedulingTimeout (microtimeout_t to) |
| Set the default scheduling timeout to use when no data packets are waiting to be sent. More... | |
| microtimeout_t | getDefaultExpireTimeout () const |
| void | setExpireTimeout (microtimeout_t to) |
| Set the "expired" timer for expiring packets pending in the send queue which have gone unsent and are already "too late" to be sent now. More... | |
| microtimeout_t | getExpireTimeout () const |
| uint32 | getSendPacketCount () const |
| Get the total number of packets sent so far. More... | |
| uint32 | getSendOctetCount () const |
| Get the total number of octets (payload only) sent so far. More... | |
| uint16 | getSequenceNumber () const |
| Get the sequence number of the next outgoing packet. More... | |
| void | setOutQueueCryptoContext (CryptoContext *cc) |
| Set ouput queue CryptoContext. More... | |
| void | removeOutQueueCryptoContext (CryptoContext *cc) |
| Remove output queue CryptoContext. More... | |
| CryptoContext * | getOutQueueCryptoContext (uint32 ssrc) |
| Get an output queue CryptoContext identified by SSRC. More... | |
| size_t | getDefaultMaxSendSegmentSize () |
| void | setMaxSendSegmentSize (size_t size) |
| Set maximum payload segment size before fragmenting sends. More... | |
| size_t | getMaxSendSegmentSize () |
Static Public Member Functions | |
| static size_t | getDefaultMembersSize () |
Protected Types | |
| enum | { defaultPathMTU = 1500 } |
Protected Member Functions | |
| virtual bool | onSRTPPacketError (IncomingRTPPkt &pkt, int32 errorCode) |
| A hook that gets called if the decoding of an incoming SRTP was erroneous. More... | |
| void | handleTimeout (const std::string &c) |
| Handle timeout event forwarded by the TimeoutProvider. More... | |
| virtual size_t | takeInDataPacket () |
| This function is used by the service thread to process the next incoming packet and place it in the receive list. More... | |
| int32_t | sendDataZRTP (const unsigned char *data, int32_t length) |
| int32_t | activateTimer (int32_t time) |
| Activate timer. More... | |
| int32_t | cancelTimer () |
| Cancel the active timer. More... | |
| void | sendInfo (GnuZrtpCodes::MessageSeverity severity, int32_t subCode) |
| Send information messages to the hosting environment. More... | |
| bool | srtpSecretsReady (SrtpSecret_t *secrets, EnableSecurity part) |
| SRTP crypto data ready for the sender or receiver. More... | |
| void | srtpSecretsOff (EnableSecurity part) |
| Switch off the security for the defined part. More... | |
| void | srtpSecretsOn (std::string c, std::string s, bool verified) |
| Switch on the security. More... | |
| void | handleGoClear () |
| This method handles GoClear requests. More... | |
| void | zrtpNegotiationFailed (GnuZrtpCodes::MessageSeverity severity, int32_t subCode) |
| Handle ZRTP negotiation failed. More... | |
| void | zrtpNotSuppOther () |
| ZRTP calls this method if the other side does not support ZRTP. More... | |
| void | synchEnter () |
| Enter synchronization mutex. More... | |
| void | synchLeave () |
| Leave synchronization mutex. More... | |
| void | zrtpAskEnrollment (GnuZrtpCodes::InfoEnrollment info) |
| Inform about a PBX enrollment request. More... | |
| void | zrtpInformEnrollment (GnuZrtpCodes::InfoEnrollment info) |
| Inform about PBX enrollment result. More... | |
| void | signSAS (uint8_t *sasHash) |
| Request a SAS signature. More... | |
| bool | checkSASSignature (uint8_t *sasHash) |
| ZRTPQueue calls this method to request a SAS signature check. More... | |
| ZrtpQueue (uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) | |
| ZrtpQueue (uint32 ssrc, uint32 size=RTPDataQueue::defaultMembersHashSize, RTPApplication &app=defaultApplication()) | |
| Local SSRC is given instead of computed by the queue. More... | |
| virtual | ~ZrtpQueue () |
| const RTPApplication & | getApplication () |
| void | controlTransmissionService () |
| Build and send RTCP packets following timing rules (including the "timer reconsideration" algorithm). More... | |
| void | controlReceptionService () |
| Process incoming RTCP packets pending in the control reception socket. More... | |
| bool | checkSSRCInRTCPPkt (SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp) |
| Appy collision and loop detection and correction algorithm when receiving RTCP packets. More... | |
| void | endQueueRTCPManager () |
| virtual void | onGotSR (SyncSource &source, SendReport &SR, uint8 blocks) |
| Plug-in for processing (acquire information carried in) an incoming RTCP Sender Report. More... | |
| virtual void | onGotRR (SyncSource &source, RecvReport &RR, uint8 blocks) |
| Plug-in for processing (acquire information carried in) an incoming RTCP Receiver Report. More... | |
| bool | onGotSDES (SyncSource &source, RTCPPacket &pkt) |
| virtual bool | onGotSDESChunk (SyncSource &source, SDESChunk &chunk, size_t len) |
| Plug-in for handling of SDES chunks. More... | |
| virtual void | onGotAPP (SyncSource &, RTCPCompoundHandler::APPPacket &, size_t) |
| Plug-in for handling of APP (application specific) RTCP packets. More... | |
| timeval | getRTCPCheckInterval () |
| uint32 | getLastSendPacketCount () const |
| Get the number of data packets sent at the time the last SR was generated. More... | |
| void | setPrevMembersNum (uint32 n) |
| uint32 | getPrevMembersCount () const |
| size_t | dispatchBYE (const std::string &reason) |
| This method is used to send an RTCP BYE packet. More... | |
| size_t | sendControlToDestinations (unsigned char *buffer, size_t len) |
| virtual void | timerTick () |
| A plugin point for timer tick driven events. More... | |
| void | renewLocalSSRC () |
| void | endQueue () |
| This method ends the queue. More... | |
| virtual bool | isPendingData (microtimeout_t timeout)=0 |
| This function is used to check for and schedule against arriving packets based on the derived connection type. More... | |
| bool | checkSSRCInIncomingRTPPkt (SyncSourceLink &sourceLink, bool is_new, InetAddress &na, tpport_t tp) |
| Apply collision and loop detection and correction algorithm when receiving RTP data packets. More... | |
| void | setSourceExpirationPeriod (uint8 intervals) |
| Set the number of RTCP intervals that the stack will wait to change the state of a source from stateActive to stateInactive, or to delete the source after being in stateInactive. More... | |
| IncomingDataQueue::IncomingRTPPktLink * | getWaiting (uint32 timestamp, const SyncSource *src=NULL) |
| This is used to fetch a packet in the receive queue and to expire packets older than the current timestamp. More... | |
| bool | recordReception (SyncSourceLink &srcLink, const IncomingRTPPkt &pkt, const timeval recvtime) |
| Log reception of a new RTP packet from this source. More... | |
| void | recordExtraction (const IncomingRTPPkt &pkt) |
| Log extraction of a packet from this source from the scheduled reception queue. More... | |
| void | purgeIncomingQueue () |
| virtual void | onNewSyncSource (const SyncSource &) |
| Virtual called when a new synchronization source has joined the session. More... | |
| virtual bool | onRTPPacketRecv (IncomingRTPPkt &) |
| A virtual function to support parsing of arriving packets to determine if they should be kept in the queue and to dispatch events. More... | |
| virtual void | onExpireRecv (IncomingRTPPkt &) |
| A hook to filter packets in the receive queue that are being expired. More... | |
| bool | insertRecvPacket (IncomingRTPPktLink *packetLink) |
| Insert a just received packet in the queue (both general and source specific queues). More... | |
| virtual size_t | recvData (unsigned char *buffer, size_t length, InetHostAddress &host, tpport_t &port)=0 |
| This function performs the physical I/O for reading a packet from the source. More... | |
| virtual size_t | getNextDataPacketSize () const =0 |
| void | setLocalSSRC (uint32 ssrc) |
| uint32 | getLocalSSRCNetwork () const |
| size_t | getDefaultMembersHashSize () |
| SyncSourceLink * | getLink (const SyncSource &source) const |
| bool | isMine (const SyncSource &source) const |
| Get whether a synchronization source is recorded in this membership controller. More... | |
| bool | isRegistered (uint32 ssrc) |
| Returns whether there is already a synchronizacion source with "ssrc" SSRC identifier. More... | |
| SyncSourceLink * | getSourceBySSRC (uint32 ssrc, bool &created) |
Get the description of a source by its ssrc identifier. More... | |
| bool | BYESource (uint32 ssrc) |
Mark the source identified by ssrc as having sent a BYE packet. More... | |
| bool | removeSource (uint32 ssrc) |
Remove the description of the source identified by ssrc More... | |
| SyncSourceLink * | getFirst () |
| SyncSourceLink * | getLast () |
| uint32 | getMembersCount () |
| void | setMembersCount (uint32 n) |
| uint32 | getSendersCount () |
| void | setLink (SyncSource &source, void *link) |
| void | setParticipant (SyncSource &source, Participant &p) |
| void | setState (SyncSource &source, SyncSource::State ns) |
| void | setSender (SyncSource &source, bool active) |
| void | setDataTransportPort (SyncSource &source, tpport_t p) |
| void | setControlTransportPort (SyncSource &source, tpport_t p) |
| void | setNetworkAddress (SyncSource &source, InetAddress addr) |
| void | addParticipant (RTPApplication &app, Participant &part) |
| void | removeParticipant (RTPApplication &app, RTPApplication::ParticipantLink *pl) |
| ConflictingTransportAddress * | searchDataConflict (InetAddress na, tpport_t dtp) |
| ConflictingTransportAddress * | searchControlConflict (InetAddress na, tpport_t ctp) |
| void | updateConflict (ConflictingTransportAddress &ca) |
| void | addConflict (const InetAddress &na, tpport_t dtp, tpport_t ctp) |
| void | dispatchImmediate (OutgoingRTPPkt *packet) |
| This is used to write the RTP data packet to one or more destinations. More... | |
| microtimeout_t | getSchedulingTimeout () |
| This computes the timeout period for scheduling transmission of the next packet at the "head" of the send buffer. More... | |
| size_t | dispatchDataPacket () |
| This function is used by the service thread to process the next outgoing packet pending in the sending queue. More... | |
| void | setNextSeqNum (uint32 seqNum) |
| For thoses cases in which the application requires a method to set the sequence number for the outgoing stream (such as for implementing the RTSP PLAY command). More... | |
| uint32 | getCurrentSeqNum (void) |
| void | setInitialTimestamp (uint32 ts) |
| uint32 | getInitialTimestamp () |
| void | purgeOutgoingQueue () |
| virtual void | setControlPeer (const InetAddress &host, tpport_t port) |
| bool | isSingleDestination () const |
| Get whether there is only a destination in the list. More... | |
| TransportAddress * | getFirstDestination () const |
| void | lockDestinationList () const |
| void | unlockDestinationList () const |
| void | writeLockDestinationList () const |
| bool | addDestinationToList (const InetAddress &ia, tpport_t data, tpport_t control) |
| Locks the object before modifying it. More... | |
| bool | removeDestinationFromList (const InetAddress &ia, tpport_t dataPort, tpport_t controlPort) |
| Locks the object before modifying it. More... | |
| void | setPathMTU (uint16 mtu) |
| uint16 | getPathMTU () |
| bool | checkCompoundRTCPHeader (size_t len) |
| Perform RTCP compound packet header validity check as specified in draft-ietv-avt-rtp-new. More... | |
Protected Attributes | |
| ThreadLock | recvLock |
| IncomingRTPPktLink * | recvFirst |
| IncomingRTPPktLink * | recvLast |
| uint8 | minValidPacketSequence |
| uint16 | maxPacketMisorder |
| uint16 | maxPacketDropout |
| uint8 | sourceExpirationPeriod |
| Mutex | cryptoMutex |
| Mutex | cryptoMutex |
| std::list< CryptoContext * > | cryptoContexts |
| std::list< CryptoContext * > | cryptoContexts |
| ConflictingTransportAddress * | firstConflict |
| ConflictingTransportAddress * | lastConflict |
| std::list< TransportAddress * > | destList |
| unsigned char * | rtcpSendBuffer |
| unsigned char * | rtcpRecvBuffer |
Static Protected Attributes | |
| static const uint8 | defaultMinValidPacketSequence |
| static const uint16 | defaultMaxPacketMisorder |
| static const uint16 | defaultMaxPacketDropout |
| static const size_t | defaultMembersSize |
| static const size_t | defaultMembersHashSize |
| static const uint32 | SEQNUMMOD |
Private Member Functions | |
| void | init () |
| size_t | rtpDataPacket (unsigned char *packet, int32 rtn, InetHostAddress network_address, tpport_t transport_port) |
| virtual int32_t | sendDataZRTP (const uint8_t *data, int32_t length)=0 |
| Send a ZRTP packet via RTP. More... | |
Private Attributes | |
| ZRtp * | zrtpEngine |
| ZrtpUserCallback * | zrtpUserCallback |
| std::string | clientIdString |
| bool | enableZrtp |
| int32 | secureParts |
| int16 | senderZrtpSeqNo |
| ost::Mutex | synchLock |
| uint32 | peerSSRC |
| bool | started |
| bool | mitmMode |
| bool | signSas |
| bool | enableParanoidMode |
Friends | |
| class | TimeoutProvider< std::string, ost::ZrtpQueue * > |
GNU ccRTP extension to support GNU ZRTP.
ZRTP was developed by Phil Zimmermann and provides functions to negotiate keys and other necessary data (crypto data) to set-up the Secure RTP (SRTP) crypto context. Refer to Phil's ZRTP specification at his Zfone project site to get more detailed imformation about the capabilities of ZRTP.
Short overview of the ZRTP implementation
ZRTP is a specific protocol to negotiate encryption algorithms and the required key material. ZRTP uses a RTP session to exchange its protocol messages.
A complete GNU ZRTP implementation consists of two parts, the GNU ZRTP core and specific code that binds the GNU ZRTP core to the underlying RTP/SRTP stack and the operating system:
The GNU ZRTP core uses a callback interface class (refer to ZrtpCallback) to access RTP/SRTP or operating specific methods, for example to send data via the RTP/SRTP stack, to access timers, provide mutex handling, and to report events to the application.
The ZrtpQueue
ZrtpQueue implements code that is specific to the GNU ccRTP implementation. ZrtpQueue also implements the specific code to provide the mutex and timeout handling to the GNU ZRTP core. Both, the mutex and the timeout handling, use the GNU Common C++ library to stay independent of the operating seystem. For more information refer to the GNU Common C++ web site.
To perform its tasks ZrtpQueue
After instantiating a GNU ZRTP session (see below for a short example) applications may use the ZRTP specific methods of ZrtpQueue to control and setup GNU ZRTP, for example enable or disable ZRTP processing or getting ZRTP status information.
GNU ZRTP provides a ZrtpUserCallback class that an application may extend and register with ZrtpQueue. GNU ZRTP and ZrtpQueue use the ZrtpUserCallback methods to report ZRTP events to the application. The application may display this information to the user or act otherwise.
The following figure depicts the relationships between ZrtpQueue, ccRTP RTP/SRTP implementation, the GNU ZRTP core, and an application that provides an ZrtpUserCallback class.
+----------+
| ccRTP |
| RTP/SRTP |
| |
+----------+
^
| extends
|
+----------------+ +-----+------+
| Application | | | +-----------------+
| instantiates | uses | ZrtpQueue | uses | |
| a ZRTP Session +------+ implements +------+ GNU ZRTP |
| and provides | |ZrtpCallback| | core |
|ZrtpUserCallback| | | | implementation |
+----------------+ +------------+ | (ZRtp et al) |
| |
+-----------------+
Because ZrtpQueue extends the ccRTP RTP/SRTP implementation (AVPQueue) all public methods defined by ccRTP are also available for a ZRTP session. ZrtpQueue overwrites some of the public methods of ccRTP (AVPQueue) to implement ZRTP specific code.
GNU ZRTP provides a SymmetricZRTPSession type to simplify its use. An application uses this type in the same way as it would use the normal ccRTP SymmetricRTPSession type. The following short code snippets show how an application could instantiate ccRTP and GNU ZRTP sessions. The first snippet shows how to instantiate a ccRTP session:
The same code as above but using a GNU ZRTP session this time:
The only differences are the different include statements and the different session types.
The demo folder contains a small example that shows how to use GNU ZRTP.
Please refer to the GNU ccRTP documentation for a description of ccRTP methods and functions. This ZrtpQueue documentation shows the ZRTP specific extensions and describes overloaded methods and a possible different behaviour.
Definition at line 187 of file ZrtpQueue.h.
|
protectedinherited |
|
inherited |
rtp.h cc++/rtp.h
Type of network service the application uses.
If the application uses enhanced network service, for instance Integrated Services or Differentiated Services, it has not to ensure fair competition with TCP, provided that the requested service is actually being delivered. Whenever the application uses best-effort service or the requested enhanced service is not actually being delivered, it has to ensure fair competition with TCP. By default, best-effot is assumed.
| Enumerator | |
|---|---|
| tosBestEffort |
Best-effort network service. |
| tosEnhanced |
Enhanced network service. |
|
protected |
|
protected |
Local SSRC is given instead of computed by the queue.
|
protectedvirtual |
| void ZrtpQueue::acceptEnrollment | ( | bool | accepted | ) |
Accept a PBX enrollment request.
If a PBX service asks to enroll the MiTM key and the user accepts this requtes, for example by pressing an OK button, the client application shall call this method and set the parameter accepted to true. If the user does not accept the request set the parameter to false.
| accepted | True if the enrollment request is accepted, false otherwise. |
|
protectedvirtual |
Activate timer.
| time | The time in ms for the timer |
Implements ZrtpCallback.
|
inherited |
|
inherited |
Add csrc as the CSRC identifier of a new contributor.
This method adds the CSRC identifier to a list of contributors that will be inserted in every packet enqueued from now on.
|
inherited |
|
inherited |
|
protectedinherited |
Locks the object before modifying it.
|
inlineinherited |
|
inlineinherited |
|
protectedinherited |
Mark the source identified by ssrc as having sent a BYE packet.
It is not deleted until a timeout expires, so that in case some packets from this source arrive a bit later the source is not inserted again in the table of known sources.
|
protectedvirtual |
Cancel the active timer.
Implements ZrtpCallback.
|
protectedinherited |
Perform RTCP compound packet header validity check as specified in draft-ietv-avt-rtp-new.
This method follows appendix A.2. Correct version, payload type, padding bit and length of every RTCP packet in the compound are verified.
| len | length of the RTCP compound packet in the reception buffer |
|
protectedvirtual |
ZRTPQueue calls this method to request a SAS signature check.
After ZRTP received a SAS signature in one of the Confirm packets it call this method. The client may use getSignatureLength() and getSignatureData()of ZrtpQueue to get the signature data and perform the signature check. Refer to chapter 8.2 of ZRTP specification.
If the signature check fails the client may return false to ZRTP. In this case ZRTP signals an error to the other peer and terminates the ZRTP handshake.
Note: SAS signing is not yet fully supported by GNU ZRTP.
| sasHash | The SAS hash that was signed by the other peer. |
Implements ZrtpCallback.
|
protectedinherited |
Apply collision and loop detection and correction algorithm when receiving RTP data packets.
Follows section 8.2 in draft-ietf-avt-rtp-new.
| sourceLink | link to the source object. |
| is_new | whether the source has been just recorded. |
| na | data packet network address. |
| tp | data packet source transport port. |
|
protectedinherited |
Appy collision and loop detection and correction algorithm when receiving RTCP packets.
Follows section 8.2 in draft-ietf-avp-rtp-new.
| sourceLink | link to the source object. |
| is_new | whether the source has been just recorded. |
| na | RTCP packet network address. |
| tp | RTCP packet source transport port. |
|
protectedinherited |
Process incoming RTCP packets pending in the control reception socket.
|
protectedinherited |
Build and send RTCP packets following timing rules (including the "timer reconsideration" algorithm).
|
inlineinherited |
|
protectedvirtualinherited |
This method is used to send an RTCP BYE packet.
An RTCP BYE packet is sent when one of the the following circumstances occur:
Try to post a BYE message. It will send a BYE packet as long as at least one RTP or RTCP packet has been sent before. If the number of members in the session is more than 50, the algorithm described in section 6.3.7 of RFC 3550 is applied in order to avoid a flood of BYE messages.
| reason | reason to specify in the BYE packet. |
Reimplemented from RTPQueueBase.
|
protectedinherited |
This function is used by the service thread to process the next outgoing packet pending in the sending queue.
|
protectedinherited |
This is used to write the RTP data packet to one or more destinations.
It is used by both sendImmediate and by dispatchDataPacket.
| RTP | packet to send. |
|
inlineinherited |
|
inlineinherited |
|
protectedinherited |
This method ends the queue.
|
protectedinherited |
|
inherited |
|
inherited |
|
inlineprotectedinherited |
|
inlineinherited |
|
inlineinherited |
Definition at line 201 of file queuebase.h.
|
inlineinherited |
Get the clock rate in RTP clock units (for instance, 8000 units per second for PCMU, or 90000 units per second for MP2T).
This value depends on what payload format has been selected using setPayloadFormat().
Definition at line 198 of file queuebase.h.
|
inlineprotectedinherited |
|
inherited |
Get the timestamp that should be given for a packet whose payload sampling instant corresponds to the current system time.
The timestamp applications should provide for each packet represents the sampling instant of its payload and should not be a reading of the system clock. Nevertheless, the internal operation of the RTP stack relies on the accuracy of the provided timestamp, since several computations assume that there is a certain degree of correspondence between the timestamp and the system clock.
It is recommended that applications use this method in order to periodically adjust the RTP timestamp.
In particular, it is advisable getting the timestamp corresponding to the first sampling instant or any instant after a period of inactivity through a call to this method.
Applications should use the nominal sampling or any other value provided by the coder in order to compute the next timestamps with minimum computational requirement.
For instance, an application using an RTP profile that specifies a fixed sampling rate of 8 Khz with eight bits per sample, continuously transmitting audio blocks 80 octets long, would transmit 100 packets every second. Every packet would carry a timestamp 80 units greater than the previous one. So, the first timestamp would be obtained from this method, whereas the following ones would be computed adding 80 every time. Also the timestamp should be increased for every block whether it is put in the queue or dropped.
The aforementioned increment can be obtained from the RTPDataQueue::getTimestampIncrement() method rather than computing it by hand in the application.
|
inherited |
Retreive data from a specific timestamped packet if such a packet is currently available in the receive buffer.
| stamp | Data unit timestamp. |
| src | Optional synchronization source selector. |
| null | pointer if no packet with such timestamp is available. |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Definition at line 301 of file queuebase.h.
|
inlineinherited |
Definition at line 262 of file queuebase.h.
|
inlineinherited |
|
inlinestaticinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineprotectedinherited |
|
inlineinherited |
|
inherited |
Get timestamp of first packet waiting in the queue.
| src | optional source selector. |
| std::string ZrtpQueue::getHelloHash | ( | ) |
Get the ZRTP Hello Hash data.
Use this method to get the ZRTP Hello Hash data. The method returns the data as a string containing hex-digits. Refer to ZRTP specification, chapter 9.1.
|
inlineinherited |
Definition at line 204 of file queuebase.h.
|
inlineprotectedinherited |
|
inherited |
Get an input queue CryptoContext identified by SSRC.
| ssrc | Request CryptoContext for this incoming SSRC |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineinherited |
Definition at line 187 of file queuebase.h.
|
inlineprotectedinherited |
Definition at line 217 of file queuebase.h.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Definition at line 305 of file queuebase.h.
|
inlineinherited |
Definition at line 276 of file queuebase.h.
|
inlineprotectedinherited |
|
inlineinherited |
|
inherited |
Ask for the info in the most recent receiver report about the local source received from the source given as parameter.
| srcFrom | Source of the receiver info. |
| NULL | when no receiver report has been received from the specified source. |
|
inherited |
Get the most recent sender report received from a synchronization source.
| src | Synchronization source of the sender info. |
| NULL | when no sender report has been received from the specified source. |
| std::string ZrtpQueue::getMultiStrParams | ( | ) |
Get Multi-stream parameters.
Use this method to get the Multi-stream that were computed during the ZRTP handshake. An application may use these parameters to enable multi-stream processing for an associated SRTP session.
Refer to chapter 5.4.2 in the ZRTP specification for further details and restriction how and when to use multi-stream mode.
|
protectedpure virtualinherited |
Implemented in RTPDuplex.
|
inherited |
Get an output queue CryptoContext identified by SSRC.
| ssrc | Request CryptoContext for this incoming SSRC |
| std::string ZrtpQueue::getPeerHelloHash | ( | ) |
Get the peer's ZRTP Hello Hash data.
Use this method to get the peer's ZRTP Hello Hash data. The method returns the data as a string containing the ZRTP protocol version and hex-digits.
The peer's hello hash is available only after ZRTP received a hello. If no data is available the function returns an empty string.
Refer to ZRTP specification, chapter 8.
| int32 ZrtpQueue::getPeerZid | ( | uint8 * | data | ) |
Get other party's ZID (ZRTP Identifier) data.
This functions returns the other party's ZID that was receivied during ZRTP processing.
The ZID data can be retrieved after ZRTP receive the first Hello packet from the other party. The application may call this method for example during SAS processing in showSAS(...) user callback method.
| data | Pointer to a data buffer. This buffer must have a size of at least 12 bytes (96 bit) (ZRTP Identifier, see chap. 4.9) |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
| uint8_t* ZrtpQueue::getSasHash | ( | ) |
Get the computed SAS hash for this ZRTP session.
A PBX ZRTP back-to-Back function uses this function to get the SAS hash of an enrolled client to construct the SAS relay packet for the other client.
| std::string ZrtpQueue::getSasType | ( | ) |
Get the commited SAS rendering algorithm for this ZRTP session.
|
protectedinherited |
This computes the timeout period for scheduling transmission of the next packet at the "head" of the send buffer.
If no packets are waiting, a default timeout is used. This actually forms the "isPending()" timeout of the rtp receiver in the service thread.
|
inlineprotectedinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
| const uint8* ZrtpQueue::getSignatureData | ( | ) |
Get signature data.
This functions returns signature data that was receivied during ZRTP processing. Refer to chapters 6.7 and 8.2.
| int32 ZrtpQueue::getSignatureLength | ( | ) |
Get length of signature data.
This functions returns the length of signature data that was receivied during ZRTP processing. Refer to chapters 6.7 and 8.2.
|
protectedinherited |
Get the description of a source by its ssrc identifier.
| ssrc | SSRC identifier, in host order. |
| created | whether a new source has been created. |
ssrc.
|
inlineinherited |
|
protectedinherited |
This is used to fetch a packet in the receive queue and to expire packets older than the current timestamp.
| timestamp | timestamp requested. |
| src | optional source selector |
| void ZrtpQueue::goClearOk | ( | ) |
To confirm a go clear request.
Call this method if the user confirmed a go clear (secure mode off).
|
protectedvirtual |
This method handles GoClear requests.
According to the ZRTP specification the user must be informed about a GoClear request because the ZRTP implementation switches off security if it could authenticate the GoClear packet.
Note: GoClear is not yet implemented in GNU ZRTP.
Implements ZrtpCallback.
|
protected |
Handle timeout event forwarded by the TimeoutProvider.
Just call the ZRTP engine for further processing.
|
private |
| int32_t ZrtpQueue::initialize | ( | const char * | zidFilename, |
| bool | autoEnable = true, |
||
| ZrtpConfigure * | config = NULL |
||
| ) |
Initialize the ZrtpQueue.
Before an application can use ZRTP it has to initialize the ZRTP implementation. This method initializes the timeout thread and opens a file that contains ZRTP specific information such as the applications ZID (ZRTP id) and its retained shared secrets.
If one application requires several ZRTP sessions all sessions use the same timeout thread and use the same ZID file. Therefore an application does not need to do any synchronisation regading ZID files or timeouts. This is managed by the ZRTP implementation.
The current implementation of ZrtpQueue does not support different ZID files for one application instance. This restriction may be removed in later versions.
The application may specify its own ZID file name. If no ZID file name is specified it defaults to $HOME/.GNUccRTP.zid if the HOME environment variable is set. If it is not set the current directory is used.
If the method could set up the timeout thread and open the ZID file then it enables ZRTP processing and returns.
| zidFilename | The name of the ZID file, can be a relative or absolut filename. |
| autoEnable | if set to true the method automatically sets enableZrtp to true. This enables the ZRTP auto-sense mode. Default is true. |
| config | this parameter points to ZRTP configuration data. If it is NULL then ZrtpQueue uses a default setting. Default is NULL. |
|
protectedinherited |
Insert a just received packet in the queue (both general and source specific queues).
If the packet was already in the queue (same SSRC and sequence number), it is not inserted but deleted.
| packetLink | link to a packet just received and generally validated and processed by onRTPPacketRecv. |
| false | when the packet is duplicated (there is already a packet from the same source with the same timestamp). |
| true | when the packet is not duplicated. |
|
inlineinherited |
| bool ZrtpQueue::isEnableZrtp | ( | ) |
Return the state of ZRTP enable state.
true if ZRTP processing is enabled, false otherwise. | bool ZrtpQueue::isEnrollmentMode | ( | ) |
Check the state of the enrollment mode.
If true then we will set the enrollment flag (E) in the confirm packets and performs the enrollment actions. A MitM (PBX) enrollment service sets this flagstarted this ZRTP session. Can be set to true only if mitmMode is also true.
|
inlineprotectedinherited |
| bool ZrtpQueue::isMitmMode | ( | ) |
Check the state of the MitM mode flag.
If true then this ZRTP session acts as MitM, usually enabled by a PBX client (user agent)
| bool ZrtpQueue::isMultiStream | ( | ) |
Check if this ZRTP use Multi-stream.
Use this method to check if this ZRTP instance uses multi-stream. Even if the application provided multi-stram parameters it may happen that full DH mode was used. Refer to chapters 5.2 and 5.4.2 in the ZRTP # when this may happen.
| bool ZrtpQueue::isMultiStreamAvailable | ( | ) |
Check if the other ZRTP client supports Multi-stream.
Use this method to check if the other ZRTP client supports Multi-stream mode.
| bool ZrtpQueue::isParanoidMode | ( | ) |
Check status of paranoid mode.
| bool ZrtpQueue::isPeerEnrolled | ( | ) |
Check if a peer's cache entry has a vaild MitM key.
If true then the other peer ha a valid MtiM key, i.e. the peer has performed the enrollment procedure. A PBX ZRTP Back-2-Back application can use this function to check which of the peers is enrolled.
|
protectedpure virtualinherited |
This function is used to check for and schedule against arriving packets based on the derived connection type.
| number | of microseconds to wait. |
Implemented in RTPDuplex.
|
protectedinherited |
Returns whether there is already a synchronizacion source with "ssrc" SSRC identifier.
|
inherited |
Determine if outgoing packets are waiting to send.
|
inlineinherited |
|
inherited |
Determine if packets are waiting in the reception queue.
| src | Optional synchronization source selector. |
|
inlineinherited |
|
inlineprotectedvirtualinherited |
|
inlineprotectedvirtualinherited |
|
protectedvirtualinherited |
Plug-in for processing (acquire information carried in) an incoming RTCP Receiver Report.
The default implementation in this class only processes the receiver report blocks about the local source.
| source | Synchronization source this report comes from. |
| RR | Receiver report structure |
| blocks | Number of report blocks in the packet |
|
protectedinherited |
| source | Synchronization source of SDES RTCP packet. |
| pkt | SDES RTCP packet received. |
|
protectedvirtualinherited |
Plug-in for handling of SDES chunks.
| source | Synchronization source of SDES chunk. |
| chunk | SDES chunk structure. |
| len | Length of chunk, in octets. |
|
protectedvirtualinherited |
Plug-in for processing (acquire information carried in) an incoming RTCP Sender Report.
The default implementation in this class only processes the sender information and the receiver report blocks about the local source.
| source | Synchronization source this report comes from. |
| SR | Sender report structure. |
| blocks | Number of report blocks in the packet. |
|
inlineprotectedvirtualinherited |
|
inlineprotectedvirtualinherited |
A virtual function to support parsing of arriving packets to determine if they should be kept in the queue and to dispatch events.
A generic header validity check (as specified in RFC 1889) is performed on every incoming packet. If the generic check completes succesfully, this method is called before the packet is actually inserted into the reception queue.
May be used to perform additional validity checks or to do some application specific processing.
| - | packet just received. |
|
protectedvirtual |
A hook that gets called if the decoding of an incoming SRTP was erroneous.
| pkt | The SRTP packet with error. |
| errorCode | The error code: -1 - SRTP authentication failure, -2 - replay check failed |
Reimplemented from IncomingDataQueue.
|
protectedinherited |
|
protectedinherited |
| void ZrtpQueue::putData | ( | uint32 | stamp, |
| const unsigned char * | data = NULL, |
||
| size_t | len = 0 |
||
| ) |
Put data into the RTP output queue.
This is used to create a data packet in the send queue. Sometimes a "NULL" or empty packet will be used instead, and these are known as "silent" packets. "Silent" packets are used simply to "push" the scheduler along more accurately by giving the appearence that a next packet is waiting to be sent and to provide a valid timestamp for that packet.
This method overrides the same method in OutgoingDataQueue class. During ZRTP processing it may be necessary to control the flow of outgoing RTP payload packets (GoClear processing).
| stamp | Timestamp for expected send time of packet. |
| data | Value or NULL if special "silent" packet. |
| len | May be 0 to indicate a default by payload type. |
|
protectedinherited |
Log extraction of a packet from this source from the scheduled reception queue.
| pkt | Packet extracted from the queue. |
|
protectedinherited |
Log reception of a new RTP packet from this source.
Usually updates data such as the packet counter, the expected sequence number for the next packet and the time the last packet was received at.
| srcLink | Link structure for the synchronization source of this packet. |
| pkt | Packet just created and to be logged. |
| recvtime | Reception time. |
|
protectedpure virtualinherited |
This function performs the physical I/O for reading a packet from the source.
It is a virtual that is overriden in the derived class.
| buffer | of read packet. |
| length | of data to read. |
| host | address of source. |
| port | number of source. |
Implemented in RTPDuplex.
|
inherited |
Remove CSRC from the list of contributors.
|
protectedinherited |
Locks the object before modifying it.
|
inherited |
Remove input queue CryptoContext.
The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts.
| cc | Pointer to initialized CryptoContext to remove. If pointer if NULL then delete the whole queue |
|
inherited |
Remove output queue CryptoContext.
The endQueue method (provided by RTPQueue) also deletes all registered CryptoContexts.
| cc | Pointer to initialized CryptoContext to remove. |
|
inlineinherited |
|
protectedinherited |
Remove the description of the source identified by ssrc
|
inlineprotectedvirtualinherited |
Reimplemented from RTPQueueBase.
| void ZrtpQueue::requestGoClear | ( | ) |
Request to switch off secure mode.
Call this method is the user itself wants to switch off secure mode (go clear). After sending the "go clear" request to the peer ZRTP immediatly switch off SRTP processing. Every RTP data is sent in clear after the go clear request.
| void ZrtpQueue::resetSASVerified | ( | ) |
Reset the SAS verfied flag for the current user's retained secrets.
|
private |
| void ZrtpQueue::SASVerified | ( | ) |
Set SAS as verified.
The application may call this method if the user confirmed (verfied) the Short Authentication String (SAS) with the peer.
ZRTP calls ZrtpUserCallback::showSAS after it computed the SAS and the application registered a user callback class. The application should display the SAS and provide a mechanism at the user interface that enables the user to confirm the SAS.
ZRTP remembers the SAS confirmation status together with the retained secrets data. If both parties confirmed the SAS then ZRTP informs the application about this status on the next ZRTP session.
For more detailed information regarding SAS please refer to the ZRTP specification, chapter 8.
|
inherited |
| na | Inet network address. |
| ctp | Data transport port. |
|
inherited |
| na | Inet network address. |
| dtp | Data transport port. |
|
protectedinherited |
|
protectedpure virtualinherited |
Send a ZRTP packet via RTP.
ZRTP calls this method to send a ZRTP packet via the RTP session.
| data | Points to ZRTP packet to send. |
| length | The length in bytes of the data |
|
protected |
| void ZrtpQueue::sendImmediate | ( | uint32 | stamp, |
| const unsigned char * | data = NULL, |
||
| size_t | len = 0 |
||
| ) |
Immediatly send a data packet.
This is used to create a data packet and send it immediately. Sometimes a "NULL" or empty packet will be used instead, and these are known as "silent" packets. "Silent" packets are used simply to "push" the scheduler along more accurately by giving the appearence that a next packet is waiting to be sent and to provide a valid timestamp for that packet.
This method overrides the same method in OutgoingDataQueue class. During ZRTP processing it may be necessary to control the flow of outgoing RTP payload packets (GoClear processing).
| stamp | Timestamp immediate send time of packet. |
| data | Value or NULL if special "silent" packet. |
| len | May be 0 to indicate a default by payload type. |
|
protectedvirtual |
Send information messages to the hosting environment.
The ZRTP implementation uses this method to send information messages to the host. Along with the message ZRTP provides a severity indicator that defines: Info, Warning, Error, Alert. Refer to the MessageSeverity enum above.
| severity | This defines the message's severity |
| subCode | The subcode identifying the reason. |
Implements ZrtpCallback.
| bool ZrtpQueue::sendSASRelayPacket | ( | uint8_t * | sh, |
| std::string | render | ||
| ) |
Send the SAS relay packet.
The method creates and sends a SAS relay packet according to the ZRTP specifications. Usually only a MitM capable user agent (PBX) uses this function.
| sh | the full SAS hash value |
| render | the SAS rendering algorithm |
| void ZrtpQueue::setAuxSecret | ( | uint8_t * | data, |
| int32_t | length | ||
| ) |
Set the auxilliary secret.
Use this method to set the srtps secret data. Refer to ZRTP specification, chapter 5.3 ff
| data | Points to the auxilliary secret data. |
| length | Length of the auxilliary secrect in bytes |
| void ZrtpQueue::setClientId | ( | std::string | id | ) |
Set the client ID for ZRTP Hello message.
The GNU ccRTP client may set its id to identify itself in the ZRTP Hello message. The maximum length is 16 characters. A shorter id string is possible, it will be filled with blanks. A longer id string will be truncated to 16 characters. The standard client id is 'GNU ccRTP ZRTP ' (without the quotes).
Setting the client's id must be done before calling ZrtpQueue::initialize() or ZrtpQueue::startZrtp() .
| id | The client's id string |
|
inlineinherited |
Specify the bandwith available for control (RTCP) packets.
This method sets the global control bandwidth for both sender and receiver reports. As recommended in RFC 1890, 1/4 of the total control bandwidth is dedicated to senders, whereas 3/4 are dedicated to receivers.
| fraction | fraction of the session bandwidth, between 0 and 1 |
|
inlineprotectedvirtualinherited |
|
inlineinherited |
|
inlineinherited |
| void ZrtpQueue::setEnableZrtp | ( | bool | onOff | ) |
Enable or disable ZRTP processing.
Call this method to enable or disable ZRTP processing after calling initialize(). This can be done before using a RTP session or at any time during a RTP session.
Existing SRTP sessions or currently active ZRTP processing will not be stopped or disconnected.
If the application enables ZRTP then:
| onOff | true to enable ZRTP, false to disable ZRTP |
|
inlineinherited |
This method sets the maximum end to end delay allowed.
If the processing delay plus the trip time for a packet is greater than the end to end delay, the packet is discarded, and the application cannot get it.
This is a way of setting an upper bound to the end to end delay, computed as the elapsed time between the packet timestamping at the sender side, and the picking of the packet at the receiver side.
| t | maximum end to end delay allowed. A value of 0 implies there is no limit and is the default |
| void ZrtpQueue::setEnrollmentMode | ( | bool | enrollmentMode | ) |
Check the state of the enrollment mode.
If true then we will set the enrollment flag (E) in the confirm packets and perform the enrollment actions. A MitM (PBX) enrollment service must sets this mode to true.
Can be set to true only if mitmMode is also true.
| enrollmentMode | defines the new state of the enrollmentMode flag |
|
inlineinherited |
|
inlineprotectedinherited |
|
inherited |
Set input queue CryptoContext.
The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.
| cc | Pointer to initialized CryptoContext. |
|
inlineinherited |
|
inlineinherited |
|
inlineprotectedinherited |
Definition at line 214 of file queuebase.h.
|
inlineinherited |
Set marker bit for the packet in which the next data provided will be send.
When transmitting audio, should be set for the first packet of a talk spurt. When transmitting video, should be set for the last packet for a video frame.
| mark | Marker bit value for next packet. |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
| maxsize | maximum length of received RTP data packets, in octets. Defaults to the value returned by getDefaultMaxRecvPacketSize(). |
Definition at line 319 of file queuebase.h.
|
inlineinherited |
Set maximum payload segment size before fragmenting sends.
| size | Maximum payload size. |
Definition at line 272 of file queuebase.h.
|
inlineprotectedinherited |
|
inlineinherited |
Manually set the minimum interval for sending RTP compound packets.
| interval | minimum interval between RTCP packets, in microseconds. |
|
inlineinherited |
When receiving packets from a new source, it may be convenient to reject a first few packets before we are really sure the source is valid.
This method sets how many data packets must be received in sequence before the source is considered valid and the stack starts to accept its packets.
| packets | number of sequential packet required |
| void ZrtpQueue::setMitmMode | ( | bool | mitmMode | ) |
Set the state of the MitM mode flag.
If MitM mode is set to true this ZRTP session acts as MitM, usually enabled by a PBX client (user agent).
| mitmMode | defines the new state of the mitmMode flag |
| void ZrtpQueue::setMultiStrParams | ( | std::string | parameters | ) |
Set Multi-stream parameters.
Use this method to set the parameters required to enable Multi-stream processing of ZRTP. The multi-stream parameters must be set before the application starts the ZRTP protocol engine.
Refer to chapter 5.4.2 in the ZRTP specification for further details of multi-stream mode.
| parameters | A string that contains the multi-stream parameters that this new ZrtpQueue instanace shall use. |
|
inlineinherited |
|
inlineprotectedinherited |
|
inherited |
Set ouput queue CryptoContext.
The endQueue method (provided by RTPQueue) deletes all registered CryptoContexts.
| cc | Pointer to initialized CryptoContext. |
|
inlineinherited |
| void ZrtpQueue::setParanoidMode | ( | bool | yesNo | ) |
Enable or disable paranoid mode.
The Paranoid mode controls the behaviour and handling of the SAS verify flag. If Panaoid mode is set to flase then ZRtp applies the normal handling. If Paranoid mode is set to true then the handling is:
false at srtpSecretsOn() callback. The user interface (UI) must show SAS not verified. See implementation note below. Confirm packets, thus forcing the other peer to report SAS not verified. SASVerified() function, thus do not set the SAS verified flag in the ZRTP cache. SASRelay packet but do not process the relayed data. This protects the user from a malicious "trusted PBX". ZRtp performs alls other steps during the ZRTP negotiations as usual, in particular it computes, compares, uses, and stores the retained secrets. This avoids unnecessary warning messages. The user may enable or disable the Paranoid mode on a call-by-call basis without breaking the key continuity data.
Implementation note:
An application shall always display the SAS if the SAS verify flag is false. The application shall remind the user to compare the SAS code, for example using larger fonts, different colours and other display features.
|
inherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Set the payload format in use, for timing and payload type identification purposes.
| pf | payload format to use from now on. |
Definition at line 180 of file queuebase.h.
|
inline |
Backwards compatible api fix...
Definition at line 596 of file ZrtpQueue.h.
|
inlineprotectedinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Specify the fraction of the total control bandwith to be dedicated to senders reports.
| fraction | fraction of bandwidth, must be between 0 an 1. |
This method sets the fraction of the global control bandwidth that will be dedicated to senders reports. Of course, 1 - fraction will be dedicated to receivers reports.
|
inlineinherited |
Specify the bandwidth of the current session.
| bw | bandwidth of the current session, in bits/s. |
| bool ZrtpQueue::setSignatureData | ( | uint8 * | data, |
| int32 | length | ||
| ) |
Set signature data.
This functions stores signature data and transmitts it during ZRTP processing to the other party as part of the Confirm packets. Refer to chapters 6.7 and 8.2 in the ZRTP specification.
| data | The signature data including the signature type block. The method copies this data into the Confirm packet at signature type block. |
| length | The length of the signature data in bytes. This length must be multiple of 4. |
| void ZrtpQueue::setSignSas | ( | bool | sasSignMode | ) |
Set the state of the SAS signature mode flag.
If SAS signature mode is set to true this ZRTP session support SAS signature callbacks and signature transfer between clients.
| sasSignMode | defines the new state of the sasSignMode flag |
|
inlineprotectedinherited |
Set the number of RTCP intervals that the stack will wait to change the state of a source from stateActive to stateInactive, or to delete the source after being in stateInactive.
Note that this value should be uniform accross all participants and SHOULD be fixed for a particular profile.
| intervals | number of RTCP report intervals |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Specify the kind of service the application expects to use.
| tos | type of service the application expects to use |
| void ZrtpQueue::setUserCallback | ( | ZrtpUserCallback * | ucb | ) |
Set the application's callback class.
The destructor of ZrtpQueue also destorys the user callback class if it was set. The application must not delete the callback object or use/reference the callback object after ZrtpQueue was destroyed.
| ucb | Implementation of the application's ZrtpUserCallback class |
|
protectedvirtual |
Request a SAS signature.
After ZRTP was able to compute the Short Authentication String (SAS) it calls this method. The client may now use an approriate method to sign the SAS. The client may use ZrtpQueue::setSignatureData() to store the signature data an enable signature transmission to the other peer. Refer to chapter 8.2 of ZRTP specification.
Note: SAS signing is not yet fully supported by GNU ZRTP.
| sasHash | The SAS hash to sign. |
Implements ZrtpCallback.
|
protectedvirtual |
Switch off the security for the defined part.
| part | Defines for which part (sender or receiver) to switch on security |
Implements ZrtpCallback.
|
protectedvirtual |
Switch on the security.
ZRTP calls this method after it has computed the SAS and check if it is verified or not. In addition ZRTP provides information about the cipher algorithm and key length for the SRTP session.
This method must enable SRTP processing if it was not enabled during sertSecretsReady().
| c | The name of the used cipher algorithm and mode, or NULL |
| s | The SAS string |
| verified | if verified is true then SAS was verified by both parties during a previous call. |
Implements ZrtpCallback.
|
protectedvirtual |
SRTP crypto data ready for the sender or receiver.
The ZRTP implementation calls this method right after all SRTP secrets are computed and ready to be used. The parameter points to a structure that contains pointers to the SRTP secrets and a enum Role. The called method (the implementation of this abstract method) must either copy the pointers to the SRTP data or the SRTP data itself to a save place. The SrtpSecret_t structure is destroyed after the callback method returns to the ZRTP implementation.
The SRTP data themselfs are ontained in the ZRtp object and are valid as long as the ZRtp object is active. TheZRtp's destructor clears the secrets. Thus the called method needs to save the pointers only, ZRtp takes care of the data.
The implementing class may enable SRTP processing in this method or delay it to srtpSecertsOn().
| secrets | A pointer to a SrtpSecret_t structure that contains all necessary data. |
| part | for which part (Sender or Receiver) this data is valid. |
Implements ZrtpCallback.
| void ZrtpQueue::startZrtp | ( | ) |
Starts the ZRTP protocol engine.
Applications may call this method to immediatly start the ZRTP protocol engine any time after initializing ZRTP and setting optinal parameters, for example client id or multi-stream parameters.
If the application does not call this method but sucessfully initialized the ZRTP engine using initialize() then ZRTP also starts after the application sent and received RTP packets. An application can disable this automatic, delayed start of the ZRTP engine using setEnableZrtp(false) before sending or receiving RTP packets.
| void ZrtpQueue::stopZrtp | ( | ) |
Stops the ZRTP protocol engine.
Applications call this method to stop the ZRTP protocol engine.
|
protectedvirtual |
Enter synchronization mutex.
GNU ZRTP requires one mutes to synchronize its processing. Because mutex implementations depend on the underlying infrastructure, for example operating system or thread implementation, GNU ZRTP delegates mutex handling to the spcific part of its implementation.
Implements ZrtpCallback.
|
protectedvirtual |
Leave synchronization mutex.
Implements ZrtpCallback.
|
protectedvirtual |
This function is used by the service thread to process the next incoming packet and place it in the receive list.
This class overloads the function of IncomingDataQueue implementation.
Reimplemented from IncomingDataQueue.
|
inlineprotectedvirtualinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineprotectedinherited |
|
protectedvirtual |
Inform about a PBX enrollment request.
Please refer to chapter 8.3 ff to get more details about PBX enrollment and SAS relay.
Note: PBX enrollement is not yet fully supported by GNU ZRTP.
| info | Give some information to the user about the PBX requesting an enrollment. |
Implements ZrtpCallback.
|
protectedvirtual |
Inform about PBX enrollment result.
Informs the use about the acceptance or denial of an PBX enrollment request
Note: PBX enrollement is not yet fully supported by GNU ZRTP.
| info | information to the user about the result of an enrollment. |
Implements ZrtpCallback.
|
protectedvirtual |
Handle ZRTP negotiation failed.
ZRTP calls this method in case ZRTP negotiation failed. The parameters show the severity as well as the reason.
| severity | This defines the message's severity |
| subCode | The subcode identifying the reason. |
Implements ZrtpCallback.
|
protectedvirtual |
ZRTP calls this method if the other side does not support ZRTP.
If the other side does not answer the ZRTP Hello packets then ZRTP calls this method,
Implements ZrtpCallback.
|
friend |
Definition at line 753 of file ZrtpQueue.h.
|
private |
Definition at line 851 of file ZrtpQueue.h.
|
protectedinherited |
|
protectedinherited |
|
mutableprotectedinherited |
|
mutableprotectedinherited |
|
staticprotectedinherited |
|
staticprotectedinherited |
|
staticprotectedinherited |
|
staticprotectedinherited |
|
staticprotectedinherited |
|
protectedinherited |
|
private |
Definition at line 863 of file ZrtpQueue.h.
|
private |
Definition at line 853 of file ZrtpQueue.h.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
private |
Definition at line 861 of file ZrtpQueue.h.
|
private |
Definition at line 859 of file ZrtpQueue.h.
|
protectedinherited |
|
protectedinherited |
|
mutableprotectedinherited |
|
protectedinherited |
|
protectedinherited |
|
private |
Definition at line 855 of file ZrtpQueue.h.
|
private |
Definition at line 857 of file ZrtpQueue.h.
|
staticprotectedinherited |
|
private |
Definition at line 862 of file ZrtpQueue.h.
|
protectedinherited |
|
private |
Definition at line 860 of file ZrtpQueue.h.
|
private |
Definition at line 858 of file ZrtpQueue.h.
|
private |
Definition at line 848 of file ZrtpQueue.h.
|
private |
Definition at line 849 of file ZrtpQueue.h.
1.8.6