Enum AuthProtocol 

pub enum AuthProtocol {
    Md5,
    Sha1,
    Sha224,
    Sha256,
    Sha384,
    Sha512,
}

Authentication protocol identifiers.

Variants

Md5

HMAC-MD5-96 (RFC 3414)

Sha1

HMAC-SHA-96 (RFC 3414)

Sha224

HMAC-SHA-224 (RFC 7860)

Sha256

HMAC-SHA-256 (RFC 7860)

Sha384

HMAC-SHA-384 (RFC 7860)

Sha512

HMAC-SHA-512 (RFC 7860)

Implementations

impl AuthProtocol

pub fn digest_len(self) -> usize

Get the digest output length in bytes.

This is also the key length produced by the key localization algorithm, which is used for privacy key derivation.

pub fn mac_len(self) -> usize

Get the truncated MAC length for authentication parameters.

pub fn is_compatible_with(self, priv_protocol: PrivProtocol) -> bool

Check if this authentication protocol produces sufficient key material for the given privacy protocol.

Privacy keys are derived from the localized authentication key, so the auth protocol must produce at least as many bytes as the privacy protocol requires:

Privacy Protocol	Required Key Length	Compatible Auth Protocols
DES	16 bytes	All (MD5+)
AES-128	16 bytes	All (MD5+)
AES-192	24 bytes	SHA-224, SHA-256, SHA-384, SHA-512
AES-256	32 bytes	SHA-256, SHA-384, SHA-512

Interoperability with net-snmp

Some implementations (notably net-snmp) support AES-192/256 with shorter authentication protocols using key extension. To interoperate with these systems, use PrivKey::from_password_extended with KeyExtension::Blumenthal.

Example

use async_snmp::{AuthProtocol, PrivProtocol};

// SHA-256 works with all privacy protocols
assert!(AuthProtocol::Sha256.is_compatible_with(PrivProtocol::Aes256));

// SHA-1 doesn't produce enough key material for AES-256
assert!(!AuthProtocol::Sha1.is_compatible_with(PrivProtocol::Aes256));

Trait Implementations

impl Clone for AuthProtocol

fn clone(&self) -> AuthProtocol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthProtocol

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthProtocol

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthProtocol

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

Formats the value using the given formatter.

impl FromStr for AuthProtocol

type Err = ParseProtocolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for AuthProtocol

fn eq(&self, other: &AuthProtocol) -> 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 Serialize for AuthProtocol

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for AuthProtocol

impl Eq for AuthProtocol

impl StructuralPartialEq for AuthProtocol