Enum MessageIntegritySha256

pub enum MessageIntegritySha256 {
    Encodable(EncodableMessageIntegritySha256),
    Decodable(DecodableMessageIntegritySha256),
}

The MessageIntegritySha256 attribute contains an HMAC-SHA256 RFC2104 of the STUN message. This attribute can be present in any STUN message type.

Examples

 // use short-term-credentials to generate the key
 let key = HMACKey::new_short_term("foo bar")?;
 let attr = MessageIntegritySha256::new(key);
 assert_eq!(attr.attribute_type(), AttributeType::from(0x001C));

Variants

Encodable(EncodableMessageIntegritySha256)

Encodable version of this attribute. This is used when the attribute is added to a STUN message that is going to be sent to the network.

Decodable(DecodableMessageIntegritySha256)

Decodable version of this attribute. This is the decoded attribute received from the network.

Implementations

impl MessageIntegritySha256

pub fn new(key: HMACKey) -> Self

Creates a new attribute.

Arguments:

• key - The key used for the HMAC depends on which credential mechanism is in use.

pub fn validate(&self, input: &[u8], key: &HMACKey) -> bool

Validates the message using the HMAC value generated from the key

Arguments:

• input- the STUN message up to (but excluding) the MessageIntegritySha256 attribute itself.
• key- the HMACKey key

Returns:

true if the message integrity attribute matches the computed value.

Trait Implementations

impl Clone for MessageIntegritySha256

fn clone(&self) -> MessageIntegritySha256

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessageIntegritySha256

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

Formats the value using the given formatter.

impl From<&[u8; 32]> for MessageIntegritySha256

fn from(val: &[u8; 32]) -> Self

Converts to this type from the input type.

impl From<[u8; 32]> for MessageIntegritySha256

fn from(val: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<MessageIntegritySha256> for StunAttribute

fn from(value: MessageIntegritySha256) -> Self

Converts to this type from the input type.

impl PartialEq for MessageIntegritySha256

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StunAttributeType for MessageIntegritySha256

fn get_type() -> AttributeType

where Self: Sized,

Returns the STUN attribute type.

fn attribute_type(&self) -> AttributeType

Returns the STUN attribute type of this instance.

impl Eq for MessageIntegritySha256

impl StructuralPartialEq for MessageIntegritySha256