Struct DigestAuthenticator 

pub struct DigestAuthenticator { /* private fields */ }

SIP Digest authenticator for generating challenges and validating responses.

Implementations

impl DigestAuthenticator

pub fn new(realm: impl Into<String>) -> DigestAuthenticator

pub fn with_algorithm(self, algorithm: DigestAlgorithm) -> DigestAuthenticator

Select the algorithm used in newly generated challenges.

pub fn generate_challenge(&self) -> DigestChallenge

pub fn format_www_authenticate(&self, challenge: &DigestChallenge) -> String

pub fn format_www_authenticate_with_stale( &self, challenge: &DigestChallenge, stale: bool, ) -> String

Format a digest challenge with an optional RFC 7616 stale=true flag.

pub fn validate_response( &self, response: &DigestResponse, method: &str, password: &str, ) -> Result<bool, AuthError>

Validate a digest response against the stored password.

Honors the algorithm carried on the response (MD5 / MD5-sess / SHA-256 / SHA-256-sess / SHA-512-256 / SHA-512-256-sess) — clients sending SHA-based digests are validated with the advertised hash, not silently downgraded.

pub fn validate_response_with_body( &self, response: &DigestResponse, method: &str, password: &str, body: Option<&[u8]>, ) -> Result<bool, AuthError>

Like Self::validate_response but also accepts the request body so qop=auth-int validation can include it in HA2.

pub fn validate_response_with_secret( &self, response: &DigestResponse, method: &str, secret: &DigestSecret, ) -> Result<bool, AuthError>

Validate a digest response against provider-supplied secret material.

DigestSecret::Ha1 lets a server validate SIP Digest without storing plaintext SIP passwords. The HA1 value must be the base H(username:realm:password) value; -sess algorithms fold nonce and cnonce in this method.

pub fn validate_response_with_secret_and_body( &self, response: &DigestResponse, method: &str, secret: &DigestSecret, body: Option<&[u8]>, ) -> Result<bool, AuthError>

Like Self::validate_response_with_secret but also accepts the request body for qop=auth-int validation.

pub fn parse_challenge(header: &str) -> Result<DigestChallenge, AuthError>

Parse WWW-Authenticate header to extract challenge.

pub fn parse_challenge_details( header: &str, ) -> Result<DigestChallengeDetails, AuthError>

Parse WWW-Authenticate / Proxy-Authenticate header to extract the challenge plus metadata such as stale=true.

pub fn parse_authorization(header: &str) -> Result<DigestResponse, AuthError>

Parse Authorization header to extract response.

Trait Implementations

impl Clone for DigestAuthenticator

fn clone(&self) -> DigestAuthenticator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DigestAuthenticator

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

Formats the value using the given formatter.