This abstract class defines the callback functions required by GNU ZRTP. More...
#include <ZrtpCallback.h>
This abstract class defines the callback functions required by GNU ZRTP.
This class is a pure abstract class, aka Interface in Java, that defines the callback interface that the specific part of a GNU ZRTP must implement. The generic part of GNU ZRTP uses these mehtods to communicate with the specific part, for example to send data via the RTP/SRTP stack, to set timers and cancel timer and so on.
The generiy part of GNU ZRTP needs only a few callback methods to be implemented by the specific part.
Definition at line 119 of file ZrtpCallback.h.
Definition at line 124 of file ZrtpCallback.h.
Activate timer.
Implemented in ZrtpQueue.
Cancel the active timer.
Implemented in ZrtpQueue.
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.
Implemented in ZrtpQueue.
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.
Implemented in ZrtpQueue.
Send a ZRTP packet via RTP.
ZRTP calls this method to send a ZRTP packet via the RTP session.
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.
Implemented in ZrtpQueue.
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.
Implemented in ZrtpQueue.
Switch off the security for the defined part.
Implemented in ZrtpQueue.
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().
verified
is true then SAS was verified by both parties during a previous call. Implemented in ZrtpQueue.
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().
Implemented in ZrtpQueue.
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.
Implemented in ZrtpQueue.
Leave synchronization mutex.
Implemented in ZrtpQueue.
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.
Implemented in ZrtpQueue.
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.
Implemented in ZrtpQueue.
Handle ZRTP negotiation failed.
ZRTP calls this method in case ZRTP negotiation failed. The parameters show the severity as well as the reason.
Implemented in ZrtpQueue.
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,
Implemented in ZrtpQueue.
Definition at line 122 of file ZrtpCallback.h.