Struct WwwAuthenticate

pub struct WwwAuthenticate { /* private fields */ }

Define the authentication method that should be used to gain access to a resource.

Specifications

• RFC 7235, section 4.1: WWW-Authenticate

Implementation Notes

This implementation only encodes and parses a single authentication method, further authorization methods are ignored. It also always passes the utf-8 encoding flag.

Examples

use http_types::Response;
use http_types::auth::{AuthenticationScheme, WwwAuthenticate};

let scheme = AuthenticationScheme::Basic;
let realm = "Access to the staging site";
let authz = WwwAuthenticate::new(scheme, realm.into());

let mut res = Response::new(200);
authz.apply(&mut res);

let authz = WwwAuthenticate::from_headers(res)?.unwrap();

assert_eq!(authz.scheme(), AuthenticationScheme::Basic);
assert_eq!(authz.realm(), realm);

Implementations

impl WwwAuthenticate

pub fn new(scheme: AuthenticationScheme, realm: String) -> Self

Create a new instance of WwwAuthenticate.

pub fn from_headers(headers: impl AsRef<Headers>) -> Result<Option<Self>>

Create a new instance from headers.

pub fn apply(&self, headers: impl AsMut<Headers>)

Sets the header.

pub fn name(&self) -> HeaderName

Get the HeaderName.

pub fn value(&self) -> HeaderValue

Get the HeaderValue.

pub fn scheme(&self) -> AuthenticationScheme

Get the authorization scheme.

pub fn set_scheme(&mut self, scheme: AuthenticationScheme)

Set the authorization scheme.

pub fn realm(&self) -> &str

Get the authorization realm.

pub fn set_realm(&mut self, realm: String)

Set the authorization realm.

Trait Implementations

impl Debug for WwwAuthenticate

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

Formats the value using the given formatter.