Struct MasterKey 

pub struct MasterKey { /* private fields */ }

A stream master key

Composed of the key, salt, an optional MKI and key life time

Implementations

impl MasterKey

pub fn new(key: &[u8], salt: &[u8], mki: &Option<Vec<u8>>) -> Self

create a stream master key

The key is created with default lifetime (2^48 for RTP, 2^31 for RTCP) and default soft limits (2^16 for both RTP and RTCP)

Arguments

• key: the master key
• salt: the master salt, this field can be an empty slice, in that case the master salt is considered all 0.
• mki: optionnal master key id - see RFC 3711 - section 3.1

pub fn set_keys_lifetime( &mut self, rtp: u64, rtp_limit: u64, rtcp: u32, rtcp_limit: u32, ) -> Result<(), SrtpError>

Set the session keys lifetime and soft limit

Arguments

• rtp : number of lives a session key gets on RTP stream. Must be <= 2^48
• rtp_limit : when the lives left is under this limit, raise an alert. Must be < rtp
• rtcp : number of lives a session key gets on RTCP stream. Must be <= 2^31
• rtcp_limit : when the lives left is under this limit, raise an alert. Must be < rtcp

Returns one of:

• Ok
• InvalidProfile when the arguments don’t match the requirements

Notes

• When a master key is used by several streams (from a stream template):

  • Each one will start with the same lifetime.
  • The lifetime countdown is not shared on the master key but on each stream.
  • When a stream reaches it’s end of life, all the other streams derived from the master key are killed.

• When a stream reaches the end of one of its key(RTP/RTCP) lifetime, it is disabled for both types.

• For streams using mki, when the soft or hard limit is reached it applies to one master key, the stream can keep going using others mki after one is dead.

Trait Implementations

impl Clone for MasterKey

fn clone(&self) -> MasterKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MasterKey

Debug redacting secret key

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for MasterKey

fn drop(&mut self)

Executes the destructor for this type.

impl Zeroize for MasterKey

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.