Expand description
HTTP authentication. Currently meant for clients; to be extended for servers.
As described in the following documents and specifications:
- MDN documentation.
- RFC 7235: Hypertext Transfer Protocol (HTTP/1.1): Authentication.
- RFC 7617: The ‘Basic’ HTTP Authentication Scheme
- RFC 7616: HTTP Digest Access Authentication
This framework is primarily used with HTTP, as suggested by the name. It is also used by some other protocols such as RTSP.
§Cargo Features
| feature | default? | description |
|---|---|---|
basic-scheme | yes | support for the Basic auth scheme |
digest-scheme | yes | support for the Digest auth scheme |
http | no | convenient conversion from http crate types, version 0.2 |
http10 | no | convenient conversion from http crate types, version 1.0 |
§Example
In most cases, callers only need to use PasswordClient and
PasswordParams to handle Basic and Digest authentication schemes.
The http or http10 features allow parsing all WWW-Authenticate headers within a
[http::HeaderMap] in one call.
Re-exports§
pub use parser::ChallengeParser;
Modules§
Structs§
- Challenge
Ref - Parsed challenge (scheme and body) using references to the original header value.
Produced by
crate::parser::ChallengeParser. - Param
Value - Parsed challenge parameter value used within
ChallengeRef. - Password
Client Builder - Builds a
PasswordClientfrom the supplied challenges; create viaPasswordClient::builder. - Password
Params - Parameters for responding to a password challenge.
- ToStr
Error - An error returned by [
HeaderValue::to_str].
Enums§
- Password
Client - Client for responding to a password challenge.
Functions§
- parse_
challenges - Parses a list of challenges into a
Vec.