Struct digest_auth::WwwAuthenticateHeader

pub struct WwwAuthenticateHeader {
    pub domain: Option<Vec<String>>,
    pub realm: String,
    pub nonce: String,
    pub opaque: Option<String>,
    pub stale: bool,
    pub algorithm: Algorithm,
    pub qop: Option<Vec<Qop>>,
    pub userhash: bool,
    pub charset: Charset,
    pub nc: u32,
}

WWW-Authenticate header parsed from HTTP header value

Fields

domain: Option<Vec<String>>

Domain is a list of URIs that will accept the same digest. None if not given (i.e applies to all)

realm: String

Authorization realm (i.e. hostname, serial number…)

nonce: String

Server nonce

opaque: Option<String>

Server opaque string

stale: bool

True if the server nonce expired. This is sent in response to an auth attempt with an older digest. The response should contain a new WWW-Authenticate header.

algorithm: Algorithm

Hashing algo

qop: Option<Vec<Qop>>

Digest algorithm variant

userhash: bool

Flag that the server supports user-hashes

charset: Charset

Server-supported charset

nc: u32

nc - not part of the received header, but kept here for convenience and incremented each time a response is composed with the same nonce.

Implementations

impl WwwAuthenticateHeader

pub fn respond(
    &mut self,
    secrets: &AuthContext<'_>
) -> Result<AuthorizationHeader>

Generate an AuthorizationHeader to be sent to the server in a new request. The self.nc field is incremented.

pub fn parse(input: &str) -> Result<Self>

Construct from the WWW-Authenticate header string

Errors

If the header is malformed (e.g. missing ‘realm’, missing a closing quote, unknown algorithm etc.)

Trait Implementations

impl Clone for WwwAuthenticateHeader

fn clone(&self) -> WwwAuthenticateHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WwwAuthenticateHeader

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

Formats the value using the given formatter.

impl Display for WwwAuthenticateHeader

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

Formats the value using the given formatter.

impl FromStr for WwwAuthenticateHeader

fn from_str(input: &str) -> Result<Self>

Parse HTTP header

type Err = Error

The associated error which can be returned from parsing.

impl PartialEq<WwwAuthenticateHeader> for WwwAuthenticateHeader

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

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

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

This method tests for !=.

impl StructuralPartialEq for WwwAuthenticateHeader