Struct stun_rs::HMACKey

pub struct HMACKey(_);

Key used for authentication and message integrity

Examples:

 // Creates a new long term credential key using MD5 algorithm
 let algorithm = Algorithm::from(AlgorithmId::MD5);
 let key = HMACKey::new_long_term("user", "realm", "pass", algorithm)?;
 assert_eq!(key.credential_mechanism(), CredentialMechanism::LongTerm);

 let expected_hash = [
     0x84, 0x93, 0xFB, 0xC5, 0x3B, 0xA5, 0x82, 0xFB,
     0x4C, 0x04, 0x4C, 0x45, 0x6B, 0xDC, 0x40, 0xEB,
 ];
 assert_eq!(key.as_bytes(), expected_hash);

Implementations

impl HMACKey

pub fn new_short_term<S>(password: S) -> Result<Self, StunError>where
    S: AsRef<str>,

Creates a CredentialMechanism::ShortTerm key

Returns

The new HMACKey used for short term credential mechanism, or a StunError if the password can not be processed using the opaque string profile.

pub fn new_long_term<A, B, C, T>(
    username: A,
    realm: B,
    password: C,
    algorithm: T
) -> Result<Self, StunError>where
    A: AsRef<str>,
    B: AsRef<str>,
    C: AsRef<str>,
    T: AsRef<Algorithm>,

Creates a CredentialMechanism::LongTerm key.

Arguments:

• username - The user name
• realm - The realm.
• algorithm- Optional value for the algorithm used to generate the key. If algorithm is None, AlgorithmId::MD5 will be used. The resulting key length is 16 bytes when MD5 is used, or 32 bytes if SHA-256 algorithm is used.

Returns

The new HMACKey used for long term credential mechanism, or a StunError if username, realm or password can not be processed using the opaque string profile.

pub fn as_bytes(&self) -> &[u8]

Gets the bytes representation of the key

pub fn credential_mechanism(&self) -> CredentialMechanism

Gets the bytes representation of the key

Trait Implementations

impl Clone for HMACKey

fn clone(&self) -> HMACKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HMACKey

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

Formats the value using the given formatter.

impl PartialEq<HMACKey> for HMACKey

fn eq(&self, other: &HMACKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HMACKey

impl StructuralEq for HMACKey

impl StructuralPartialEq for HMACKey