Package org.jitsi.service.neomedia

Interface ZrtpControl

  • All Superinterfaces:
    SrtpControl
    All Known Implementing Classes:
    ZrtpControlImpl
    public interface ZrtpControl
extends SrtpControl
    ZRTP based SRTP MediaStream encryption control.
    Author:
    Damian Minkov

    • Method Detail

      • getCipherString

        String getCipherString()
        Gets the cipher information for the current media stream.
        Returns:
        the cipher information string.

      • getCurrentProtocolVersion

        int getCurrentProtocolVersion()
        Gets the negotiated ZRTP protocol version.
        Returns:
        the int representation of the negotiated ZRTP protocol version.

      • getHelloHash

        String getHelloHash​(int index)
        Returns the zrtp hello hash String.
        Parameters:
        index - Hello hash of the Hello packet identified by index. Must be 0 <= index < SUPPORTED_ZRTP_VERSIONS.
        Returns:
        String the zrtp hello hash.

      • getHelloHashSep

        String[] getHelloHashSep​(int index)
        Gets the ZRTP Hello Hash data - separate strings.
        Parameters:
        index - Hello hash of the Hello packet identified by index. Must be 0 <= index < SUPPORTED_ZRTP_VERSIONS.
        Returns:
        String array containing the version string at offset 0, the Hello hash value as hex-digits at offset 1. Hello hash is available immediately after class instantiation. Returns null if ZRTP is not available.

      • getNumberSupportedVersions

        int getNumberSupportedVersions()
        Gets the number of supported ZRTP protocol versions.
        Returns:
        the number of supported ZRTP protocol versions.

      • getPeerHelloHash

        String getPeerHelloHash()
        Gets the peer's Hello Hash data as a String.
        Returns:
        a String containing the Hello hash value as hex-digits. Peer Hello hash is available after we received a Hello packet from our peer. If peer's hello hash is not available, returns null.

      • getPeerZid

        byte[] getPeerZid()
        Gets other party's ZID (ZRTP Identifier) data that was received during ZRTP processing. The ZID data can be retrieved after ZRTP receives the first Hello packet from the other party.
        Returns:
        the ZID data as a byte array.

      • getPeerZidString

        String getPeerZidString()
        Gets other party's ZID (ZRTP Identifier) data that was received during ZRTP processing as a String. The ZID data can be retrieved after ZRTP receives the first Hello packet from the other party.
        Returns:
        the ZID data as a String.

      • getSecurityString

        String getSecurityString()
        Gets the SAS for the current media stream.
        Returns:
        the four character ZRTP SAS.

      • getTimeoutValue

        long getTimeoutValue()
        Returns the timeout value in milliseconds that we will wait and fire timeout secure event if call is not secured.
        Returns:
        the timeout value in milliseconds that we will wait and fire timeout secure event if call is not secured.

      • isSecurityVerified

        boolean isSecurityVerified()
        Gets the status of the SAS verification.
        Returns:
        true when the SAS has been verified.

      • setSASVerification

        void setSASVerification​(boolean verified)
        Sets the SAS verification
        Parameters:
        verified - the new SAS verification status