mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-01 03:47:17 +02:00
Deploying to gh-pages from @ 1e682e7a59 🚀
This commit is contained in:
robjtede
@@ -110,117 +110,117 @@
|
||||
<span id="110">110</span>
|
||||
<span id="111">111</span>
|
||||
<span id="112">112</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Extractor for the "Basic" HTTP Authentication Scheme.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Extractor for the "Basic" HTTP Authentication Scheme.
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std::borrow::Cow</span>;
|
||||
</span><span class="kw">use </span>std::borrow::Cow;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_utils::future</span>::{<span class="ident">ready</span>, <span class="ident">Ready</span>};
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">dev::Payload</span>, <span class="ident">http::header::Header</span>, <span class="ident">FromRequest</span>, <span class="ident">HttpRequest</span>};
|
||||
<span class="kw">use </span>actix_utils::future::{ready, Ready};
|
||||
<span class="kw">use </span>actix_web::{dev::Payload, http::header::Header, FromRequest, HttpRequest};
|
||||
|
||||
<span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">config::AuthExtractorConfig</span>, <span class="ident">errors::AuthenticationError</span>};
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers</span>::{
|
||||
<span class="ident">authorization</span>::{<span class="ident">Authorization</span>, <span class="ident">Basic</span>},
|
||||
<span class="ident">www_authenticate::basic::Basic</span> <span class="kw">as</span> <span class="ident">Challenge</span>,
|
||||
<span class="kw">use super</span>::{config::AuthExtractorConfig, errors::AuthenticationError};
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::{
|
||||
authorization::{Authorization, Basic},
|
||||
www_authenticate::basic::Basic <span class="kw">as </span>Challenge,
|
||||
};
|
||||
|
||||
<span class="doccomment">/// [`BasicAuth`] extractor configuration used for [`WWW-Authenticate`] header later.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [`WWW-Authenticate`]: crate::headers::www_authenticate::WwwAuthenticate</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Default</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Config</span>(<span class="ident">Challenge</span>);
|
||||
<span class="doccomment">/// [`BasicAuth`] extractor configuration used for [`WWW-Authenticate`] header later.
|
||||
///
|
||||
/// [`WWW-Authenticate`]: crate::headers::www_authenticate::WwwAuthenticate
|
||||
</span><span class="attribute">#[derive(Debug, Clone, Default)]
|
||||
</span><span class="kw">pub struct </span>Config(Challenge);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Config</span> {
|
||||
<span class="doccomment">/// Set challenge `realm` attribute.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// The "realm" attribute indicates the scope of protection in the manner described in HTTP/1.1</span>
|
||||
<span class="doccomment">/// [RFC 2617 §1.2](https://tools.ietf.org/html/rfc2617#section-1.2).</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">realm</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">T</span>) -> <span class="ident">Config</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">impl </span>Config {
|
||||
<span class="doccomment">/// Set challenge `realm` attribute.
|
||||
///
|
||||
/// The "realm" attribute indicates the scope of protection in the manner described in HTTP/1.1
|
||||
/// [RFC 2617 §1.2](https://tools.ietf.org/html/rfc2617#section-1.2).
|
||||
</span><span class="kw">pub fn </span>realm<T>(<span class="kw-2">mut </span><span class="self">self</span>, value: T) -> Config
|
||||
<span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">realm</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
<span class="self">self</span>.<span class="number">0</span>.realm = <span class="prelude-val">Some</span>(value.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>AsRef<Challenge> <span class="kw">for </span>Config {
|
||||
<span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Challenge {
|
||||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>AuthExtractorConfig <span class="kw">for </span>Config {
|
||||
<span class="kw">type </span>Inner = Challenge;
|
||||
|
||||
<span class="kw">fn </span>into_inner(<span class="self">self</span>) -> <span class="self">Self</span>::Inner {
|
||||
<span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Extractor for HTTP Basic auth.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// use actix_web_httpauth::extractors::basic::BasicAuth;
|
||||
///
|
||||
/// async fn index(auth: BasicAuth) -> String {
|
||||
/// format!("Hello, {}!", auth.user_id())
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// If authentication fails, this extractor fetches the [`Config`] instance from the [app data] in
|
||||
/// order to properly form the `WWW-Authenticate` response header.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// use actix_web::{web, App};
|
||||
/// use actix_web_httpauth::extractors::basic::{self, BasicAuth};
|
||||
///
|
||||
/// async fn index(auth: BasicAuth) -> String {
|
||||
/// format!("Hello, {}!", auth.user_id())
|
||||
/// }
|
||||
///
|
||||
/// App::new()
|
||||
/// .app_data(basic::Config::default().realm("Restricted area"))
|
||||
/// .service(web::resource("/index.html").route(web::get().to(index)));
|
||||
/// ```
|
||||
///
|
||||
/// [app data]: https://docs.rs/actix-web/4/actix_web/struct.App.html#method.app_data
|
||||
</span><span class="attribute">#[derive(Debug, Clone)]
|
||||
</span><span class="kw">pub struct </span>BasicAuth(Basic);
|
||||
|
||||
<span class="kw">impl </span>BasicAuth {
|
||||
<span class="doccomment">/// Returns client's user-ID.
|
||||
</span><span class="kw">pub fn </span>user_id(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
||||
<span class="self">self</span>.<span class="number">0</span>.user_id()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns client's password.
|
||||
</span><span class="kw">pub fn </span>password(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.password()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">Challenge</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Config</span> {
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">Challenge</span> {
|
||||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
}
|
||||
<span class="kw">impl </span>FromRequest <span class="kw">for </span>BasicAuth {
|
||||
<span class="kw">type </span>Future = Ready<<span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error>>;
|
||||
<span class="kw">type </span>Error = AuthenticationError<Challenge>;
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AuthExtractorConfig</span> <span class="kw">for</span> <span class="ident">Config</span> {
|
||||
<span class="kw">type</span> <span class="ident">Inner</span> <span class="op">=</span> <span class="ident">Challenge</span>;
|
||||
<span class="kw">fn </span>from_request(req: <span class="kw-2">&</span>HttpRequest, <span class="kw">_</span>: <span class="kw-2">&mut </span>Payload) -> <<span class="self">Self </span><span class="kw">as </span>FromRequest>::Future {
|
||||
ready(
|
||||
Authorization::<Basic>::parse(req)
|
||||
.map(|auth| BasicAuth(auth.into_scheme()))
|
||||
.map_err(|err| {
|
||||
<span class="macro">log::debug!</span>(<span class="string">"`BasicAuth` extract error: {}"</span>, err);
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) -> <span class="ident"><span class="self">Self</span>::Inner</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
}
|
||||
<span class="kw">let </span>challenge = req
|
||||
.app_data::<Config>()
|
||||
.map(|config| config.<span class="number">0</span>.clone())
|
||||
.unwrap_or_default();
|
||||
|
||||
<span class="doccomment">/// Extractor for HTTP Basic auth.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::extractors::basic::BasicAuth;</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// async fn index(auth: BasicAuth) -> String {</span>
|
||||
<span class="doccomment">/// format!("Hello, {}!", auth.user_id())</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// If authentication fails, this extractor fetches the [`Config`] instance from the [app data] in</span>
|
||||
<span class="doccomment">/// order to properly form the `WWW-Authenticate` response header.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// use actix_web::{web, App};</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::extractors::basic::{self, BasicAuth};</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// async fn index(auth: BasicAuth) -> String {</span>
|
||||
<span class="doccomment">/// format!("Hello, {}!", auth.user_id())</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// App::new()</span>
|
||||
<span class="doccomment">/// .app_data(basic::Config::default().realm("Restricted area"))</span>
|
||||
<span class="doccomment">/// .service(web::resource("/index.html").route(web::get().to(index)));</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [app data]: https://docs.rs/actix-web/4/actix_web/struct.App.html#method.app_data</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">BasicAuth</span>(<span class="ident">Basic</span>);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">BasicAuth</span> {
|
||||
<span class="doccomment">/// Returns client's user-ID.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">user_id</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">user_id</span>()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns client's password.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">password</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">password</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">FromRequest</span> <span class="kw">for</span> <span class="ident">BasicAuth</span> {
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">Ready</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">Challenge</span><span class="op">></span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">from_request</span>(<span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span>, <span class="kw">_</span>: <span class="kw-2">&mut</span> <span class="ident">Payload</span>) -> <span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">FromRequest</span><span class="op">></span><span class="ident">::Future</span> {
|
||||
<span class="ident">ready</span>(
|
||||
<span class="ident">Authorization</span>::<span class="op"><</span><span class="ident">Basic</span><span class="op">></span><span class="ident">::parse</span>(<span class="ident">req</span>)
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">auth</span><span class="op">|</span> <span class="ident">BasicAuth</span>(<span class="ident">auth</span>.<span class="ident">into_scheme</span>()))
|
||||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> {
|
||||
<span class="macro">log::debug!</span>(<span class="string">"`BasicAuth` extract error: {}"</span>, <span class="ident">err</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">challenge</span> <span class="op">=</span> <span class="ident">req</span>
|
||||
.<span class="ident">app_data</span>::<span class="op"><</span><span class="ident">Config</span><span class="op">></span>()
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">config</span><span class="op">|</span> <span class="ident">config</span>.<span class="number">0</span>.<span class="ident">clone</span>())
|
||||
.<span class="ident">unwrap_or_default</span>();
|
||||
|
||||
<span class="ident">AuthenticationError::new</span>(<span class="ident">challenge</span>)
|
||||
AuthenticationError::new(challenge)
|
||||
}),
|
||||
)
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -142,149 +142,149 @@
|
||||
<span id="142">142</span>
|
||||
<span id="143">143</span>
|
||||
<span id="144">144</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Extractor for the "Bearer" HTTP Authentication Scheme.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Extractor for the "Bearer" HTTP Authentication Scheme.
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">borrow::Cow</span>, <span class="ident">default::Default</span>};
|
||||
</span><span class="kw">use </span>std::{borrow::Cow, default::Default};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_utils::future</span>::{<span class="ident">ready</span>, <span class="ident">Ready</span>};
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">dev::Payload</span>, <span class="ident">http::header::Header</span>, <span class="ident">FromRequest</span>, <span class="ident">HttpRequest</span>};
|
||||
<span class="kw">use </span>actix_utils::future::{ready, Ready};
|
||||
<span class="kw">use </span>actix_web::{dev::Payload, http::header::Header, FromRequest, HttpRequest};
|
||||
|
||||
<span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">config::AuthExtractorConfig</span>, <span class="ident">errors::AuthenticationError</span>};
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::www_authenticate::bearer::Error</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers</span>::{<span class="ident">authorization</span>, <span class="ident">www_authenticate::bearer</span>};
|
||||
<span class="kw">use super</span>::{config::AuthExtractorConfig, errors::AuthenticationError};
|
||||
<span class="kw">pub use </span><span class="kw">crate</span>::headers::www_authenticate::bearer::Error;
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::{authorization, www_authenticate::bearer};
|
||||
|
||||
<span class="doccomment">/// [`BearerAuth`] extractor configuration.</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Default</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Config</span>(<span class="ident">bearer::Bearer</span>);
|
||||
<span class="doccomment">/// [`BearerAuth`] extractor configuration.
|
||||
</span><span class="attribute">#[derive(Debug, Clone, Default)]
|
||||
</span><span class="kw">pub struct </span>Config(bearer::Bearer);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Config</span> {
|
||||
<span class="doccomment">/// Set challenge `scope` attribute.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// The `"scope"` attribute is a space-delimited list of case-sensitive</span>
|
||||
<span class="doccomment">/// scope values indicating the required scope of the access token for</span>
|
||||
<span class="doccomment">/// accessing the requested resource.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">scope</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">T</span>) -> <span class="ident">Config</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">scope</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="kw">impl </span>Config {
|
||||
<span class="doccomment">/// Set challenge `scope` attribute.
|
||||
///
|
||||
/// The `"scope"` attribute is a space-delimited list of case-sensitive
|
||||
/// scope values indicating the required scope of the access token for
|
||||
/// accessing the requested resource.
|
||||
</span><span class="kw">pub fn </span>scope<T: Into<Cow<<span class="lifetime">'static</span>, str>>>(<span class="kw-2">mut </span><span class="self">self</span>, value: T) -> Config {
|
||||
<span class="self">self</span>.<span class="number">0</span>.scope = <span class="prelude-val">Some</span>(value.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Set challenge `realm` attribute.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// The "realm" attribute indicates the scope of protection in the manner</span>
|
||||
<span class="doccomment">/// described in HTTP/1.1 [RFC 2617](https://tools.ietf.org/html/rfc2617#section-1.2).</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">realm</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">T</span>) -> <span class="ident">Config</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">realm</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
<span class="doccomment">/// Set challenge `realm` attribute.
|
||||
///
|
||||
/// The "realm" attribute indicates the scope of protection in the manner
|
||||
/// described in HTTP/1.1 [RFC 2617](https://tools.ietf.org/html/rfc2617#section-1.2).
|
||||
</span><span class="kw">pub fn </span>realm<T: Into<Cow<<span class="lifetime">'static</span>, str>>>(<span class="kw-2">mut </span><span class="self">self</span>, value: T) -> Config {
|
||||
<span class="self">self</span>.<span class="number">0</span>.realm = <span class="prelude-val">Some</span>(value.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>AsRef<bearer::Bearer> <span class="kw">for </span>Config {
|
||||
<span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>bearer::Bearer {
|
||||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl </span>AuthExtractorConfig <span class="kw">for </span>Config {
|
||||
<span class="kw">type </span>Inner = bearer::Bearer;
|
||||
|
||||
<span class="kw">fn </span>into_inner(<span class="self">self</span>) -> <span class="self">Self</span>::Inner {
|
||||
<span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Extractor for HTTP Bearer auth
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// use actix_web_httpauth::extractors::bearer::BearerAuth;
|
||||
///
|
||||
/// async fn index(auth: BearerAuth) -> String {
|
||||
/// format!("Hello, user with token {}!", auth.token())
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// If authentication fails, this extractor fetches the [`Config`] instance
|
||||
/// from the [app data] in order to properly form the `WWW-Authenticate`
|
||||
/// response header.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// use actix_web::{web, App};
|
||||
/// use actix_web_httpauth::extractors::bearer::{self, BearerAuth};
|
||||
///
|
||||
/// async fn index(auth: BearerAuth) -> String {
|
||||
/// format!("Hello, {}!", auth.token())
|
||||
/// }
|
||||
///
|
||||
/// App::new()
|
||||
/// .app_data(
|
||||
/// bearer::Config::default()
|
||||
/// .realm("Restricted area")
|
||||
/// .scope("email photo"),
|
||||
/// )
|
||||
/// .service(web::resource("/index.html").route(web::get().to(index)));
|
||||
/// ```
|
||||
</span><span class="attribute">#[derive(Debug, Clone)]
|
||||
</span><span class="kw">pub struct </span>BearerAuth(authorization::Bearer);
|
||||
|
||||
<span class="kw">impl </span>BearerAuth {
|
||||
<span class="doccomment">/// Returns bearer token provided by client.
|
||||
</span><span class="kw">pub fn </span>token(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
||||
<span class="self">self</span>.<span class="number">0</span>.token()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">bearer::Bearer</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Config</span> {
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">bearer::Bearer</span> {
|
||||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
}
|
||||
<span class="kw">impl </span>FromRequest <span class="kw">for </span>BearerAuth {
|
||||
<span class="kw">type </span>Future = Ready<<span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error>>;
|
||||
<span class="kw">type </span>Error = AuthenticationError<bearer::Bearer>;
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">AuthExtractorConfig</span> <span class="kw">for</span> <span class="ident">Config</span> {
|
||||
<span class="kw">type</span> <span class="ident">Inner</span> <span class="op">=</span> <span class="ident">bearer::Bearer</span>;
|
||||
<span class="kw">fn </span>from_request(req: <span class="kw-2">&</span>HttpRequest, _payload: <span class="kw-2">&mut </span>Payload) -> <<span class="self">Self </span><span class="kw">as </span>FromRequest>::Future {
|
||||
ready(
|
||||
authorization::Authorization::<authorization::Bearer>::parse(req)
|
||||
.map(|auth| BearerAuth(auth.into_scheme()))
|
||||
.map_err(|<span class="kw">_</span>| {
|
||||
<span class="kw">let </span>bearer = req
|
||||
.app_data::<Config>()
|
||||
.map(|config| config.<span class="number">0</span>.clone())
|
||||
.unwrap_or_else(Default::default);
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) -> <span class="ident"><span class="self">Self</span>::Inner</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Extractor for HTTP Bearer auth</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::extractors::bearer::BearerAuth;</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// async fn index(auth: BearerAuth) -> String {</span>
|
||||
<span class="doccomment">/// format!("Hello, user with token {}!", auth.token())</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// If authentication fails, this extractor fetches the [`Config`] instance</span>
|
||||
<span class="doccomment">/// from the [app data] in order to properly form the `WWW-Authenticate`</span>
|
||||
<span class="doccomment">/// response header.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// use actix_web::{web, App};</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::extractors::bearer::{self, BearerAuth};</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// async fn index(auth: BearerAuth) -> String {</span>
|
||||
<span class="doccomment">/// format!("Hello, {}!", auth.token())</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// App::new()</span>
|
||||
<span class="doccomment">/// .app_data(</span>
|
||||
<span class="doccomment">/// bearer::Config::default()</span>
|
||||
<span class="doccomment">/// .realm("Restricted area")</span>
|
||||
<span class="doccomment">/// .scope("email photo"),</span>
|
||||
<span class="doccomment">/// )</span>
|
||||
<span class="doccomment">/// .service(web::resource("/index.html").route(web::get().to(index)));</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">BearerAuth</span>(<span class="ident">authorization::Bearer</span>);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">BearerAuth</span> {
|
||||
<span class="doccomment">/// Returns bearer token provided by client.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">token</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">token</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">FromRequest</span> <span class="kw">for</span> <span class="ident">BearerAuth</span> {
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">Ready</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">bearer::Bearer</span><span class="op">></span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">from_request</span>(<span class="ident">req</span>: <span class="kw-2">&</span><span class="ident">HttpRequest</span>, <span class="ident">_payload</span>: <span class="kw-2">&mut</span> <span class="ident">Payload</span>) -> <span class="op"><</span><span class="self">Self</span> <span class="kw">as</span> <span class="ident">FromRequest</span><span class="op">></span><span class="ident">::Future</span> {
|
||||
<span class="ident">ready</span>(
|
||||
<span class="ident">authorization::Authorization</span>::<span class="op"><</span><span class="ident">authorization::Bearer</span><span class="op">></span><span class="ident">::parse</span>(<span class="ident">req</span>)
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">auth</span><span class="op">|</span> <span class="ident">BearerAuth</span>(<span class="ident">auth</span>.<span class="ident">into_scheme</span>()))
|
||||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
|
||||
<span class="kw">let</span> <span class="ident">bearer</span> <span class="op">=</span> <span class="ident">req</span>
|
||||
.<span class="ident">app_data</span>::<span class="op"><</span><span class="ident">Config</span><span class="op">></span>()
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">config</span><span class="op">|</span> <span class="ident">config</span>.<span class="number">0</span>.<span class="ident">clone</span>())
|
||||
.<span class="ident">unwrap_or_else</span>(<span class="ident">Default::default</span>);
|
||||
|
||||
<span class="ident">AuthenticationError::new</span>(<span class="ident">bearer</span>)
|
||||
AuthenticationError::new(bearer)
|
||||
}),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Extended error customization for HTTP `Bearer` auth.</span>
|
||||
<span class="kw">impl</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">bearer::Bearer</span><span class="op">></span> {
|
||||
<span class="doccomment">/// Attach `Error` to the current Authentication error.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Error status code will be changed to the one provided by the `kind`</span>
|
||||
<span class="doccomment">/// Error.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_error</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">kind</span>: <span class="ident">Error</span>) -> <span class="self">Self</span> {
|
||||
<span class="kw-2">*</span><span class="self">self</span>.<span class="ident">status_code_mut</span>() <span class="op">=</span> <span class="ident">kind</span>.<span class="ident">status_code</span>();
|
||||
<span class="self">self</span>.<span class="ident">challenge_mut</span>().<span class="ident">error</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">kind</span>);
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="doccomment">/// Extended error customization for HTTP `Bearer` auth.
|
||||
</span><span class="kw">impl </span>AuthenticationError<bearer::Bearer> {
|
||||
<span class="doccomment">/// Attach `Error` to the current Authentication error.
|
||||
///
|
||||
/// Error status code will be changed to the one provided by the `kind`
|
||||
/// Error.
|
||||
</span><span class="kw">pub fn </span>with_error(<span class="kw-2">mut </span><span class="self">self</span>, kind: Error) -> <span class="self">Self </span>{
|
||||
<span class="kw-2">*</span><span class="self">self</span>.status_code_mut() = kind.status_code();
|
||||
<span class="self">self</span>.challenge_mut().error = <span class="prelude-val">Some</span>(kind);
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Attach error description to the current Authentication error.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_error_description</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">desc</span>: <span class="ident">T</span>) -> <span class="self">Self</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Attach error description to the current Authentication error.
|
||||
</span><span class="kw">pub fn </span>with_error_description<T>(<span class="kw-2">mut </span><span class="self">self</span>, desc: T) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="self">self</span>.<span class="ident">challenge_mut</span>().<span class="ident">error_description</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">desc</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="self">self</span>.challenge_mut().error_description = <span class="prelude-val">Some</span>(desc.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Attach error URI to the current Authentication error.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// It is up to implementor to provide properly formed absolute URI.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_error_uri</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">uri</span>: <span class="ident">T</span>) -> <span class="self">Self</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Attach error URI to the current Authentication error.
|
||||
///
|
||||
/// It is up to implementor to provide properly formed absolute URI.
|
||||
</span><span class="kw">pub fn </span>with_error_uri<T>(<span class="kw-2">mut </span><span class="self">self</span>, uri: T) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="self">self</span>.<span class="ident">challenge_mut</span>().<span class="ident">error_uri</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">uri</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="self">self</span>.challenge_mut().error_uri = <span class="prelude-val">Some</span>(uri.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -19,26 +19,26 @@
|
||||
<span id="19">19</span>
|
||||
<span id="20">20</span>
|
||||
<span id="21">21</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident"><span class="kw">super</span>::AuthenticationError</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::www_authenticate::Challenge</span>;
|
||||
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">super</span>::AuthenticationError;
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::www_authenticate::Challenge;
|
||||
|
||||
<span class="doccomment">/// Trait implemented for types that provides configuration for the authentication</span>
|
||||
<span class="doccomment">/// [extractors](super::AuthExtractor).</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">AuthExtractorConfig</span> {
|
||||
<span class="doccomment">/// Associated challenge type.</span>
|
||||
<span class="kw">type</span> <span class="ident">Inner</span>: <span class="ident">Challenge</span>;
|
||||
<span class="doccomment">/// Trait implemented for types that provides configuration for the authentication
|
||||
/// [extractors](super::AuthExtractor).
|
||||
</span><span class="kw">pub trait </span>AuthExtractorConfig {
|
||||
<span class="doccomment">/// Associated challenge type.
|
||||
</span><span class="kw">type </span>Inner: Challenge;
|
||||
|
||||
<span class="doccomment">/// Convert the config instance into a HTTP challenge.</span>
|
||||
<span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) -> <span class="ident"><span class="self">Self</span>::Inner</span>;
|
||||
<span class="doccomment">/// Convert the config instance into a HTTP challenge.
|
||||
</span><span class="kw">fn </span>into_inner(<span class="self">self</span>) -> <span class="self">Self</span>::Inner;
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="op"><</span><span class="ident">T</span> <span class="kw">as</span> <span class="ident">AuthExtractorConfig</span><span class="op">></span><span class="ident">::Inner</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">AuthExtractorConfig</span>,
|
||||
<span class="kw">impl</span><T> From<T> <span class="kw">for </span>AuthenticationError<<T <span class="kw">as </span>AuthExtractorConfig>::Inner>
|
||||
<span class="kw">where
|
||||
</span>T: AuthExtractorConfig,
|
||||
{
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">config</span>: <span class="ident">T</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">AuthenticationError::new</span>(<span class="ident">config</span>.<span class="ident">into_inner</span>())
|
||||
<span class="kw">fn </span>from(config: T) -> <span class="self">Self </span>{
|
||||
AuthenticationError::new(config.into_inner())
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -77,84 +77,84 @@
|
||||
<span id="77">77</span>
|
||||
<span id="78">78</span>
|
||||
<span id="79">79</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">error::Error</span>, <span class="ident">fmt</span>};
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::{error::Error, fmt};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http::StatusCode</span>, <span class="ident">HttpResponse</span>, <span class="ident">ResponseError</span>};
|
||||
<span class="kw">use </span>actix_web::{http::StatusCode, HttpResponse, ResponseError};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::www_authenticate</span>::{<span class="ident">Challenge</span>, <span class="ident">WwwAuthenticate</span>};
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::www_authenticate::{Challenge, WwwAuthenticate};
|
||||
|
||||
<span class="doccomment">/// Authentication error returned by authentication extractors.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Different extractors may extend `AuthenticationError` implementation in order to provide access</span>
|
||||
<span class="doccomment">/// inner challenge fields.</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> {
|
||||
<span class="ident">challenge</span>: <span class="ident">C</span>,
|
||||
<span class="ident">status_code</span>: <span class="ident">StatusCode</span>,
|
||||
<span class="doccomment">/// Authentication error returned by authentication extractors.
|
||||
///
|
||||
/// Different extractors may extend `AuthenticationError` implementation in order to provide access
|
||||
/// inner challenge fields.
|
||||
</span><span class="attribute">#[derive(Debug)]
|
||||
</span><span class="kw">pub struct </span>AuthenticationError<C: Challenge> {
|
||||
challenge: C,
|
||||
status_code: StatusCode,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
|
||||
<span class="doccomment">/// Creates new authentication error from the provided `challenge`.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// By default returned error will resolve into the `HTTP 401` status code.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">challenge</span>: <span class="ident">C</span>) -> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
|
||||
<span class="ident">AuthenticationError</span> {
|
||||
<span class="ident">challenge</span>,
|
||||
<span class="ident">status_code</span>: <span class="ident">StatusCode::UNAUTHORIZED</span>,
|
||||
<span class="kw">impl</span><C: Challenge> AuthenticationError<C> {
|
||||
<span class="doccomment">/// Creates new authentication error from the provided `challenge`.
|
||||
///
|
||||
/// By default returned error will resolve into the `HTTP 401` status code.
|
||||
</span><span class="kw">pub fn </span>new(challenge: C) -> AuthenticationError<C> {
|
||||
AuthenticationError {
|
||||
challenge,
|
||||
status_code: StatusCode::UNAUTHORIZED,
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns mutable reference to the inner challenge instance.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">challenge_mut</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="kw-2">&mut</span> <span class="ident">C</span> {
|
||||
<span class="kw-2">&mut</span> <span class="self">self</span>.<span class="ident">challenge</span>
|
||||
<span class="doccomment">/// Returns mutable reference to the inner challenge instance.
|
||||
</span><span class="kw">pub fn </span>challenge_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>C {
|
||||
<span class="kw-2">&mut </span><span class="self">self</span>.challenge
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns mutable reference to the inner status code.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Can be used to override returned status code, but by default this lib tries to stick to the</span>
|
||||
<span class="doccomment">/// RFC, so it might be unreasonable.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">status_code_mut</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="kw-2">&mut</span> <span class="ident">StatusCode</span> {
|
||||
<span class="kw-2">&mut</span> <span class="self">self</span>.<span class="ident">status_code</span>
|
||||
<span class="doccomment">/// Returns mutable reference to the inner status code.
|
||||
///
|
||||
/// Can be used to override returned status code, but by default this lib tries to stick to the
|
||||
/// RFC, so it might be unreasonable.
|
||||
</span><span class="kw">pub fn </span>status_code_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>StatusCode {
|
||||
<span class="kw-2">&mut </span><span class="self">self</span>.status_code
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="ident">fmt::Display::fmt</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">status_code</span>, <span class="ident">f</span>)
|
||||
<span class="kw">impl</span><C: Challenge> fmt::Display <span class="kw">for </span>AuthenticationError<C> {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
fmt::Display::fmt(<span class="kw-2">&</span><span class="self">self</span>.status_code, f)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span> <span class="op">+</span> <span class="lifetime">'static</span><span class="op">></span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {}
|
||||
<span class="kw">impl</span><C: Challenge + <span class="lifetime">'static</span>> Error <span class="kw">for </span>AuthenticationError<C> {}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span> <span class="op">+</span> <span class="lifetime">'static</span><span class="op">></span> <span class="ident">ResponseError</span> <span class="kw">for</span> <span class="ident">AuthenticationError</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">status_code</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">StatusCode</span> {
|
||||
<span class="self">self</span>.<span class="ident">status_code</span>
|
||||
<span class="kw">impl</span><C: Challenge + <span class="lifetime">'static</span>> ResponseError <span class="kw">for </span>AuthenticationError<C> {
|
||||
<span class="kw">fn </span>status_code(<span class="kw-2">&</span><span class="self">self</span>) -> StatusCode {
|
||||
<span class="self">self</span>.status_code
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">error_response</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">HttpResponse</span> {
|
||||
<span class="ident">HttpResponse::build</span>(<span class="self">self</span>.<span class="ident">status_code</span>())
|
||||
.<span class="ident">insert_header</span>(<span class="ident">WwwAuthenticate</span>(<span class="self">self</span>.<span class="ident">challenge</span>.<span class="ident">clone</span>()))
|
||||
.<span class="ident">finish</span>()
|
||||
<span class="kw">fn </span>error_response(<span class="kw-2">&</span><span class="self">self</span>) -> HttpResponse {
|
||||
HttpResponse::build(<span class="self">self</span>.status_code())
|
||||
.insert_header(WwwAuthenticate(<span class="self">self</span>.challenge.clone()))
|
||||
.finish()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="ident">actix_web::Error</span>;
|
||||
<span class="attribute">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use </span>actix_web::Error;
|
||||
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::www_authenticate::basic::Basic</span>;
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::www_authenticate::basic::Basic;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_status_code_is_preserved_across_error_conversions</span>() {
|
||||
<span class="kw">let</span> <span class="ident">ae</span> <span class="op">=</span> <span class="ident">AuthenticationError::new</span>(<span class="ident">Basic::default</span>());
|
||||
<span class="kw">let</span> <span class="ident">expected</span> <span class="op">=</span> <span class="ident">ae</span>.<span class="ident">status_code</span>;
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_status_code_is_preserved_across_error_conversions() {
|
||||
<span class="kw">let </span>ae = AuthenticationError::new(Basic::default());
|
||||
<span class="kw">let </span>expected = ae.status_code;
|
||||
|
||||
<span class="comment">// Converting the AuthenticationError into a ResponseError should preserve the status code.</span>
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">Error::from</span>(<span class="ident">ae</span>);
|
||||
<span class="kw">let</span> <span class="ident">res_err</span> <span class="op">=</span> <span class="ident">err</span>.<span class="ident">as_response_error</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">expected</span>, <span class="ident">res_err</span>.<span class="ident">status_code</span>());
|
||||
<span class="comment">// Converting the AuthenticationError into a ResponseError should preserve the status code.
|
||||
</span><span class="kw">let </span>err = Error::from(ae);
|
||||
<span class="kw">let </span>res_err = err.as_response_error();
|
||||
<span class="macro">assert_eq!</span>(expected, res_err.status_code());
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -7,14 +7,14 @@
|
||||
<span id="7">7</span>
|
||||
<span id="8">8</span>
|
||||
<span id="9">9</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Type-safe authentication information extractors.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Type-safe authentication information extractors.
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">basic</span>;
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">bearer</span>;
|
||||
<span class="kw">mod</span> <span class="ident">config</span>;
|
||||
<span class="kw">mod</span> <span class="ident">errors</span>;
|
||||
</span><span class="kw">pub mod </span>basic;
|
||||
<span class="kw">pub mod </span>bearer;
|
||||
<span class="kw">mod </span>config;
|
||||
<span class="kw">mod </span>errors;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::config::AuthExtractorConfig</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::errors::AuthenticationError</span>;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::config::AuthExtractorConfig;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::errors::AuthenticationError;
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -70,77 +70,77 @@
|
||||
<span id="70">70</span>
|
||||
<span id="71">71</span>
|
||||
<span id="72">72</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">convert::From</span>, <span class="ident">error::Error</span>, <span class="ident">fmt</span>, <span class="ident">str</span>};
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::{convert::From, error::Error, fmt, str};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web::http::header</span>;
|
||||
<span class="kw">use </span>actix_web::http::header;
|
||||
|
||||
<span class="doccomment">/// Possible errors while parsing `Authorization` header.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Should not be used directly unless you are implementing your own</span>
|
||||
<span class="doccomment">/// [authentication scheme](super::Scheme).</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">ParseError</span> {
|
||||
<span class="doccomment">/// Header value is malformed.</span>
|
||||
<span class="ident">Invalid</span>,
|
||||
<span class="doccomment">/// Possible errors while parsing `Authorization` header.
|
||||
///
|
||||
/// Should not be used directly unless you are implementing your own
|
||||
/// [authentication scheme](super::Scheme).
|
||||
</span><span class="attribute">#[derive(Debug)]
|
||||
</span><span class="kw">pub enum </span>ParseError {
|
||||
<span class="doccomment">/// Header value is malformed.
|
||||
</span>Invalid,
|
||||
|
||||
<span class="doccomment">/// Authentication scheme is missing.</span>
|
||||
<span class="ident">MissingScheme</span>,
|
||||
<span class="doccomment">/// Authentication scheme is missing.
|
||||
</span>MissingScheme,
|
||||
|
||||
<span class="doccomment">/// Required authentication field is missing.</span>
|
||||
<span class="ident">MissingField</span>(<span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>),
|
||||
<span class="doccomment">/// Required authentication field is missing.
|
||||
</span>MissingField(<span class="kw-2">&</span><span class="lifetime">'static </span>str),
|
||||
|
||||
<span class="doccomment">/// Unable to convert header into the str.</span>
|
||||
<span class="ident">ToStrError</span>(<span class="ident">header::ToStrError</span>),
|
||||
<span class="doccomment">/// Unable to convert header into the str.
|
||||
</span>ToStrError(header::ToStrError),
|
||||
|
||||
<span class="doccomment">/// Malformed base64 string.</span>
|
||||
<span class="ident">Base64DecodeError</span>(<span class="ident">base64::DecodeError</span>),
|
||||
<span class="doccomment">/// Malformed base64 string.
|
||||
</span>Base64DecodeError(base64::DecodeError),
|
||||
|
||||
<span class="doccomment">/// Malformed UTF-8 string.</span>
|
||||
<span class="ident">Utf8Error</span>(<span class="ident">str::Utf8Error</span>),
|
||||
<span class="doccomment">/// Malformed UTF-8 string.
|
||||
</span>Utf8Error(str::Utf8Error),
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">ParseError</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident">ParseError::Invalid</span> => <span class="ident">f</span>.<span class="ident">write_str</span>(<span class="string">"Invalid header value"</span>),
|
||||
<span class="ident">ParseError::MissingScheme</span> => <span class="ident">f</span>.<span class="ident">write_str</span>(<span class="string">"Missing authorization scheme"</span>),
|
||||
<span class="ident">ParseError::MissingField</span>(<span class="ident">field</span>) => <span class="macro">write!</span>(<span class="ident">f</span>, <span class="string">"Missing header field ({})"</span>, <span class="ident">field</span>),
|
||||
<span class="ident">ParseError::ToStrError</span>(<span class="ident">err</span>) => <span class="ident">fmt::Display::fmt</span>(<span class="ident">err</span>, <span class="ident">f</span>),
|
||||
<span class="ident">ParseError::Base64DecodeError</span>(<span class="ident">err</span>) => <span class="ident">fmt::Display::fmt</span>(<span class="ident">err</span>, <span class="ident">f</span>),
|
||||
<span class="ident">ParseError::Utf8Error</span>(<span class="ident">err</span>) => <span class="ident">fmt::Display::fmt</span>(<span class="ident">err</span>, <span class="ident">f</span>),
|
||||
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>ParseError {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
<span class="kw">match </span><span class="self">self </span>{
|
||||
ParseError::Invalid => f.write_str(<span class="string">"Invalid header value"</span>),
|
||||
ParseError::MissingScheme => f.write_str(<span class="string">"Missing authorization scheme"</span>),
|
||||
ParseError::MissingField(field) => <span class="macro">write!</span>(f, <span class="string">"Missing header field ({})"</span>, field),
|
||||
ParseError::ToStrError(err) => fmt::Display::fmt(err, f),
|
||||
ParseError::Base64DecodeError(err) => fmt::Display::fmt(err, f),
|
||||
ParseError::Utf8Error(err) => fmt::Display::fmt(err, f),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Error</span> <span class="kw">for</span> <span class="ident">ParseError</span> {
|
||||
<span class="kw">fn</span> <span class="ident">source</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span>(<span class="kw">dyn</span> <span class="ident">Error</span> <span class="op">+</span> <span class="lifetime">'static</span>)<span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident">ParseError::Invalid</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident">ParseError::MissingScheme</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident">ParseError::MissingField</span>(<span class="kw">_</span>) => <span class="prelude-val">None</span>,
|
||||
<span class="ident">ParseError::ToStrError</span>(<span class="ident">err</span>) => <span class="prelude-val">Some</span>(<span class="ident">err</span>),
|
||||
<span class="ident">ParseError::Base64DecodeError</span>(<span class="ident">err</span>) => <span class="prelude-val">Some</span>(<span class="ident">err</span>),
|
||||
<span class="ident">ParseError::Utf8Error</span>(<span class="ident">err</span>) => <span class="prelude-val">Some</span>(<span class="ident">err</span>),
|
||||
<span class="kw">impl </span>Error <span class="kw">for </span>ParseError {
|
||||
<span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>Error + <span class="lifetime">'static</span>)> {
|
||||
<span class="kw">match </span><span class="self">self </span>{
|
||||
ParseError::Invalid => <span class="prelude-val">None</span>,
|
||||
ParseError::MissingScheme => <span class="prelude-val">None</span>,
|
||||
ParseError::MissingField(<span class="kw">_</span>) => <span class="prelude-val">None</span>,
|
||||
ParseError::ToStrError(err) => <span class="prelude-val">Some</span>(err),
|
||||
ParseError::Base64DecodeError(err) => <span class="prelude-val">Some</span>(err),
|
||||
ParseError::Utf8Error(err) => <span class="prelude-val">Some</span>(err),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">header::ToStrError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ParseError</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">header::ToStrError</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">ParseError::ToStrError</span>(<span class="ident">err</span>)
|
||||
<span class="kw">impl </span>From<header::ToStrError> <span class="kw">for </span>ParseError {
|
||||
<span class="kw">fn </span>from(err: header::ToStrError) -> <span class="self">Self </span>{
|
||||
ParseError::ToStrError(err)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">base64::DecodeError</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ParseError</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">base64::DecodeError</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">ParseError::Base64DecodeError</span>(<span class="ident">err</span>)
|
||||
<span class="kw">impl </span>From<base64::DecodeError> <span class="kw">for </span>ParseError {
|
||||
<span class="kw">fn </span>from(err: base64::DecodeError) -> <span class="self">Self </span>{
|
||||
ParseError::Base64DecodeError(err)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">str::Utf8Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">ParseError</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">str::Utf8Error</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">ParseError::Utf8Error</span>(<span class="ident">err</span>)
|
||||
<span class="kw">impl </span>From<str::Utf8Error> <span class="kw">for </span>ParseError {
|
||||
<span class="kw">fn </span>from(err: str::Utf8Error) -> <span class="self">Self </span>{
|
||||
ParseError::Utf8Error(err)
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -82,89 +82,89 @@
|
||||
<span id="82">82</span>
|
||||
<span id="83">83</span>
|
||||
<span id="84">84</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::fmt</span>;
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">error::ParseError</span>,
|
||||
<span class="ident">http::header</span>::{<span class="ident">Header</span>, <span class="ident">HeaderName</span>, <span class="ident">HeaderValue</span>, <span class="ident">TryIntoHeaderValue</span>, <span class="ident">AUTHORIZATION</span>},
|
||||
<span class="ident">HttpMessage</span>,
|
||||
<span class="kw">use </span>actix_web::{
|
||||
error::ParseError,
|
||||
http::header::{Header, HeaderName, HeaderValue, TryIntoHeaderValue, AUTHORIZATION},
|
||||
HttpMessage,
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::authorization::scheme::Scheme</span>;
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::authorization::scheme::Scheme;
|
||||
|
||||
<span class="doccomment">/// `Authorization` header, defined in [RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.2)</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// The "Authorization" header field allows a user agent to authenticate itself with an origin</span>
|
||||
<span class="doccomment">/// server—usually, but not necessarily, after receiving a 401 (Unauthorized) response. Its value</span>
|
||||
<span class="doccomment">/// consists of credentials containing the authentication information of the user agent for the</span>
|
||||
<span class="doccomment">/// realm of the resource being requested.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// `Authorization` is generic over an [authentication scheme](Scheme).</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web::{HttpRequest, Result, http::header::Header};</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::headers::authorization::{Authorization, Basic};</span>
|
||||
<span class="doccomment">/// fn handler(req: HttpRequest) -> Result<String> {</span>
|
||||
<span class="doccomment">/// let auth = Authorization::<Basic>::parse(&req)?;</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Ok(format!("Hello, {}!", auth.as_ref().user_id()))</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span>(<span class="ident">S</span>);
|
||||
<span class="doccomment">/// `Authorization` header, defined in [RFC 7235](https://tools.ietf.org/html/rfc7235#section-4.2)
|
||||
///
|
||||
/// The "Authorization" header field allows a user agent to authenticate itself with an origin
|
||||
/// server—usually, but not necessarily, after receiving a 401 (Unauthorized) response. Its value
|
||||
/// consists of credentials containing the authentication information of the user agent for the
|
||||
/// realm of the resource being requested.
|
||||
///
|
||||
/// `Authorization` is generic over an [authentication scheme](Scheme).
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web::{HttpRequest, Result, http::header::Header};
|
||||
/// # use actix_web_httpauth::headers::authorization::{Authorization, Basic};
|
||||
/// fn handler(req: HttpRequest) -> Result<String> {
|
||||
/// let auth = Authorization::<Basic>::parse(&req)?;
|
||||
///
|
||||
/// Ok(format!("Hello, {}!", auth.as_ref().user_id()))
|
||||
/// }
|
||||
/// ```
|
||||
</span><span class="attribute">#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||
</span><span class="kw">pub struct </span>Authorization<S: Scheme>(S);
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="doccomment">/// Consumes `Authorization` header and returns inner [`Scheme`] implementation.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_scheme</span>(<span class="self">self</span>) -> <span class="ident">S</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
<span class="kw">impl</span><S: Scheme> Authorization<S> {
|
||||
<span class="doccomment">/// Consumes `Authorization` header and returns inner [`Scheme`] implementation.
|
||||
</span><span class="kw">pub fn </span>into_scheme(<span class="self">self</span>) -> S {
|
||||
<span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><S: Scheme> From<S> <span class="kw">for </span>Authorization<S> {
|
||||
<span class="kw">fn </span>from(scheme: S) -> Authorization<S> {
|
||||
Authorization(scheme)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">From</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">scheme</span>: <span class="ident">S</span>) -> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="ident">Authorization</span>(<span class="ident">scheme</span>)
|
||||
<span class="kw">impl</span><S: Scheme> AsRef<S> <span class="kw">for </span>Authorization<S> {
|
||||
<span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>S {
|
||||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><S: Scheme> AsMut<S> <span class="kw">for </span>Authorization<S> {
|
||||
<span class="kw">fn </span>as_mut(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="kw-2">&mut </span>S {
|
||||
<span class="kw-2">&mut </span><span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><S: Scheme> fmt::Display <span class="kw">for </span>Authorization<S> {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
fmt::Display::fmt(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, f)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">AsRef</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">as_ref</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">S</span> {
|
||||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>
|
||||
<span class="kw">impl</span><S: Scheme> Header <span class="kw">for </span>Authorization<S> {
|
||||
<span class="attribute">#[inline]
|
||||
</span><span class="kw">fn </span>name() -> HeaderName {
|
||||
AUTHORIZATION
|
||||
}
|
||||
|
||||
<span class="kw">fn </span>parse<T: HttpMessage>(msg: <span class="kw-2">&</span>T) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, ParseError> {
|
||||
<span class="kw">let </span>header = msg.headers().get(<span class="self">Self</span>::name()).ok_or(ParseError::Header)<span class="question-mark">?</span>;
|
||||
<span class="kw">let </span>scheme = S::parse(header).map_err(|<span class="kw">_</span>| ParseError::Header)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(Authorization(scheme))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">AsMut</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">as_mut</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="kw-2">&mut</span> <span class="ident">S</span> {
|
||||
<span class="kw-2">&mut</span> <span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
}
|
||||
<span class="kw">impl</span><S: Scheme> TryIntoHeaderValue <span class="kw">for </span>Authorization<S> {
|
||||
<span class="kw">type </span>Error = <S <span class="kw">as </span>TryIntoHeaderValue>::Error;
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="ident">fmt::Display::fmt</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>, <span class="ident">f</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">Header</span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">name</span>() -> <span class="ident">HeaderName</span> {
|
||||
<span class="ident">AUTHORIZATION</span>
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">parse</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">HttpMessage</span><span class="op">></span>(<span class="ident">msg</span>: <span class="kw-2">&</span><span class="ident">T</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ParseError</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">header</span> <span class="op">=</span> <span class="ident">msg</span>.<span class="ident">headers</span>().<span class="ident">get</span>(<span class="ident"><span class="self">Self</span>::name</span>()).<span class="ident">ok_or</span>(<span class="ident">ParseError::Header</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">S::parse</span>(<span class="ident">header</span>).<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">ParseError::Header</span>)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">Authorization</span>(<span class="ident">scheme</span>))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>: <span class="ident">Scheme</span><span class="op">></span> <span class="ident">TryIntoHeaderValue</span> <span class="kw">for</span> <span class="ident">Authorization</span><span class="op"><</span><span class="ident">S</span><span class="op">></span> {
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="op"><</span><span class="ident">S</span> <span class="kw">as</span> <span class="ident">TryIntoHeaderValue</span><span class="op">></span><span class="ident">::Error</span>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">try_into_value</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HeaderValue</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">try_into_value</span>()
|
||||
<span class="kw">fn </span>try_into_value(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><HeaderValue, <span class="self">Self</span>::Error> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.try_into_value()
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -7,14 +7,14 @@
|
||||
<span id="7">7</span>
|
||||
<span id="8">8</span>
|
||||
<span id="9">9</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! `Authorization` header and various auth schemes.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! `Authorization` header and various auth schemes.
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">errors</span>;
|
||||
<span class="kw">mod</span> <span class="ident">header</span>;
|
||||
<span class="kw">mod</span> <span class="ident">scheme</span>;
|
||||
</span><span class="kw">mod </span>errors;
|
||||
<span class="kw">mod </span>header;
|
||||
<span class="kw">mod </span>scheme;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::errors::ParseError</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::header::Authorization</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::scheme</span>::{<span class="ident">basic::Basic</span>, <span class="ident">bearer::Bearer</span>, <span class="ident">Scheme</span>};
|
||||
<span class="kw">pub use </span><span class="self">self</span>::errors::ParseError;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::header::Authorization;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::scheme::{basic::Basic, bearer::Bearer, Scheme};
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -193,200 +193,200 @@
|
||||
<span id="193">193</span>
|
||||
<span id="194">194</span>
|
||||
<span id="195">195</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">borrow::Cow</span>, <span class="ident">fmt</span>, <span class="ident">str</span>};
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::{borrow::Cow, fmt, str};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">http::header</span>::{<span class="ident">HeaderValue</span>, <span class="ident">InvalidHeaderValue</span>, <span class="ident">TryIntoHeaderValue</span>},
|
||||
<span class="ident">web</span>::{<span class="ident">BufMut</span>, <span class="ident">BytesMut</span>},
|
||||
<span class="kw">use </span>actix_web::{
|
||||
http::header::{HeaderValue, InvalidHeaderValue, TryIntoHeaderValue},
|
||||
web::{BufMut, BytesMut},
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::authorization</span>::{<span class="ident">errors::ParseError</span>, <span class="ident">Scheme</span>};
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::authorization::{errors::ParseError, Scheme};
|
||||
|
||||
<span class="doccomment">/// Credentials for `Basic` authentication scheme, defined in [RFC 7617](https://tools.ietf.org/html/rfc7617)</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Basic</span> {
|
||||
<span class="ident">user_id</span>: <span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span>,
|
||||
<span class="ident">password</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Credentials for `Basic` authentication scheme, defined in [RFC 7617](https://tools.ietf.org/html/rfc7617)
|
||||
</span><span class="attribute">#[derive(Clone, PartialEq, Eq, PartialOrd, Ord)]
|
||||
</span><span class="kw">pub struct </span>Basic {
|
||||
user_id: Cow<<span class="lifetime">'static</span>, str>,
|
||||
password: <span class="prelude-ty">Option</span><Cow<<span class="lifetime">'static</span>, str>>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Basic</span> {
|
||||
<span class="doccomment">/// Creates `Basic` credentials with provided `user_id` and optional</span>
|
||||
<span class="doccomment">/// `password`.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::headers::authorization::Basic;</span>
|
||||
<span class="doccomment">/// let credentials = Basic::new("Alladin", Some("open sesame"));</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">U</span>, <span class="ident">P</span><span class="op">></span>(<span class="ident">user_id</span>: <span class="ident">U</span>, <span class="ident">password</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">P</span><span class="op">></span>) -> <span class="ident">Basic</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">U</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="ident">P</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">impl </span>Basic {
|
||||
<span class="doccomment">/// Creates `Basic` credentials with provided `user_id` and optional
|
||||
/// `password`.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web_httpauth::headers::authorization::Basic;
|
||||
/// let credentials = Basic::new("Alladin", Some("open sesame"));
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>new<U, P>(user_id: U, password: <span class="prelude-ty">Option</span><P>) -> Basic
|
||||
<span class="kw">where
|
||||
</span>U: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
P: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="ident">Basic</span> {
|
||||
<span class="ident">user_id</span>: <span class="ident">user_id</span>.<span class="ident">into</span>(),
|
||||
<span class="ident">password</span>: <span class="ident">password</span>.<span class="ident">map</span>(<span class="ident">Into::into</span>),
|
||||
Basic {
|
||||
user_id: user_id.into(),
|
||||
password: password.map(Into::into),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns client's user-ID.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">user_id</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="ident">user_id</span>.<span class="ident">as_ref</span>()
|
||||
<span class="doccomment">/// Returns client's user-ID.
|
||||
</span><span class="kw">pub fn </span>user_id(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
||||
<span class="self">self</span>.user_id.as_ref()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Returns client's password if provided.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">password</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="ident">password</span>.<span class="ident">as_deref</span>()
|
||||
<span class="doccomment">/// Returns client's password if provided.
|
||||
</span><span class="kw">pub fn </span>password(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> {
|
||||
<span class="self">self</span>.password.as_deref()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Scheme</span> <span class="kw">for</span> <span class="ident">Basic</span> {
|
||||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">header</span>: <span class="kw-2">&</span><span class="ident">HeaderValue</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ParseError</span><span class="op">></span> {
|
||||
<span class="comment">// "Basic *" length</span>
|
||||
<span class="kw">if</span> <span class="ident">header</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="number">7</span> {
|
||||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">ParseError::Invalid</span>);
|
||||
<span class="kw">impl </span>Scheme <span class="kw">for </span>Basic {
|
||||
<span class="kw">fn </span>parse(header: <span class="kw-2">&</span>HeaderValue) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, ParseError> {
|
||||
<span class="comment">// "Basic *" length
|
||||
</span><span class="kw">if </span>header.len() < <span class="number">7 </span>{
|
||||
<span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::Invalid);
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parts</span> <span class="op">=</span> <span class="ident">header</span>.<span class="ident">to_str</span>()<span class="question-mark">?</span>.<span class="ident">splitn</span>(<span class="number">2</span>, <span class="string">' '</span>);
|
||||
<span class="kw">match</span> <span class="ident">parts</span>.<span class="ident">next</span>() {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">scheme</span>) <span class="kw">if</span> <span class="ident">scheme</span> <span class="op">==</span> <span class="string">"Basic"</span> => (),
|
||||
<span class="kw">_</span> => <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">ParseError::MissingScheme</span>),
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>parts = header.to_str()<span class="question-mark">?</span>.splitn(<span class="number">2</span>, <span class="string">' '</span>);
|
||||
<span class="kw">match </span>parts.next() {
|
||||
<span class="prelude-val">Some</span>(scheme) <span class="kw">if </span>scheme == <span class="string">"Basic" </span>=> (),
|
||||
<span class="kw">_ </span>=> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::MissingScheme),
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="ident">decoded</span> <span class="op">=</span> <span class="ident">base64::decode</span>(<span class="ident">parts</span>.<span class="ident">next</span>().<span class="ident">ok_or</span>(<span class="ident">ParseError::Invalid</span>)<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">credentials</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">decoded</span>)<span class="question-mark">?</span>.<span class="ident">splitn</span>(<span class="number">2</span>, <span class="string">':'</span>);
|
||||
<span class="kw">let </span>decoded = base64::decode(parts.next().ok_or(ParseError::Invalid)<span class="question-mark">?</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>credentials = str::from_utf8(<span class="kw-2">&</span>decoded)<span class="question-mark">?</span>.splitn(<span class="number">2</span>, <span class="string">':'</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">user_id</span> <span class="op">=</span> <span class="ident">credentials</span>
|
||||
.<span class="ident">next</span>()
|
||||
.<span class="ident">ok_or</span>(<span class="ident">ParseError::MissingField</span>(<span class="string">"user_id"</span>))
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">user_id</span><span class="op">|</span> <span class="ident">user_id</span>.<span class="ident">to_string</span>().<span class="ident">into</span>())<span class="question-mark">?</span>;
|
||||
<span class="kw">let </span>user_id = credentials
|
||||
.next()
|
||||
.ok_or(ParseError::MissingField(<span class="string">"user_id"</span>))
|
||||
.map(|user_id| user_id.to_string().into())<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">password</span> <span class="op">=</span> <span class="ident">credentials</span>
|
||||
.<span class="ident">next</span>()
|
||||
.<span class="ident">ok_or</span>(<span class="ident">ParseError::MissingField</span>(<span class="string">"password"</span>))
|
||||
.<span class="ident">map</span>(<span class="op">|</span><span class="ident">password</span><span class="op">|</span> {
|
||||
<span class="kw">if</span> <span class="ident">password</span>.<span class="ident">is_empty</span>() {
|
||||
<span class="prelude-val">None</span>
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">password</span>.<span class="ident">to_string</span>().<span class="ident">into</span>())
|
||||
<span class="kw">let </span>password = credentials
|
||||
.next()
|
||||
.ok_or(ParseError::MissingField(<span class="string">"password"</span>))
|
||||
.map(|password| {
|
||||
<span class="kw">if </span>password.is_empty() {
|
||||
<span class="prelude-val">None
|
||||
</span>} <span class="kw">else </span>{
|
||||
<span class="prelude-val">Some</span>(password.to_string().into())
|
||||
}
|
||||
})<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">Basic</span> { <span class="ident">user_id</span>, <span class="ident">password</span> })
|
||||
<span class="prelude-val">Ok</span>(Basic { user_id, password })
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Debug</span> <span class="kw">for</span> <span class="ident">Basic</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="ident">f</span>.<span class="ident">write_fmt</span>(<span class="macro">format_args!</span>(<span class="string">"Basic {}:******"</span>, <span class="self">self</span>.<span class="ident">user_id</span>))
|
||||
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Basic {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
f.write_fmt(<span class="macro">format_args!</span>(<span class="string">"Basic {}:******"</span>, <span class="self">self</span>.user_id))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Basic</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="ident">f</span>.<span class="ident">write_fmt</span>(<span class="macro">format_args!</span>(<span class="string">"Basic {}:******"</span>, <span class="self">self</span>.<span class="ident">user_id</span>))
|
||||
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Basic {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
f.write_fmt(<span class="macro">format_args!</span>(<span class="string">"Basic {}:******"</span>, <span class="self">self</span>.user_id))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">TryIntoHeaderValue</span> <span class="kw">for</span> <span class="ident">Basic</span> {
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">InvalidHeaderValue</span>;
|
||||
<span class="kw">impl </span>TryIntoHeaderValue <span class="kw">for </span>Basic {
|
||||
<span class="kw">type </span>Error = InvalidHeaderValue;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">try_into_value</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HeaderValue</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">credentials</span> <span class="op">=</span> <span class="ident">BytesMut::with_capacity</span>(
|
||||
<span class="self">self</span>.<span class="ident">user_id</span>.<span class="ident">len</span>()
|
||||
<span class="op">+</span> <span class="number">1</span> <span class="comment">// ':'</span>
|
||||
<span class="op">+</span> <span class="self">self</span>.<span class="ident">password</span>.<span class="ident">as_ref</span>().<span class="ident">map_or</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">pwd</span><span class="op">|</span> <span class="ident">pwd</span>.<span class="ident">len</span>()),
|
||||
<span class="kw">fn </span>try_into_value(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><HeaderValue, <span class="self">Self</span>::Error> {
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>credentials = BytesMut::with_capacity(
|
||||
<span class="self">self</span>.user_id.len()
|
||||
+ <span class="number">1 </span><span class="comment">// ':'
|
||||
</span>+ <span class="self">self</span>.password.as_ref().map_or(<span class="number">0</span>, |pwd| pwd.len()),
|
||||
);
|
||||
|
||||
<span class="ident">credentials</span>.<span class="ident">extend_from_slice</span>(<span class="self">self</span>.<span class="ident">user_id</span>.<span class="ident">as_bytes</span>());
|
||||
<span class="ident">credentials</span>.<span class="ident">put_u8</span>(<span class="string">b':'</span>);
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">password</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">password</span> {
|
||||
<span class="ident">credentials</span>.<span class="ident">extend_from_slice</span>(<span class="ident">password</span>.<span class="ident">as_bytes</span>());
|
||||
credentials.extend_from_slice(<span class="self">self</span>.user_id.as_bytes());
|
||||
credentials.put_u8(<span class="string">b':'</span>);
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>password) = <span class="self">self</span>.password {
|
||||
credentials.extend_from_slice(password.as_bytes());
|
||||
}
|
||||
|
||||
<span class="comment">// TODO: It would be nice not to allocate new `String` here but write</span>
|
||||
<span class="comment">// directly to `value`</span>
|
||||
<span class="kw">let</span> <span class="ident">encoded</span> <span class="op">=</span> <span class="ident">base64::encode</span>(<span class="kw-2">&</span><span class="ident">credentials</span>);
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">BytesMut::with_capacity</span>(<span class="number">6</span> <span class="op">+</span> <span class="ident">encoded</span>.<span class="ident">len</span>());
|
||||
<span class="ident">value</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b"Basic "</span>[..]);
|
||||
<span class="ident">value</span>.<span class="ident">put</span>(<span class="ident">encoded</span>.<span class="ident">as_bytes</span>());
|
||||
<span class="comment">// TODO: It would be nice not to allocate new `String` here but write
|
||||
// directly to `value`
|
||||
</span><span class="kw">let </span>encoded = base64::encode(<span class="kw-2">&</span>credentials);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>value = BytesMut::with_capacity(<span class="number">6 </span>+ encoded.len());
|
||||
value.put(<span class="kw-2">&</span><span class="string">b"Basic "</span>[..]);
|
||||
value.put(encoded.as_bytes());
|
||||
|
||||
<span class="ident">HeaderValue::from_maybe_shared</span>(<span class="ident">value</span>.<span class="ident">freeze</span>())
|
||||
HeaderValue::from_maybe_shared(value.freeze())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
<span class="attribute">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_parse_header</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Basic::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_parse_header() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="</span>);
|
||||
<span class="kw">let </span>scheme = Basic::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_ok</span>());
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">scheme</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">scheme</span>.<span class="ident">user_id</span>, <span class="string">"Aladdin"</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">scheme</span>.<span class="ident">password</span>, <span class="prelude-val">Some</span>(<span class="string">"open sesame"</span>.<span class="ident">into</span>()));
|
||||
<span class="macro">assert!</span>(scheme.is_ok());
|
||||
<span class="kw">let </span>scheme = scheme.unwrap();
|
||||
<span class="macro">assert_eq!</span>(scheme.user_id, <span class="string">"Aladdin"</span>);
|
||||
<span class="macro">assert_eq!</span>(scheme.password, <span class="prelude-val">Some</span>(<span class="string">"open sesame"</span>.into()));
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_empty_password</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"Basic QWxhZGRpbjo="</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Basic::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_empty_password() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"Basic QWxhZGRpbjo="</span>);
|
||||
<span class="kw">let </span>scheme = Basic::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_ok</span>());
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">scheme</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">scheme</span>.<span class="ident">user_id</span>, <span class="string">"Aladdin"</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">scheme</span>.<span class="ident">password</span>, <span class="prelude-val">None</span>);
|
||||
<span class="macro">assert!</span>(scheme.is_ok());
|
||||
<span class="kw">let </span>scheme = scheme.unwrap();
|
||||
<span class="macro">assert_eq!</span>(scheme.user_id, <span class="string">"Aladdin"</span>);
|
||||
<span class="macro">assert_eq!</span>(scheme.password, <span class="prelude-val">None</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_empty_header</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">""</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Basic::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_empty_header() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">""</span>);
|
||||
<span class="kw">let </span>scheme = Basic::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(scheme.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_wrong_scheme</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"THOUSHALLNOTPASS please?"</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Basic::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_wrong_scheme() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"THOUSHALLNOTPASS please?"</span>);
|
||||
<span class="kw">let </span>scheme = Basic::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(scheme.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_missing_credentials</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"Basic "</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Basic::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_missing_credentials() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"Basic "</span>);
|
||||
<span class="kw">let </span>scheme = Basic::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(scheme.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_missing_credentials_colon</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"Basic QWxsYWRpbg=="</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Basic::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_missing_credentials_colon() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"Basic QWxsYWRpbg=="</span>);
|
||||
<span class="kw">let </span>scheme = Basic::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(scheme.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_into_header_value</span>() {
|
||||
<span class="kw">let</span> <span class="ident">basic</span> <span class="op">=</span> <span class="ident">Basic</span> {
|
||||
<span class="ident">user_id</span>: <span class="string">"Aladdin"</span>.<span class="ident">into</span>(),
|
||||
<span class="ident">password</span>: <span class="prelude-val">Some</span>(<span class="string">"open sesame"</span>.<span class="ident">into</span>()),
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_into_header_value() {
|
||||
<span class="kw">let </span>basic = Basic {
|
||||
user_id: <span class="string">"Aladdin"</span>.into(),
|
||||
password: <span class="prelude-val">Some</span>(<span class="string">"open sesame"</span>.into()),
|
||||
};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">basic</span>.<span class="ident">try_into_value</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||||
<span class="kw">let </span>result = basic.try_into_value();
|
||||
<span class="macro">assert!</span>(result.is_ok());
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">result</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="ident">HeaderValue::from_static</span>(<span class="string">"Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="</span>)
|
||||
result.unwrap(),
|
||||
HeaderValue::from_static(<span class="string">"Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ=="</span>)
|
||||
);
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -136,143 +136,143 @@
|
||||
<span id="136">136</span>
|
||||
<span id="137">137</span>
|
||||
<span id="138">138</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">borrow::Cow</span>, <span class="ident">fmt</span>};
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::{borrow::Cow, fmt};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">http::header</span>::{<span class="ident">HeaderValue</span>, <span class="ident">InvalidHeaderValue</span>, <span class="ident">TryIntoHeaderValue</span>},
|
||||
<span class="ident">web</span>::{<span class="ident">BufMut</span>, <span class="ident">BytesMut</span>},
|
||||
<span class="kw">use </span>actix_web::{
|
||||
http::header::{HeaderValue, InvalidHeaderValue, TryIntoHeaderValue},
|
||||
web::{BufMut, BytesMut},
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::authorization</span>::{<span class="ident">errors::ParseError</span>, <span class="ident">scheme::Scheme</span>};
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::authorization::{errors::ParseError, scheme::Scheme};
|
||||
|
||||
<span class="doccomment">/// Credentials for `Bearer` authentication scheme, defined in [RFC 6750].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Should be used in combination with [`Authorization`](super::Authorization) header.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 6750]: https://tools.ietf.org/html/rfc6750</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Eq</span>, <span class="ident">Ord</span>, <span class="ident">PartialEq</span>, <span class="ident">PartialOrd</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Bearer</span> {
|
||||
<span class="ident">token</span>: <span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span>,
|
||||
<span class="doccomment">/// Credentials for `Bearer` authentication scheme, defined in [RFC 6750].
|
||||
///
|
||||
/// Should be used in combination with [`Authorization`](super::Authorization) header.
|
||||
///
|
||||
/// [RFC 6750]: https://tools.ietf.org/html/rfc6750
|
||||
</span><span class="attribute">#[derive(Clone, Eq, Ord, PartialEq, PartialOrd)]
|
||||
</span><span class="kw">pub struct </span>Bearer {
|
||||
token: Cow<<span class="lifetime">'static</span>, str>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Bearer</span> {
|
||||
<span class="doccomment">/// Creates new `Bearer` credentials with the token provided.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Example</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::headers::authorization::Bearer;</span>
|
||||
<span class="doccomment">/// let credentials = Bearer::new("mF_9.B5f-4.1JqM");</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">token</span>: <span class="ident">T</span>) -> <span class="ident">Bearer</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">impl </span>Bearer {
|
||||
<span class="doccomment">/// Creates new `Bearer` credentials with the token provided.
|
||||
///
|
||||
/// # Example
|
||||
/// ```
|
||||
/// # use actix_web_httpauth::headers::authorization::Bearer;
|
||||
/// let credentials = Bearer::new("mF_9.B5f-4.1JqM");
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>new<T>(token: T) -> Bearer
|
||||
<span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="ident">Bearer</span> {
|
||||
<span class="ident">token</span>: <span class="ident">token</span>.<span class="ident">into</span>(),
|
||||
Bearer {
|
||||
token: token.into(),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Gets reference to the credentials token.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">token</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="self">self</span>.<span class="ident">token</span>.<span class="ident">as_ref</span>()
|
||||
<span class="doccomment">/// Gets reference to the credentials token.
|
||||
</span><span class="kw">pub fn </span>token(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
||||
<span class="self">self</span>.token.as_ref()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Scheme</span> <span class="kw">for</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">header</span>: <span class="kw-2">&</span><span class="ident">HeaderValue</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ParseError</span><span class="op">></span> {
|
||||
<span class="comment">// "Bearer *" length</span>
|
||||
<span class="kw">if</span> <span class="ident">header</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="number">8</span> {
|
||||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">ParseError::Invalid</span>);
|
||||
<span class="kw">impl </span>Scheme <span class="kw">for </span>Bearer {
|
||||
<span class="kw">fn </span>parse(header: <span class="kw-2">&</span>HeaderValue) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, ParseError> {
|
||||
<span class="comment">// "Bearer *" length
|
||||
</span><span class="kw">if </span>header.len() < <span class="number">8 </span>{
|
||||
<span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::Invalid);
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">parts</span> <span class="op">=</span> <span class="ident">header</span>.<span class="ident">to_str</span>()<span class="question-mark">?</span>.<span class="ident">splitn</span>(<span class="number">2</span>, <span class="string">' '</span>);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>parts = header.to_str()<span class="question-mark">?</span>.splitn(<span class="number">2</span>, <span class="string">' '</span>);
|
||||
|
||||
<span class="kw">match</span> <span class="ident">parts</span>.<span class="ident">next</span>() {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">scheme</span>) <span class="kw">if</span> <span class="ident">scheme</span> <span class="op">==</span> <span class="string">"Bearer"</span> => {}
|
||||
<span class="kw">_</span> => <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">ParseError::MissingScheme</span>),
|
||||
<span class="kw">match </span>parts.next() {
|
||||
<span class="prelude-val">Some</span>(scheme) <span class="kw">if </span>scheme == <span class="string">"Bearer" </span>=> {}
|
||||
<span class="kw">_ </span>=> <span class="kw">return </span><span class="prelude-val">Err</span>(ParseError::MissingScheme),
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="ident">token</span> <span class="op">=</span> <span class="ident">parts</span>.<span class="ident">next</span>().<span class="ident">ok_or</span>(<span class="ident">ParseError::Invalid</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let </span>token = parts.next().ok_or(ParseError::Invalid)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">Bearer</span> {
|
||||
<span class="ident">token</span>: <span class="ident">token</span>.<span class="ident">to_string</span>().<span class="ident">into</span>(),
|
||||
<span class="prelude-val">Ok</span>(Bearer {
|
||||
token: token.to_string().into(),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Debug</span> <span class="kw">for</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="ident">f</span>.<span class="ident">write_fmt</span>(<span class="macro">format_args!</span>(<span class="string">"Bearer ******"</span>))
|
||||
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Bearer {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
f.write_fmt(<span class="macro">format_args!</span>(<span class="string">"Bearer ******"</span>))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="ident">f</span>.<span class="ident">write_fmt</span>(<span class="macro">format_args!</span>(<span class="string">"Bearer {}"</span>, <span class="self">self</span>.<span class="ident">token</span>))
|
||||
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Bearer {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
f.write_fmt(<span class="macro">format_args!</span>(<span class="string">"Bearer {}"</span>, <span class="self">self</span>.token))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">TryIntoHeaderValue</span> <span class="kw">for</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">InvalidHeaderValue</span>;
|
||||
<span class="kw">impl </span>TryIntoHeaderValue <span class="kw">for </span>Bearer {
|
||||
<span class="kw">type </span>Error = InvalidHeaderValue;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">try_into_value</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HeaderValue</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">BytesMut::with_capacity</span>(<span class="number">7</span> <span class="op">+</span> <span class="self">self</span>.<span class="ident">token</span>.<span class="ident">len</span>());
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b"Bearer "</span>[..]);
|
||||
<span class="ident">buffer</span>.<span class="ident">extend_from_slice</span>(<span class="self">self</span>.<span class="ident">token</span>.<span class="ident">as_bytes</span>());
|
||||
<span class="kw">fn </span>try_into_value(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><HeaderValue, <span class="self">Self</span>::Error> {
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>buffer = BytesMut::with_capacity(<span class="number">7 </span>+ <span class="self">self</span>.token.len());
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b"Bearer "</span>[..]);
|
||||
buffer.extend_from_slice(<span class="self">self</span>.token.as_bytes());
|
||||
|
||||
<span class="ident">HeaderValue::from_maybe_shared</span>(<span class="ident">buffer</span>.<span class="ident">freeze</span>())
|
||||
HeaderValue::from_maybe_shared(buffer.freeze())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
<span class="attribute">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_parse_header</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"Bearer mF_9.B5f-4.1JqM"</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Bearer::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_parse_header() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"Bearer mF_9.B5f-4.1JqM"</span>);
|
||||
<span class="kw">let </span>scheme = Bearer::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_ok</span>());
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">scheme</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">scheme</span>.<span class="ident">token</span>, <span class="string">"mF_9.B5f-4.1JqM"</span>);
|
||||
<span class="macro">assert!</span>(scheme.is_ok());
|
||||
<span class="kw">let </span>scheme = scheme.unwrap();
|
||||
<span class="macro">assert_eq!</span>(scheme.token, <span class="string">"mF_9.B5f-4.1JqM"</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_empty_header</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">""</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Bearer::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_empty_header() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">""</span>);
|
||||
<span class="kw">let </span>scheme = Bearer::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(scheme.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_wrong_scheme</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"OAuthToken foo"</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Bearer::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_wrong_scheme() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"OAuthToken foo"</span>);
|
||||
<span class="kw">let </span>scheme = Bearer::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(scheme.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_missing_token</span>() {
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">HeaderValue::from_static</span>(<span class="string">"Bearer "</span>);
|
||||
<span class="kw">let</span> <span class="ident">scheme</span> <span class="op">=</span> <span class="ident">Bearer::parse</span>(<span class="kw-2">&</span><span class="ident">value</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_missing_token() {
|
||||
<span class="kw">let </span>value = HeaderValue::from_static(<span class="string">"Bearer "</span>);
|
||||
<span class="kw">let </span>scheme = Bearer::parse(<span class="kw-2">&</span>value);
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">scheme</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(scheme.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_into_header_value</span>() {
|
||||
<span class="kw">let</span> <span class="ident">bearer</span> <span class="op">=</span> <span class="ident">Bearer::new</span>(<span class="string">"mF_9.B5f-4.1JqM"</span>);
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_into_header_value() {
|
||||
<span class="kw">let </span>bearer = Bearer::new(<span class="string">"mF_9.B5f-4.1JqM"</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">bearer</span>.<span class="ident">try_into_value</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">result</span>.<span class="ident">is_ok</span>());
|
||||
<span class="kw">let </span>result = bearer.try_into_value();
|
||||
<span class="macro">assert!</span>(result.is_ok());
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="ident">result</span>.<span class="ident">unwrap</span>(),
|
||||
<span class="ident">HeaderValue::from_static</span>(<span class="string">"Bearer mF_9.B5f-4.1JqM"</span>)
|
||||
result.unwrap(),
|
||||
HeaderValue::from_static(<span class="string">"Bearer mF_9.B5f-4.1JqM"</span>)
|
||||
);
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -12,19 +12,19 @@
|
||||
<span id="12">12</span>
|
||||
<span id="13">13</span>
|
||||
<span id="14">14</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::fmt</span>::{<span class="ident">Debug</span>, <span class="ident">Display</span>};
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt::{Debug, Display};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web::http::header</span>::{<span class="ident">HeaderValue</span>, <span class="ident">TryIntoHeaderValue</span>};
|
||||
<span class="kw">use </span>actix_web::http::header::{HeaderValue, TryIntoHeaderValue};
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">basic</span>;
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">bearer</span>;
|
||||
<span class="kw">pub mod </span>basic;
|
||||
<span class="kw">pub mod </span>bearer;
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::headers::authorization::errors::ParseError</span>;
|
||||
<span class="kw">use </span><span class="kw">crate</span>::headers::authorization::errors::ParseError;
|
||||
|
||||
<span class="doccomment">/// Authentication scheme for [`Authorization`](super::Authorization) header.</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Scheme</span>: <span class="ident">TryIntoHeaderValue</span> <span class="op">+</span> <span class="ident">Debug</span> <span class="op">+</span> <span class="ident">Display</span> <span class="op">+</span> <span class="ident">Clone</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> {
|
||||
<span class="doccomment">/// Try to parse an authentication scheme from the `Authorization` header.</span>
|
||||
<span class="kw">fn</span> <span class="ident">parse</span>(<span class="ident">header</span>: <span class="kw-2">&</span><span class="ident">HeaderValue</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ParseError</span><span class="op">></span>;
|
||||
<span class="doccomment">/// Authentication scheme for [`Authorization`](super::Authorization) header.
|
||||
</span><span class="kw">pub trait </span>Scheme: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
|
||||
<span class="doccomment">/// Try to parse an authentication scheme from the `Authorization` header.
|
||||
</span><span class="kw">fn </span>parse(header: <span class="kw-2">&</span>HeaderValue) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, ParseError>;
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -2,9 +2,9 @@
|
||||
<span id="2">2</span>
|
||||
<span id="3">3</span>
|
||||
<span id="4">4</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Typed HTTP headers.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Typed HTTP headers.
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">authorization</span>;
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">www_authenticate</span>;
|
||||
</span><span class="kw">pub mod </span>authorization;
|
||||
<span class="kw">pub mod </span>www_authenticate;
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -134,141 +134,141 @@
|
||||
<span id="134">134</span>
|
||||
<span id="135">135</span>
|
||||
<span id="136">136</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Challenge for the "Basic" HTTP Authentication Scheme.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Challenge for the "Basic" HTTP Authentication Scheme.
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">borrow::Cow</span>, <span class="ident">fmt</span>, <span class="ident">str</span>};
|
||||
</span><span class="kw">use </span>std::{borrow::Cow, fmt, str};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">http::header</span>::{<span class="ident">HeaderValue</span>, <span class="ident">InvalidHeaderValue</span>, <span class="ident">TryIntoHeaderValue</span>},
|
||||
<span class="ident">web</span>::{<span class="ident">BufMut</span>, <span class="ident">Bytes</span>, <span class="ident">BytesMut</span>},
|
||||
<span class="kw">use </span>actix_web::{
|
||||
http::header::{HeaderValue, InvalidHeaderValue, TryIntoHeaderValue},
|
||||
web::{BufMut, Bytes, BytesMut},
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::Challenge</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::utils</span>;
|
||||
<span class="kw">use </span><span class="kw">super</span>::Challenge;
|
||||
<span class="kw">use </span><span class="kw">crate</span>::utils;
|
||||
|
||||
<span class="doccomment">/// Challenge for [`WWW-Authenticate`] header with HTTP Basic auth scheme,</span>
|
||||
<span class="doccomment">/// described in [RFC 7617](https://tools.ietf.org/html/rfc7617)</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web::{web, App, HttpRequest, HttpResponse, HttpServer};</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::headers::www_authenticate::basic::Basic;</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::headers::www_authenticate::WwwAuthenticate;</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// fn index(_req: HttpRequest) -> HttpResponse {</span>
|
||||
<span class="doccomment">/// let challenge = Basic::with_realm("Restricted area");</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// HttpResponse::Unauthorized()</span>
|
||||
<span class="doccomment">/// .insert_header(WwwAuthenticate(challenge))</span>
|
||||
<span class="doccomment">/// .finish()</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [`WWW-Authenticate`]: ../struct.WwwAuthenticate.html</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Eq</span>, <span class="ident">PartialEq</span>, <span class="ident">Ord</span>, <span class="ident">PartialOrd</span>, <span class="ident">Hash</span>, <span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Basic</span> {
|
||||
<span class="comment">// "realm" parameter is optional now: https://tools.ietf.org/html/rfc7235#appendix-A</span>
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">realm</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Challenge for [`WWW-Authenticate`] header with HTTP Basic auth scheme,
|
||||
/// described in [RFC 7617](https://tools.ietf.org/html/rfc7617)
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web::{web, App, HttpRequest, HttpResponse, HttpServer};
|
||||
/// use actix_web_httpauth::headers::www_authenticate::basic::Basic;
|
||||
/// use actix_web_httpauth::headers::www_authenticate::WwwAuthenticate;
|
||||
///
|
||||
/// fn index(_req: HttpRequest) -> HttpResponse {
|
||||
/// let challenge = Basic::with_realm("Restricted area");
|
||||
///
|
||||
/// HttpResponse::Unauthorized()
|
||||
/// .insert_header(WwwAuthenticate(challenge))
|
||||
/// .finish()
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// [`WWW-Authenticate`]: ../struct.WwwAuthenticate.html
|
||||
</span><span class="attribute">#[derive(Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default, Clone)]
|
||||
</span><span class="kw">pub struct </span>Basic {
|
||||
<span class="comment">// "realm" parameter is optional now: https://tools.ietf.org/html/rfc7235#appendix-A
|
||||
</span><span class="kw">pub</span>(<span class="kw">crate</span>) realm: <span class="prelude-ty">Option</span><Cow<<span class="lifetime">'static</span>, str>>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Basic</span> {
|
||||
<span class="doccomment">/// Creates new `Basic` challenge with an empty `realm` field.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::headers::www_authenticate::basic::Basic;</span>
|
||||
<span class="doccomment">/// let challenge = Basic::new();</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="ident">Basic</span> {
|
||||
<span class="ident">Default::default</span>()
|
||||
<span class="kw">impl </span>Basic {
|
||||
<span class="doccomment">/// Creates new `Basic` challenge with an empty `realm` field.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web_httpauth::headers::www_authenticate::basic::Basic;
|
||||
/// let challenge = Basic::new();
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>new() -> Basic {
|
||||
Default::default()
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Creates new `Basic` challenge from the provided `realm` field value.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::headers::www_authenticate::basic::Basic;</span>
|
||||
<span class="doccomment">/// let challenge = Basic::with_realm("Restricted area");</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::headers::www_authenticate::basic::Basic;</span>
|
||||
<span class="doccomment">/// let my_realm = "Earth realm".to_string();</span>
|
||||
<span class="doccomment">/// let challenge = Basic::with_realm(my_realm);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_realm</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="ident">value</span>: <span class="ident">T</span>) -> <span class="ident">Basic</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Creates new `Basic` challenge from the provided `realm` field value.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// # use actix_web_httpauth::headers::www_authenticate::basic::Basic;
|
||||
/// let challenge = Basic::with_realm("Restricted area");
|
||||
/// ```
|
||||
///
|
||||
/// ```
|
||||
/// # use actix_web_httpauth::headers::www_authenticate::basic::Basic;
|
||||
/// let my_realm = "Earth realm".to_string();
|
||||
/// let challenge = Basic::with_realm(my_realm);
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>with_realm<T>(value: T) -> Basic
|
||||
<span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="ident">Basic</span> {
|
||||
<span class="ident">realm</span>: <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>()),
|
||||
Basic {
|
||||
realm: <span class="prelude-val">Some</span>(value.into()),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">Challenge</span> <span class="kw">for</span> <span class="ident">Basic</span> {
|
||||
<span class="kw">fn</span> <span class="ident">to_bytes</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">Bytes</span> {
|
||||
<span class="comment">// 5 is for `"Basic"`, 9 is for `"realm=\"\""`</span>
|
||||
<span class="kw">let</span> <span class="ident">length</span> <span class="op">=</span> <span class="number">5</span> <span class="op">+</span> <span class="self">self</span>.<span class="ident">realm</span>.<span class="ident">as_ref</span>().<span class="ident">map_or</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">realm</span><span class="op">|</span> <span class="ident">realm</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="number">9</span>);
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">BytesMut::with_capacity</span>(<span class="ident">length</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b"Basic"</span>[..]);
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">realm</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">realm</span> {
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b" realm=\""</span>[..]);
|
||||
<span class="ident">utils::put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">buffer</span>, <span class="ident">realm</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put_u8</span>(<span class="string">b'"'</span>);
|
||||
<span class="attribute">#[doc(hidden)]
|
||||
</span><span class="kw">impl </span>Challenge <span class="kw">for </span>Basic {
|
||||
<span class="kw">fn </span>to_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> Bytes {
|
||||
<span class="comment">// 5 is for `"Basic"`, 9 is for `"realm=\"\""`
|
||||
</span><span class="kw">let </span>length = <span class="number">5 </span>+ <span class="self">self</span>.realm.as_ref().map_or(<span class="number">0</span>, |realm| realm.len() + <span class="number">9</span>);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>buffer = BytesMut::with_capacity(length);
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b"Basic"</span>[..]);
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>realm) = <span class="self">self</span>.realm {
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b" realm=\""</span>[..]);
|
||||
utils::put_quoted(<span class="kw-2">&mut </span>buffer, realm);
|
||||
buffer.put_u8(<span class="string">b'"'</span>);
|
||||
}
|
||||
|
||||
<span class="ident">buffer</span>.<span class="ident">freeze</span>()
|
||||
buffer.freeze()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Basic</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">fmt::Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">to_bytes</span>();
|
||||
<span class="kw">let</span> <span class="ident">repr</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">bytes</span>)
|
||||
<span class="comment">// Should not happen since challenges are crafted manually</span>
|
||||
<span class="comment">// from a `&'static str` or `String`</span>
|
||||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">fmt::Error</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Basic {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><(), fmt::Error> {
|
||||
<span class="kw">let </span>bytes = <span class="self">self</span>.to_bytes();
|
||||
<span class="kw">let </span>repr = str::from_utf8(<span class="kw-2">&</span>bytes)
|
||||
<span class="comment">// Should not happen since challenges are crafted manually
|
||||
// from a `&'static str` or `String`
|
||||
</span>.map_err(|<span class="kw">_</span>| fmt::Error)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="ident">f</span>.<span class="ident">write_str</span>(<span class="ident">repr</span>)
|
||||
f.write_str(repr)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">TryIntoHeaderValue</span> <span class="kw">for</span> <span class="ident">Basic</span> {
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">InvalidHeaderValue</span>;
|
||||
<span class="kw">impl </span>TryIntoHeaderValue <span class="kw">for </span>Basic {
|
||||
<span class="kw">type </span>Error = InvalidHeaderValue;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">try_into_value</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HeaderValue</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> {
|
||||
<span class="ident">HeaderValue::from_maybe_shared</span>(<span class="self">self</span>.<span class="ident">to_bytes</span>())
|
||||
<span class="kw">fn </span>try_into_value(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><HeaderValue, <span class="self">Self</span>::Error> {
|
||||
HeaderValue::from_maybe_shared(<span class="self">self</span>.to_bytes())
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
<span class="attribute">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_plain_into_header_value</span>() {
|
||||
<span class="kw">let</span> <span class="ident">challenge</span> <span class="op">=</span> <span class="ident">Basic</span> { <span class="ident">realm</span>: <span class="prelude-val">None</span> };
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_plain_into_header_value() {
|
||||
<span class="kw">let </span>challenge = Basic { realm: <span class="prelude-val">None </span>};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">challenge</span>.<span class="ident">try_into_value</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">value</span>.<span class="ident">is_ok</span>());
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">value</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value</span>, <span class="string">"Basic"</span>);
|
||||
<span class="kw">let </span>value = challenge.try_into_value();
|
||||
<span class="macro">assert!</span>(value.is_ok());
|
||||
<span class="kw">let </span>value = value.unwrap();
|
||||
<span class="macro">assert_eq!</span>(value, <span class="string">"Basic"</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_with_realm_into_header_value</span>() {
|
||||
<span class="kw">let</span> <span class="ident">challenge</span> <span class="op">=</span> <span class="ident">Basic</span> {
|
||||
<span class="ident">realm</span>: <span class="prelude-val">Some</span>(<span class="string">"Restricted area"</span>.<span class="ident">into</span>()),
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_with_realm_into_header_value() {
|
||||
<span class="kw">let </span>challenge = Basic {
|
||||
realm: <span class="prelude-val">Some</span>(<span class="string">"Restricted area"</span>.into()),
|
||||
};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">challenge</span>.<span class="ident">try_into_value</span>();
|
||||
<span class="macro">assert!</span>(<span class="ident">value</span>.<span class="ident">is_ok</span>());
|
||||
<span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="ident">value</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">value</span>, <span class="string">"Basic realm=\"Restricted area\""</span>);
|
||||
<span class="kw">let </span>value = challenge.try_into_value();
|
||||
<span class="macro">assert!</span>(value.is_ok());
|
||||
<span class="kw">let </span>value = value.unwrap();
|
||||
<span class="macro">assert_eq!</span>(value, <span class="string">"Basic realm=\"Restricted area\""</span>);
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -69,76 +69,76 @@
|
||||
<span id="69">69</span>
|
||||
<span id="70">70</span>
|
||||
<span id="71">71</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::borrow::Cow</span>;
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::borrow::Cow;
|
||||
|
||||
<span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">Bearer</span>, <span class="ident">Error</span>};
|
||||
<span class="kw">use super</span>::{Bearer, Error};
|
||||
|
||||
<span class="doccomment">/// Builder for the [`Bearer`] challenge.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// It is up to implementor to fill all required fields, neither this `Builder` nor [`Bearer`]</span>
|
||||
<span class="doccomment">/// provide any validation.</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">BearerBuilder</span>(<span class="ident">Bearer</span>);
|
||||
<span class="doccomment">/// Builder for the [`Bearer`] challenge.
|
||||
///
|
||||
/// It is up to implementor to fill all required fields, neither this `Builder` nor [`Bearer`]
|
||||
/// provide any validation.
|
||||
</span><span class="attribute">#[derive(Debug, Default)]
|
||||
</span><span class="kw">pub struct </span>BearerBuilder(Bearer);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">BearerBuilder</span> {
|
||||
<span class="doccomment">/// Provides the `scope` attribute, as defined in [RFC 6749 §3.3].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 6749 §3.3]: https://tools.ietf.org/html/rfc6749#section-3.3</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">scope</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">T</span>) -> <span class="self">Self</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">impl </span>BearerBuilder {
|
||||
<span class="doccomment">/// Provides the `scope` attribute, as defined in [RFC 6749 §3.3].
|
||||
///
|
||||
/// [RFC 6749 §3.3]: https://tools.ietf.org/html/rfc6749#section-3.3
|
||||
</span><span class="kw">pub fn </span>scope<T>(<span class="kw-2">mut </span><span class="self">self</span>, value: T) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">scope</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="self">self</span>.<span class="number">0</span>.scope = <span class="prelude-val">Some</span>(value.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Provides the `realm` attribute, as defined in [RFC 2617].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 2617]: https://tools.ietf.org/html/rfc2617</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">realm</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">T</span>) -> <span class="self">Self</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Provides the `realm` attribute, as defined in [RFC 2617].
|
||||
///
|
||||
/// [RFC 2617]: https://tools.ietf.org/html/rfc2617
|
||||
</span><span class="kw">pub fn </span>realm<T>(<span class="kw-2">mut </span><span class="self">self</span>, value: T) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">realm</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="self">self</span>.<span class="number">0</span>.realm = <span class="prelude-val">Some</span>(value.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Provides the `error` attribute, as defined in [RFC 6750, Section 3.1].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 6750 §3.1]: https://tools.ietf.org/html/rfc6750#section-3.1</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">error</span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">Error</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">error</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>);
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="doccomment">/// Provides the `error` attribute, as defined in [RFC 6750, Section 3.1].
|
||||
///
|
||||
/// [RFC 6750 §3.1]: https://tools.ietf.org/html/rfc6750#section-3.1
|
||||
</span><span class="kw">pub fn </span>error(<span class="kw-2">mut </span><span class="self">self</span>, value: Error) -> <span class="self">Self </span>{
|
||||
<span class="self">self</span>.<span class="number">0</span>.error = <span class="prelude-val">Some</span>(value);
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Provides the `error_description` attribute, as defined in [RFC 6750, Section 3].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 6750 §3]: https://tools.ietf.org/html/rfc6750#section-3</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">error_description</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">T</span>) -> <span class="self">Self</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Provides the `error_description` attribute, as defined in [RFC 6750, Section 3].
|
||||
///
|
||||
/// [RFC 6750 §3]: https://tools.ietf.org/html/rfc6750#section-3
|
||||
</span><span class="kw">pub fn </span>error_description<T>(<span class="kw-2">mut </span><span class="self">self</span>, value: T) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">error_description</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="self">self</span>.<span class="number">0</span>.error_description = <span class="prelude-val">Some</span>(value.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Provides the `error_uri` attribute, as defined in [RFC 6750 §3].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// It is up to implementor to provide properly-formed absolute URI.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 6750 §3](https://tools.ietf.org/html/rfc6750#section-3)</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">error_uri</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>(<span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">value</span>: <span class="ident">T</span>) -> <span class="self">Self</span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">Into</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Provides the `error_uri` attribute, as defined in [RFC 6750 §3].
|
||||
///
|
||||
/// It is up to implementor to provide properly-formed absolute URI.
|
||||
///
|
||||
/// [RFC 6750 §3](https://tools.ietf.org/html/rfc6750#section-3)
|
||||
</span><span class="kw">pub fn </span>error_uri<T>(<span class="kw-2">mut </span><span class="self">self</span>, value: T) -> <span class="self">Self
|
||||
</span><span class="kw">where
|
||||
</span>T: Into<Cow<<span class="lifetime">'static</span>, str>>,
|
||||
{
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">error_uri</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>.<span class="ident">into</span>());
|
||||
<span class="self">self</span>
|
||||
}
|
||||
<span class="self">self</span>.<span class="number">0</span>.error_uri = <span class="prelude-val">Some</span>(value.into());
|
||||
<span class="self">self
|
||||
</span>}
|
||||
|
||||
<span class="doccomment">/// Consumes the builder and returns built `Bearer` instance.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">finish</span>(<span class="self">self</span>) -> <span class="ident">Bearer</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
<span class="doccomment">/// Consumes the builder and returns built `Bearer` instance.
|
||||
</span><span class="kw">pub fn </span>finish(<span class="self">self</span>) -> Bearer {
|
||||
<span class="self">self</span>.<span class="number">0
|
||||
</span>}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -140,147 +140,147 @@
|
||||
<span id="140">140</span>
|
||||
<span id="141">141</span>
|
||||
<span id="142">142</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">borrow::Cow</span>, <span class="ident">fmt</span>, <span class="ident">str</span>};
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::{borrow::Cow, fmt, str};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">http::header</span>::{<span class="ident">HeaderValue</span>, <span class="ident">InvalidHeaderValue</span>, <span class="ident">TryIntoHeaderValue</span>},
|
||||
<span class="ident">web</span>::{<span class="ident">BufMut</span>, <span class="ident">Bytes</span>, <span class="ident">BytesMut</span>},
|
||||
<span class="kw">use </span>actix_web::{
|
||||
http::header::{HeaderValue, InvalidHeaderValue, TryIntoHeaderValue},
|
||||
web::{BufMut, Bytes, BytesMut},
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::<span class="kw">super</span>::Challenge</span>;
|
||||
<span class="kw">use</span> <span class="kw">super</span>::{<span class="ident">BearerBuilder</span>, <span class="ident">Error</span>};
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::utils</span>;
|
||||
<span class="kw">use </span><span class="kw">super</span>::<span class="kw">super</span>::Challenge;
|
||||
<span class="kw">use super</span>::{BearerBuilder, Error};
|
||||
<span class="kw">use </span><span class="kw">crate</span>::utils;
|
||||
|
||||
<span class="doccomment">/// Challenge for [`WWW-Authenticate`] header with HTTP Bearer auth scheme, described in [RFC 6750].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web::{web, App, HttpRequest, HttpResponse, HttpServer};</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::headers::www_authenticate::bearer::{</span>
|
||||
<span class="doccomment">/// Bearer, Error,</span>
|
||||
<span class="doccomment">/// };</span>
|
||||
<span class="doccomment">/// use actix_web_httpauth::headers::www_authenticate::WwwAuthenticate;</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// fn index(_req: HttpRequest) -> HttpResponse {</span>
|
||||
<span class="doccomment">/// let challenge = Bearer::build()</span>
|
||||
<span class="doccomment">/// .realm("example")</span>
|
||||
<span class="doccomment">/// .scope("openid profile email")</span>
|
||||
<span class="doccomment">/// .error(Error::InvalidToken)</span>
|
||||
<span class="doccomment">/// .error_description("The access token expired")</span>
|
||||
<span class="doccomment">/// .error_uri("http://example.org")</span>
|
||||
<span class="doccomment">/// .finish();</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// HttpResponse::Unauthorized()</span>
|
||||
<span class="doccomment">/// .insert_header(WwwAuthenticate(challenge))</span>
|
||||
<span class="doccomment">/// .finish()</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [`WWW-Authenticate`]: crate::headers::www_authenticate::WwwAuthenticate</span>
|
||||
<span class="doccomment">/// [RFC 6750]: https://tools.ietf.org/html/rfc6750#section-3</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">scope</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">realm</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">error</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">error_description</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">error_uri</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Cow</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="ident">str</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="doccomment">/// Challenge for [`WWW-Authenticate`] header with HTTP Bearer auth scheme, described in [RFC 6750].
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web::{web, App, HttpRequest, HttpResponse, HttpServer};
|
||||
/// use actix_web_httpauth::headers::www_authenticate::bearer::{
|
||||
/// Bearer, Error,
|
||||
/// };
|
||||
/// use actix_web_httpauth::headers::www_authenticate::WwwAuthenticate;
|
||||
///
|
||||
/// fn index(_req: HttpRequest) -> HttpResponse {
|
||||
/// let challenge = Bearer::build()
|
||||
/// .realm("example")
|
||||
/// .scope("openid profile email")
|
||||
/// .error(Error::InvalidToken)
|
||||
/// .error_description("The access token expired")
|
||||
/// .error_uri("http://example.org")
|
||||
/// .finish();
|
||||
///
|
||||
/// HttpResponse::Unauthorized()
|
||||
/// .insert_header(WwwAuthenticate(challenge))
|
||||
/// .finish()
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// [`WWW-Authenticate`]: crate::headers::www_authenticate::WwwAuthenticate
|
||||
/// [RFC 6750]: https://tools.ietf.org/html/rfc6750#section-3
|
||||
</span><span class="attribute">#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||
</span><span class="kw">pub struct </span>Bearer {
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) scope: <span class="prelude-ty">Option</span><Cow<<span class="lifetime">'static</span>, str>>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) realm: <span class="prelude-ty">Option</span><Cow<<span class="lifetime">'static</span>, str>>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) error: <span class="prelude-ty">Option</span><Error>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) error_description: <span class="prelude-ty">Option</span><Cow<<span class="lifetime">'static</span>, str>>,
|
||||
<span class="kw">pub</span>(<span class="kw">crate</span>) error_uri: <span class="prelude-ty">Option</span><Cow<<span class="lifetime">'static</span>, str>>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Bearer</span> {
|
||||
<span class="doccomment">/// Creates the builder for `Bearer` challenge.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::headers::www_authenticate::bearer::{Bearer};</span>
|
||||
<span class="doccomment">/// let challenge = Bearer::build()</span>
|
||||
<span class="doccomment">/// .realm("Restricted area")</span>
|
||||
<span class="doccomment">/// .scope("openid profile email")</span>
|
||||
<span class="doccomment">/// .finish();</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">build</span>() -> <span class="ident">BearerBuilder</span> {
|
||||
<span class="ident">BearerBuilder::default</span>()
|
||||
<span class="kw">impl </span>Bearer {
|
||||
<span class="doccomment">/// Creates the builder for `Bearer` challenge.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web_httpauth::headers::www_authenticate::bearer::{Bearer};
|
||||
/// let challenge = Bearer::build()
|
||||
/// .realm("Restricted area")
|
||||
/// .scope("openid profile email")
|
||||
/// .finish();
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>build() -> BearerBuilder {
|
||||
BearerBuilder::default()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||||
<span class="kw">impl</span> <span class="ident">Challenge</span> <span class="kw">for</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">fn</span> <span class="ident">to_bytes</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">Bytes</span> {
|
||||
<span class="kw">let</span> <span class="ident">desc_uri_required</span> <span class="op">=</span> <span class="self">self</span>
|
||||
.<span class="ident">error_description</span>
|
||||
.<span class="ident">as_ref</span>()
|
||||
.<span class="ident">map_or</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">desc</span><span class="op">|</span> <span class="ident">desc</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="number">20</span>)
|
||||
<span class="op">+</span> <span class="self">self</span>.<span class="ident">error_uri</span>.<span class="ident">as_ref</span>().<span class="ident">map_or</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">url</span><span class="op">|</span> <span class="ident">url</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="number">12</span>);
|
||||
<span class="attribute">#[doc(hidden)]
|
||||
</span><span class="kw">impl </span>Challenge <span class="kw">for </span>Bearer {
|
||||
<span class="kw">fn </span>to_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> Bytes {
|
||||
<span class="kw">let </span>desc_uri_required = <span class="self">self
|
||||
</span>.error_description
|
||||
.as_ref()
|
||||
.map_or(<span class="number">0</span>, |desc| desc.len() + <span class="number">20</span>)
|
||||
+ <span class="self">self</span>.error_uri.as_ref().map_or(<span class="number">0</span>, |url| url.len() + <span class="number">12</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">capacity</span> <span class="op">=</span> <span class="number">6</span>
|
||||
<span class="op">+</span> <span class="self">self</span>.<span class="ident">realm</span>.<span class="ident">as_ref</span>().<span class="ident">map_or</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">realm</span><span class="op">|</span> <span class="ident">realm</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="number">9</span>)
|
||||
<span class="op">+</span> <span class="self">self</span>.<span class="ident">scope</span>.<span class="ident">as_ref</span>().<span class="ident">map_or</span>(<span class="number">0</span>, <span class="op">|</span><span class="ident">scope</span><span class="op">|</span> <span class="ident">scope</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="number">9</span>)
|
||||
<span class="op">+</span> <span class="ident">desc_uri_required</span>;
|
||||
<span class="kw">let </span>capacity = <span class="number">6
|
||||
</span>+ <span class="self">self</span>.realm.as_ref().map_or(<span class="number">0</span>, |realm| realm.len() + <span class="number">9</span>)
|
||||
+ <span class="self">self</span>.scope.as_ref().map_or(<span class="number">0</span>, |scope| scope.len() + <span class="number">9</span>)
|
||||
+ desc_uri_required;
|
||||
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buffer</span> <span class="op">=</span> <span class="ident">BytesMut::with_capacity</span>(<span class="ident">capacity</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b"Bearer"</span>[..]);
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>buffer = BytesMut::with_capacity(capacity);
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b"Bearer"</span>[..]);
|
||||
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">realm</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">realm</span> {
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b" realm=\""</span>[..]);
|
||||
<span class="ident">utils::put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">buffer</span>, <span class="ident">realm</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put_u8</span>(<span class="string">b'"'</span>);
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>realm) = <span class="self">self</span>.realm {
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b" realm=\""</span>[..]);
|
||||
utils::put_quoted(<span class="kw-2">&mut </span>buffer, realm);
|
||||
buffer.put_u8(<span class="string">b'"'</span>);
|
||||
}
|
||||
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">scope</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">scope</span> {
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b" scope=\""</span>[..]);
|
||||
<span class="ident">utils::put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">buffer</span>, <span class="ident">scope</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put_u8</span>(<span class="string">b'"'</span>);
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>scope) = <span class="self">self</span>.scope {
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b" scope=\""</span>[..]);
|
||||
utils::put_quoted(<span class="kw-2">&mut </span>buffer, scope);
|
||||
buffer.put_u8(<span class="string">b'"'</span>);
|
||||
}
|
||||
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">error</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">error</span> {
|
||||
<span class="kw">let</span> <span class="ident">error_repr</span> <span class="op">=</span> <span class="ident">error</span>.<span class="ident">as_str</span>();
|
||||
<span class="kw">let</span> <span class="ident">remaining</span> <span class="op">=</span> <span class="ident">buffer</span>.<span class="ident">remaining_mut</span>();
|
||||
<span class="kw">let</span> <span class="ident">required</span> <span class="op">=</span> <span class="ident">desc_uri_required</span> <span class="op">+</span> <span class="ident">error_repr</span>.<span class="ident">len</span>() <span class="op">+</span> <span class="number">9</span>; <span class="comment">// 9 is for `" error=\"\""`</span>
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>error) = <span class="self">self</span>.error {
|
||||
<span class="kw">let </span>error_repr = error.as_str();
|
||||
<span class="kw">let </span>remaining = buffer.remaining_mut();
|
||||
<span class="kw">let </span>required = desc_uri_required + error_repr.len() + <span class="number">9</span>; <span class="comment">// 9 is for `" error=\"\""`
|
||||
|
||||
<span class="kw">if</span> <span class="ident">remaining</span> <span class="op"><</span> <span class="ident">required</span> {
|
||||
<span class="ident">buffer</span>.<span class="ident">reserve</span>(<span class="ident">required</span>);
|
||||
</span><span class="kw">if </span>remaining < required {
|
||||
buffer.reserve(required);
|
||||
}
|
||||
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b" error=\""</span>[..]);
|
||||
<span class="ident">utils::put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">buffer</span>, <span class="ident">error_repr</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put_u8</span>(<span class="string">b'"'</span>)
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b" error=\""</span>[..]);
|
||||
utils::put_quoted(<span class="kw-2">&mut </span>buffer, error_repr);
|
||||
buffer.put_u8(<span class="string">b'"'</span>)
|
||||
}
|
||||
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">error_description</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">error_description</span> {
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b" error_description=\""</span>[..]);
|
||||
<span class="ident">utils::put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">buffer</span>, <span class="ident">error_description</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put_u8</span>(<span class="string">b'"'</span>);
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>error_description) = <span class="self">self</span>.error_description {
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b" error_description=\""</span>[..]);
|
||||
utils::put_quoted(<span class="kw-2">&mut </span>buffer, error_description);
|
||||
buffer.put_u8(<span class="string">b'"'</span>);
|
||||
}
|
||||
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="kw-2">ref</span> <span class="ident">error_uri</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">error_uri</span> {
|
||||
<span class="ident">buffer</span>.<span class="ident">put</span>(<span class="kw-2">&</span><span class="string">b" error_uri=\""</span>[..]);
|
||||
<span class="ident">utils::put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">buffer</span>, <span class="ident">error_uri</span>);
|
||||
<span class="ident">buffer</span>.<span class="ident">put_u8</span>(<span class="string">b'"'</span>);
|
||||
<span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>error_uri) = <span class="self">self</span>.error_uri {
|
||||
buffer.put(<span class="kw-2">&</span><span class="string">b" error_uri=\""</span>[..]);
|
||||
utils::put_quoted(<span class="kw-2">&mut </span>buffer, error_uri);
|
||||
buffer.put_u8(<span class="string">b'"'</span>);
|
||||
}
|
||||
|
||||
<span class="ident">buffer</span>.<span class="ident">freeze</span>()
|
||||
buffer.freeze()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">fmt::Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">bytes</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">to_bytes</span>();
|
||||
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Bearer {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> <span class="prelude-ty">Result</span><(), fmt::Error> {
|
||||
<span class="kw">let </span>bytes = <span class="self">self</span>.to_bytes();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">repr</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">bytes</span>)
|
||||
<span class="comment">// Should not happen since challenges are crafted manually</span>
|
||||
<span class="comment">// from `&'static str`'s and Strings</span>
|
||||
.<span class="ident">map_err</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> <span class="ident">fmt::Error</span>)<span class="question-mark">?</span>;
|
||||
<span class="kw">let </span>repr = str::from_utf8(<span class="kw-2">&</span>bytes)
|
||||
<span class="comment">// Should not happen since challenges are crafted manually
|
||||
// from `&'static str`'s and Strings
|
||||
</span>.map_err(|<span class="kw">_</span>| fmt::Error)<span class="question-mark">?</span>;
|
||||
|
||||
<span class="ident">f</span>.<span class="ident">write_str</span>(<span class="ident">repr</span>)
|
||||
f.write_str(repr)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">TryIntoHeaderValue</span> <span class="kw">for</span> <span class="ident">Bearer</span> {
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">InvalidHeaderValue</span>;
|
||||
<span class="kw">impl </span>TryIntoHeaderValue <span class="kw">for </span>Bearer {
|
||||
<span class="kw">type </span>Error = InvalidHeaderValue;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">try_into_value</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HeaderValue</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> {
|
||||
<span class="ident">HeaderValue::from_maybe_shared</span>(<span class="self">self</span>.<span class="ident">to_bytes</span>())
|
||||
<span class="kw">fn </span>try_into_value(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><HeaderValue, <span class="self">Self</span>::Error> {
|
||||
HeaderValue::from_maybe_shared(<span class="self">self</span>.to_bytes())
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -48,55 +48,55 @@
|
||||
<span id="48">48</span>
|
||||
<span id="49">49</span>
|
||||
<span id="50">50</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::fmt</span>;
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web::http::StatusCode</span>;
|
||||
<span class="kw">use </span>actix_web::http::StatusCode;
|
||||
|
||||
<span class="doccomment">/// Bearer authorization error types, described in [RFC 6750].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 6750]: https://tools.ietf.org/html/rfc6750#section-3.1</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>, <span class="ident">Copy</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">Error</span> {
|
||||
<span class="doccomment">/// The request is missing a required parameter, includes an unsupported parameter or parameter</span>
|
||||
<span class="doccomment">/// value, repeats the same parameter, uses more than one method for including an access token,</span>
|
||||
<span class="doccomment">/// or is otherwise malformed.</span>
|
||||
<span class="ident">InvalidRequest</span>,
|
||||
<span class="doccomment">/// Bearer authorization error types, described in [RFC 6750].
|
||||
///
|
||||
/// [RFC 6750]: https://tools.ietf.org/html/rfc6750#section-3.1
|
||||
</span><span class="attribute">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||
</span><span class="kw">pub enum </span>Error {
|
||||
<span class="doccomment">/// The request is missing a required parameter, includes an unsupported parameter or parameter
|
||||
/// value, repeats the same parameter, uses more than one method for including an access token,
|
||||
/// or is otherwise malformed.
|
||||
</span>InvalidRequest,
|
||||
|
||||
<span class="doccomment">/// The access token provided is expired, revoked, malformed, or invalid for other reasons.</span>
|
||||
<span class="ident">InvalidToken</span>,
|
||||
<span class="doccomment">/// The access token provided is expired, revoked, malformed, or invalid for other reasons.
|
||||
</span>InvalidToken,
|
||||
|
||||
<span class="doccomment">/// The request requires higher privileges than provided by the access token.</span>
|
||||
<span class="ident">InsufficientScope</span>,
|
||||
<span class="doccomment">/// The request requires higher privileges than provided by the access token.
|
||||
</span>InsufficientScope,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Error</span> {
|
||||
<span class="doccomment">/// Returns [HTTP status code] suitable for current error type.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [HTTP status code]: `actix_web::http::StatusCode`</span>
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">clippy::trivially_copy_pass_by_ref</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">status_code</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">StatusCode</span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident">Error::InvalidRequest</span> => <span class="ident">StatusCode::BAD_REQUEST</span>,
|
||||
<span class="ident">Error::InvalidToken</span> => <span class="ident">StatusCode::UNAUTHORIZED</span>,
|
||||
<span class="ident">Error::InsufficientScope</span> => <span class="ident">StatusCode::FORBIDDEN</span>,
|
||||
<span class="kw">impl </span>Error {
|
||||
<span class="doccomment">/// Returns [HTTP status code] suitable for current error type.
|
||||
///
|
||||
/// [HTTP status code]: `actix_web::http::StatusCode`
|
||||
</span><span class="attribute">#[allow(clippy::trivially_copy_pass_by_ref)]
|
||||
</span><span class="kw">pub fn </span>status_code(<span class="kw-2">&</span><span class="self">self</span>) -> StatusCode {
|
||||
<span class="kw">match </span><span class="self">self </span>{
|
||||
Error::InvalidRequest => StatusCode::BAD_REQUEST,
|
||||
Error::InvalidToken => StatusCode::UNAUTHORIZED,
|
||||
Error::InsufficientScope => StatusCode::FORBIDDEN,
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">clippy::trivially_copy_pass_by_ref</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_str</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="ident">str</span> {
|
||||
<span class="kw">match</span> <span class="self">self</span> {
|
||||
<span class="ident">Error::InvalidRequest</span> => <span class="string">"invalid_request"</span>,
|
||||
<span class="ident">Error::InvalidToken</span> => <span class="string">"invalid_token"</span>,
|
||||
<span class="ident">Error::InsufficientScope</span> => <span class="string">"insufficient_scope"</span>,
|
||||
<span class="attribute">#[doc(hidden)]
|
||||
#[allow(clippy::trivially_copy_pass_by_ref)]
|
||||
</span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
||||
<span class="kw">match </span><span class="self">self </span>{
|
||||
Error::InvalidRequest => <span class="string">"invalid_request"</span>,
|
||||
Error::InvalidToken => <span class="string">"invalid_token"</span>,
|
||||
Error::InsufficientScope => <span class="string">"insufficient_scope"</span>,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Error</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="ident">f</span>.<span class="ident">write_str</span>(<span class="self">self</span>.<span class="ident">as_str</span>())
|
||||
<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Error {
|
||||
<span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result {
|
||||
f.write_str(<span class="self">self</span>.as_str())
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -25,32 +25,32 @@
|
||||
<span id="25">25</span>
|
||||
<span id="26">26</span>
|
||||
<span id="27">27</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Challenge for the "Bearer" HTTP Authentication Scheme.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! Challenge for the "Bearer" HTTP Authentication Scheme.
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">builder</span>;
|
||||
<span class="kw">mod</span> <span class="ident">challenge</span>;
|
||||
<span class="kw">mod</span> <span class="ident">errors</span>;
|
||||
</span><span class="kw">mod </span>builder;
|
||||
<span class="kw">mod </span>challenge;
|
||||
<span class="kw">mod </span>errors;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::builder::BearerBuilder</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::challenge::Bearer</span>;
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::errors::Error</span>;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::builder::BearerBuilder;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::challenge::Bearer;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::errors::Error;
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
<span class="attribute">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">to_bytes</span>() {
|
||||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="ident">Bearer::build</span>()
|
||||
.<span class="ident">error</span>(<span class="ident">Error::InvalidToken</span>)
|
||||
.<span class="ident">error_description</span>(<span class="string">"Subject 8740827c-2e0a-447b-9716-d73042e4039d not found"</span>)
|
||||
.<span class="ident">finish</span>();
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>to_bytes() {
|
||||
<span class="kw">let </span>b = Bearer::build()
|
||||
.error(Error::InvalidToken)
|
||||
.error_description(<span class="string">"Subject 8740827c-2e0a-447b-9716-d73042e4039d not found"</span>)
|
||||
.finish();
|
||||
|
||||
<span class="macro">assert_eq!</span>(
|
||||
<span class="string">"Bearer error=\"invalid_token\" error_description=\"Subject 8740827c-2e0a-447b-9716-d73042e4039d not found\""</span>,
|
||||
<span class="macro">format!</span>(<span class="string">"{}"</span>, <span class="ident">b</span>)
|
||||
<span class="macro">format!</span>(<span class="string">"{}"</span>, b)
|
||||
);
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -10,17 +10,17 @@
|
||||
<span id="10">10</span>
|
||||
<span id="11">11</span>
|
||||
<span id="12">12</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::fmt</span>::{<span class="ident">Debug</span>, <span class="ident">Display</span>};
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::fmt::{Debug, Display};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">http::header::TryIntoHeaderValue</span>, <span class="ident">web::Bytes</span>};
|
||||
<span class="kw">use </span>actix_web::{http::header::TryIntoHeaderValue, web::Bytes};
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">basic</span>;
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">bearer</span>;
|
||||
<span class="kw">pub mod </span>basic;
|
||||
<span class="kw">pub mod </span>bearer;
|
||||
|
||||
<span class="doccomment">/// Authentication challenge for `WWW-Authenticate` header.</span>
|
||||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Challenge</span>: <span class="ident">TryIntoHeaderValue</span> <span class="op">+</span> <span class="ident">Debug</span> <span class="op">+</span> <span class="ident">Display</span> <span class="op">+</span> <span class="ident">Clone</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span> {
|
||||
<span class="doccomment">/// Converts the challenge into a bytes suitable for HTTP transmission.</span>
|
||||
<span class="kw">fn</span> <span class="ident">to_bytes</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="ident">Bytes</span>;
|
||||
<span class="doccomment">/// Authentication challenge for `WWW-Authenticate` header.
|
||||
</span><span class="kw">pub trait </span>Challenge: TryIntoHeaderValue + Debug + Display + Clone + Send + Sync {
|
||||
<span class="doccomment">/// Converts the challenge into a bytes suitable for HTTP transmission.
|
||||
</span><span class="kw">fn </span>to_bytes(<span class="kw-2">&</span><span class="self">self</span>) -> Bytes;
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -33,40 +33,40 @@
|
||||
<span id="33">33</span>
|
||||
<span id="34">34</span>
|
||||
<span id="35">35</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">error::ParseError</span>,
|
||||
<span class="ident">http::header</span>::{<span class="ident">Header</span>, <span class="ident">HeaderName</span>, <span class="ident">HeaderValue</span>, <span class="ident">TryIntoHeaderValue</span>, <span class="ident">WWW_AUTHENTICATE</span>},
|
||||
<span class="ident">HttpMessage</span>,
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>actix_web::{
|
||||
error::ParseError,
|
||||
http::header::{Header, HeaderName, HeaderValue, TryIntoHeaderValue, WWW_AUTHENTICATE},
|
||||
HttpMessage,
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::Challenge</span>;
|
||||
<span class="kw">use </span><span class="kw">super</span>::Challenge;
|
||||
|
||||
<span class="doccomment">/// `WWW-Authenticate` header, described in [RFC 7235].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This header is generic over the [`Challenge`] trait, see [`Basic`](super::basic::Basic) and</span>
|
||||
<span class="doccomment">/// [`Bearer`](super::bearer::Bearer) challenges for details.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [RFC 7235]: https://tools.ietf.org/html/rfc7235#section-4.1</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Default</span>, <span class="ident">Clone</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>, <span class="ident">PartialOrd</span>, <span class="ident">Ord</span>, <span class="ident">Hash</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">WwwAuthenticate</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span>(<span class="kw">pub</span> <span class="ident">C</span>);
|
||||
<span class="doccomment">/// `WWW-Authenticate` header, described in [RFC 7235].
|
||||
///
|
||||
/// This header is generic over the [`Challenge`] trait, see [`Basic`](super::basic::Basic) and
|
||||
/// [`Bearer`](super::bearer::Bearer) challenges for details.
|
||||
///
|
||||
/// [RFC 7235]: https://tools.ietf.org/html/rfc7235#section-4.1
|
||||
</span><span class="attribute">#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||
</span><span class="kw">pub struct </span>WwwAuthenticate<C: Challenge>(<span class="kw">pub </span>C);
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> <span class="ident">Header</span> <span class="kw">for</span> <span class="ident">WwwAuthenticate</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">name</span>() -> <span class="ident">HeaderName</span> {
|
||||
<span class="ident">WWW_AUTHENTICATE</span>
|
||||
<span class="kw">impl</span><C: Challenge> Header <span class="kw">for </span>WwwAuthenticate<C> {
|
||||
<span class="attribute">#[inline]
|
||||
</span><span class="kw">fn </span>name() -> HeaderName {
|
||||
WWW_AUTHENTICATE
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">parse</span><span class="op"><</span><span class="ident">T</span>: <span class="ident">HttpMessage</span><span class="op">></span>(<span class="ident">_msg</span>: <span class="kw-2">&</span><span class="ident">T</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="self">Self</span>, <span class="ident">ParseError</span><span class="op">></span> {
|
||||
<span class="kw">fn </span>parse<T: HttpMessage>(_msg: <span class="kw-2">&</span>T) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, ParseError> {
|
||||
<span class="macro">unimplemented!</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">C</span>: <span class="ident">Challenge</span><span class="op">></span> <span class="ident">TryIntoHeaderValue</span> <span class="kw">for</span> <span class="ident">WwwAuthenticate</span><span class="op"><</span><span class="ident">C</span><span class="op">></span> {
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="op"><</span><span class="ident">C</span> <span class="kw">as</span> <span class="ident">TryIntoHeaderValue</span><span class="op">></span><span class="ident">::Error</span>;
|
||||
<span class="kw">impl</span><C: Challenge> TryIntoHeaderValue <span class="kw">for </span>WwwAuthenticate<C> {
|
||||
<span class="kw">type </span>Error = <C <span class="kw">as </span>TryIntoHeaderValue>::Error;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">try_into_value</span>(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">HeaderValue</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">try_into_value</span>()
|
||||
<span class="kw">fn </span>try_into_value(<span class="self">self</span>) -> <span class="prelude-ty">Result</span><HeaderValue, <span class="self">Self</span>::Error> {
|
||||
<span class="self">self</span>.<span class="number">0</span>.try_into_value()
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -5,12 +5,12 @@
|
||||
<span id="5">5</span>
|
||||
<span id="6">6</span>
|
||||
<span id="7">7</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! `WWW-Authenticate` header and various auth challenges.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! `WWW-Authenticate` header and various auth challenges.
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">challenge</span>;
|
||||
<span class="kw">mod</span> <span class="ident">header</span>;
|
||||
</span><span class="kw">mod </span>challenge;
|
||||
<span class="kw">mod </span>header;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::challenge</span>::{<span class="ident">basic</span>, <span class="ident">bearer</span>, <span class="ident">Challenge</span>};
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="self">self</span>::header::WwwAuthenticate</span>;
|
||||
<span class="kw">pub use </span><span class="self">self</span>::challenge::{basic, bearer, Challenge};
|
||||
<span class="kw">pub use </span><span class="self">self</span>::header::WwwAuthenticate;
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -22,29 +22,29 @@
|
||||
<span id="22">22</span>
|
||||
<span id="23">23</span>
|
||||
<span id="24">24</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! HTTP authentication schemes for [Actix Web](https://actix.rs).</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Provides:</span>
|
||||
<span class="doccomment">//! - Typed [Authorization] and [WWW-Authenticate] headers</span>
|
||||
<span class="doccomment">//! - [Extractors] for an [Authorization] header</span>
|
||||
<span class="doccomment">//! - [Middleware] for easier authorization checking</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ## Supported schemes</span>
|
||||
<span class="doccomment">//! - `Bearer` as defined in [RFC 6750](https://tools.ietf.org/html/rfc6750).</span>
|
||||
<span class="doccomment">//! - `Basic` as defined in [RFC 7617](https://tools.ietf.org/html/rfc7617).</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! [Authorization]: `self::headers::authorization::Authorization`</span>
|
||||
<span class="doccomment">//! [WWW-Authenticate]: `self::headers::www_authenticate::WwwAuthenticate`</span>
|
||||
<span class="doccomment">//! [Extractors]: https://actix.rs/docs/extractors</span>
|
||||
<span class="doccomment">//! [Middleware]: self::middleware</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! HTTP authentication schemes for [Actix Web](https://actix.rs).
|
||||
//!
|
||||
//! Provides:
|
||||
//! - Typed [Authorization] and [WWW-Authenticate] headers
|
||||
//! - [Extractors] for an [Authorization] header
|
||||
//! - [Middleware] for easier authorization checking
|
||||
//!
|
||||
//! ## Supported schemes
|
||||
//! - `Bearer` as defined in [RFC 6750](https://tools.ietf.org/html/rfc6750).
|
||||
//! - `Basic` as defined in [RFC 7617](https://tools.ietf.org/html/rfc7617).
|
||||
//!
|
||||
//! [Authorization]: `self::headers::authorization::Authorization`
|
||||
//! [WWW-Authenticate]: `self::headers::www_authenticate::WwwAuthenticate`
|
||||
//! [Extractors]: https://actix.rs/docs/extractors
|
||||
//! [Middleware]: self::middleware
|
||||
|
||||
<span class="attribute">#![<span class="ident">forbid</span>(<span class="ident">unsafe_code</span>)]</span>
|
||||
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">rust_2018_idioms</span>, <span class="ident">nonstandard_style</span>)]</span>
|
||||
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">future_incompatible</span>, <span class="ident">missing_docs</span>)]</span>
|
||||
</span><span class="attribute">#![forbid(unsafe_code)]
|
||||
#![deny(rust_2018_idioms, nonstandard_style)]
|
||||
#![warn(future_incompatible, missing_docs)]
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">extractors</span>;
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">headers</span>;
|
||||
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">middleware</span>;
|
||||
<span class="kw">mod</span> <span class="ident">utils</span>;
|
||||
</span><span class="kw">pub mod </span>extractors;
|
||||
<span class="kw">pub mod </span>headers;
|
||||
<span class="kw">pub mod </span>middleware;
|
||||
<span class="kw">mod </span>utils;
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -415,422 +415,422 @@
|
||||
<span id="415">415</span>
|
||||
<span id="416">416</span>
|
||||
<span id="417">417</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! HTTP Authentication middleware.</span>
|
||||
</pre><pre class="rust"><code><span class="doccomment">//! HTTP Authentication middleware.
|
||||
|
||||
<span class="kw">use</span> <span class="ident">std</span>::{
|
||||
<span class="ident">future::Future</span>,
|
||||
<span class="ident">marker::PhantomData</span>,
|
||||
<span class="ident">pin::Pin</span>,
|
||||
<span class="ident">rc::Rc</span>,
|
||||
<span class="ident">sync::Arc</span>,
|
||||
<span class="ident">task</span>::{<span class="ident">Context</span>, <span class="ident">Poll</span>},
|
||||
</span><span class="kw">use </span>std::{
|
||||
future::Future,
|
||||
marker::PhantomData,
|
||||
pin::Pin,
|
||||
rc::Rc,
|
||||
sync::Arc,
|
||||
task::{Context, Poll},
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">body</span>::{<span class="ident">EitherBody</span>, <span class="ident">MessageBody</span>},
|
||||
<span class="ident">dev</span>::{<span class="ident">Service</span>, <span class="ident">ServiceRequest</span>, <span class="ident">ServiceResponse</span>, <span class="ident">Transform</span>},
|
||||
<span class="ident">Error</span>, <span class="ident">FromRequest</span>,
|
||||
<span class="kw">use </span>actix_web::{
|
||||
body::{EitherBody, MessageBody},
|
||||
dev::{Service, ServiceRequest, ServiceResponse, Transform},
|
||||
Error, FromRequest,
|
||||
};
|
||||
<span class="kw">use</span> <span class="ident">futures_core::ready</span>;
|
||||
<span class="kw">use</span> <span class="ident">futures_util::future</span>::{<span class="self">self</span>, <span class="ident">LocalBoxFuture</span>, <span class="ident">TryFutureExt</span> <span class="kw">as</span> <span class="kw">_</span>};
|
||||
<span class="kw">use </span>futures_core::ready;
|
||||
<span class="kw">use </span>futures_util::future::{<span class="self">self</span>, LocalBoxFuture, TryFutureExt <span class="kw">as _</span>};
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::extractors</span>::{<span class="ident">basic</span>, <span class="ident">bearer</span>};
|
||||
<span class="kw">use </span><span class="kw">crate</span>::extractors::{basic, bearer};
|
||||
|
||||
<span class="doccomment">/// Middleware for checking HTTP authentication.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// If there is no `Authorization` header in the request, this middleware returns an error</span>
|
||||
<span class="doccomment">/// immediately, without calling the `F` callback.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Otherwise, it will pass both the request and the parsed credentials into it. In case of</span>
|
||||
<span class="doccomment">/// successful validation `F` callback is required to return the `ServiceRequest` back.</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Clone</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">HttpAuthentication</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">FromRequest</span>,
|
||||
<span class="doccomment">/// Middleware for checking HTTP authentication.
|
||||
///
|
||||
/// If there is no `Authorization` header in the request, this middleware returns an error
|
||||
/// immediately, without calling the `F` callback.
|
||||
///
|
||||
/// Otherwise, it will pass both the request and the parsed credentials into it. In case of
|
||||
/// successful validation `F` callback is required to return the `ServiceRequest` back.
|
||||
</span><span class="attribute">#[derive(Debug, Clone)]
|
||||
</span><span class="kw">pub struct </span>HttpAuthentication<T, F>
|
||||
<span class="kw">where
|
||||
</span>T: FromRequest,
|
||||
{
|
||||
<span class="ident">process_fn</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>,
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
|
||||
process_fn: Arc<F>,
|
||||
_extractor: PhantomData<T>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span>, <span class="ident">O</span><span class="op">></span> <span class="ident">HttpAuthentication</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">FromRequest</span>,
|
||||
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="ident">ServiceRequest</span>, <span class="ident">T</span>) -> <span class="ident">O</span>,
|
||||
<span class="ident">O</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ServiceRequest</span>, (<span class="ident">Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">impl</span><T, F, O> HttpAuthentication<T, F>
|
||||
<span class="kw">where
|
||||
</span>T: FromRequest,
|
||||
F: Fn(ServiceRequest, T) -> O,
|
||||
O: Future<Output = <span class="prelude-ty">Result</span><ServiceRequest, (Error, ServiceRequest)>>,
|
||||
{
|
||||
<span class="doccomment">/// Construct `HttpAuthentication` middleware with the provided auth extractor `T` and</span>
|
||||
<span class="doccomment">/// validation callback `F`.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_fn</span>(<span class="ident">process_fn</span>: <span class="ident">F</span>) -> <span class="ident">HttpAuthentication</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span> {
|
||||
<span class="ident">HttpAuthentication</span> {
|
||||
<span class="ident">process_fn</span>: <span class="ident">Arc::new</span>(<span class="ident">process_fn</span>),
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span>,
|
||||
<span class="doccomment">/// Construct `HttpAuthentication` middleware with the provided auth extractor `T` and
|
||||
/// validation callback `F`.
|
||||
</span><span class="kw">pub fn </span>with_fn(process_fn: F) -> HttpAuthentication<T, F> {
|
||||
HttpAuthentication {
|
||||
process_fn: Arc::new(process_fn),
|
||||
_extractor: PhantomData,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">O</span><span class="op">></span> <span class="ident">HttpAuthentication</span><span class="op"><</span><span class="ident">basic::BasicAuth</span>, <span class="ident">F</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="ident">ServiceRequest</span>, <span class="ident">basic::BasicAuth</span>) -> <span class="ident">O</span>,
|
||||
<span class="ident">O</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ServiceRequest</span>, (<span class="ident">Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">impl</span><F, O> HttpAuthentication<basic::BasicAuth, F>
|
||||
<span class="kw">where
|
||||
</span>F: Fn(ServiceRequest, basic::BasicAuth) -> O,
|
||||
O: Future<Output = <span class="prelude-ty">Result</span><ServiceRequest, (Error, ServiceRequest)>>,
|
||||
{
|
||||
<span class="doccomment">/// Construct `HttpAuthentication` middleware for the HTTP "Basic" authentication scheme.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web::{Error, dev::ServiceRequest};</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::{extractors::basic::BasicAuth, middleware::HttpAuthentication};</span>
|
||||
<span class="doccomment">/// // In this example validator returns immediately, but since it is required to return</span>
|
||||
<span class="doccomment">/// // anything that implements `IntoFuture` trait, it can be extended to query database or to</span>
|
||||
<span class="doccomment">/// // do something else in a async manner.</span>
|
||||
<span class="doccomment">/// async fn validator(</span>
|
||||
<span class="doccomment">/// req: ServiceRequest,</span>
|
||||
<span class="doccomment">/// credentials: BasicAuth,</span>
|
||||
<span class="doccomment">/// ) -> Result<ServiceRequest, (Error, ServiceRequest)> {</span>
|
||||
<span class="doccomment">/// // All users are great and more than welcome!</span>
|
||||
<span class="doccomment">/// Ok(req)</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let middleware = HttpAuthentication::basic(validator);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">basic</span>(<span class="ident">process_fn</span>: <span class="ident">F</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::with_fn</span>(<span class="ident">process_fn</span>)
|
||||
<span class="doccomment">/// Construct `HttpAuthentication` middleware for the HTTP "Basic" authentication scheme.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web::{Error, dev::ServiceRequest};
|
||||
/// # use actix_web_httpauth::{extractors::basic::BasicAuth, middleware::HttpAuthentication};
|
||||
/// // In this example validator returns immediately, but since it is required to return
|
||||
/// // anything that implements `IntoFuture` trait, it can be extended to query database or to
|
||||
/// // do something else in a async manner.
|
||||
/// async fn validator(
|
||||
/// req: ServiceRequest,
|
||||
/// credentials: BasicAuth,
|
||||
/// ) -> Result<ServiceRequest, (Error, ServiceRequest)> {
|
||||
/// // All users are great and more than welcome!
|
||||
/// Ok(req)
|
||||
/// }
|
||||
///
|
||||
/// let middleware = HttpAuthentication::basic(validator);
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>basic(process_fn: F) -> <span class="self">Self </span>{
|
||||
<span class="self">Self</span>::with_fn(process_fn)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">O</span><span class="op">></span> <span class="ident">HttpAuthentication</span><span class="op"><</span><span class="ident">bearer::BearerAuth</span>, <span class="ident">F</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="ident">ServiceRequest</span>, <span class="ident">bearer::BearerAuth</span>) -> <span class="ident">O</span>,
|
||||
<span class="ident">O</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ServiceRequest</span>, (<span class="ident">Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span><span class="op">></span>,
|
||||
<span class="kw">impl</span><F, O> HttpAuthentication<bearer::BearerAuth, F>
|
||||
<span class="kw">where
|
||||
</span>F: Fn(ServiceRequest, bearer::BearerAuth) -> O,
|
||||
O: Future<Output = <span class="prelude-ty">Result</span><ServiceRequest, (Error, ServiceRequest)>>,
|
||||
{
|
||||
<span class="doccomment">/// Construct `HttpAuthentication` middleware for the HTTP "Bearer" authentication scheme.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// # Examples</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="doccomment">/// # use actix_web::{Error, dev::ServiceRequest};</span>
|
||||
<span class="doccomment">/// # use actix_web_httpauth::{</span>
|
||||
<span class="doccomment">/// # extractors::{AuthenticationError, AuthExtractorConfig, bearer::{self, BearerAuth}},</span>
|
||||
<span class="doccomment">/// # middleware::HttpAuthentication,</span>
|
||||
<span class="doccomment">/// # };</span>
|
||||
<span class="doccomment">/// async fn validator(</span>
|
||||
<span class="doccomment">/// req: ServiceRequest,</span>
|
||||
<span class="doccomment">/// credentials: BearerAuth</span>
|
||||
<span class="doccomment">/// ) -> Result<ServiceRequest, (Error, ServiceRequest)> {</span>
|
||||
<span class="doccomment">/// if credentials.token() == "mF_9.B5f-4.1JqM" {</span>
|
||||
<span class="doccomment">/// Ok(req)</span>
|
||||
<span class="doccomment">/// } else {</span>
|
||||
<span class="doccomment">/// let config = req.app_data::<bearer::Config>()</span>
|
||||
<span class="doccomment">/// .cloned()</span>
|
||||
<span class="doccomment">/// .unwrap_or_default()</span>
|
||||
<span class="doccomment">/// .scope("urn:example:channel=HBO&urn:example:rating=G,PG-13");</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Err((AuthenticationError::from(config).into(), req))</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">/// }</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// let middleware = HttpAuthentication::bearer(validator);</span>
|
||||
<span class="doccomment">/// ```</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">bearer</span>(<span class="ident">process_fn</span>: <span class="ident">F</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident"><span class="self">Self</span>::with_fn</span>(<span class="ident">process_fn</span>)
|
||||
<span class="doccomment">/// Construct `HttpAuthentication` middleware for the HTTP "Bearer" authentication scheme.
|
||||
///
|
||||
/// # Examples
|
||||
/// ```
|
||||
/// # use actix_web::{Error, dev::ServiceRequest};
|
||||
/// # use actix_web_httpauth::{
|
||||
/// # extractors::{AuthenticationError, AuthExtractorConfig, bearer::{self, BearerAuth}},
|
||||
/// # middleware::HttpAuthentication,
|
||||
/// # };
|
||||
/// async fn validator(
|
||||
/// req: ServiceRequest,
|
||||
/// credentials: BearerAuth
|
||||
/// ) -> Result<ServiceRequest, (Error, ServiceRequest)> {
|
||||
/// if credentials.token() == "mF_9.B5f-4.1JqM" {
|
||||
/// Ok(req)
|
||||
/// } else {
|
||||
/// let config = req.app_data::<bearer::Config>()
|
||||
/// .cloned()
|
||||
/// .unwrap_or_default()
|
||||
/// .scope("urn:example:channel=HBO&urn:example:rating=G,PG-13");
|
||||
///
|
||||
/// Err((AuthenticationError::from(config).into(), req))
|
||||
/// }
|
||||
/// }
|
||||
///
|
||||
/// let middleware = HttpAuthentication::bearer(validator);
|
||||
/// ```
|
||||
</span><span class="kw">pub fn </span>bearer(process_fn: F) -> <span class="self">Self </span>{
|
||||
<span class="self">Self</span>::with_fn(process_fn)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">B</span>, <span class="ident">T</span>, <span class="ident">F</span>, <span class="ident">O</span><span class="op">></span> <span class="ident">Transform</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">ServiceRequest</span><span class="op">></span> <span class="kw">for</span> <span class="ident">HttpAuthentication</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">F</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">S</span>: <span class="ident">Service</span><span class="op"><</span><span class="ident">ServiceRequest</span>, <span class="ident">Response</span> <span class="op">=</span> <span class="ident">ServiceResponse</span><span class="op"><</span><span class="ident">B</span><span class="op">></span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">Error</span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">S::Future</span>: <span class="lifetime">'static</span>,
|
||||
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="ident">ServiceRequest</span>, <span class="ident">T</span>) -> <span class="ident">O</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">O</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ServiceRequest</span>, (<span class="ident">Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">T</span>: <span class="ident">FromRequest</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">B</span>: <span class="ident">MessageBody</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="kw">impl</span><S, B, T, F, O> Transform<S, ServiceRequest> <span class="kw">for </span>HttpAuthentication<T, F>
|
||||
<span class="kw">where
|
||||
</span>S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + <span class="lifetime">'static</span>,
|
||||
S::Future: <span class="lifetime">'static</span>,
|
||||
F: Fn(ServiceRequest, T) -> O + <span class="lifetime">'static</span>,
|
||||
O: Future<Output = <span class="prelude-ty">Result</span><ServiceRequest, (Error, ServiceRequest)>> + <span class="lifetime">'static</span>,
|
||||
T: FromRequest + <span class="lifetime">'static</span>,
|
||||
B: MessageBody + <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="kw">type</span> <span class="ident">Response</span> <span class="op">=</span> <span class="ident">ServiceResponse</span><span class="op"><</span><span class="ident">EitherBody</span><span class="op"><</span><span class="ident">B</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">Error</span>;
|
||||
<span class="kw">type</span> <span class="ident">Transform</span> <span class="op">=</span> <span class="ident">AuthenticationMiddleware</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">F</span>, <span class="ident">T</span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">InitError</span> <span class="op">=</span> ();
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">future::Ready</span><span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Transform</span>, <span class="ident"><span class="self">Self</span>::InitError</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type </span>Response = ServiceResponse<EitherBody<B>>;
|
||||
<span class="kw">type </span>Error = Error;
|
||||
<span class="kw">type </span>Transform = AuthenticationMiddleware<S, F, T>;
|
||||
<span class="kw">type </span>InitError = ();
|
||||
<span class="kw">type </span>Future = future::Ready<<span class="prelude-ty">Result</span><<span class="self">Self</span>::Transform, <span class="self">Self</span>::InitError>>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">new_transform</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">service</span>: <span class="ident">S</span>) -> <span class="ident"><span class="self">Self</span>::Future</span> {
|
||||
<span class="ident">future::ok</span>(<span class="ident">AuthenticationMiddleware</span> {
|
||||
<span class="ident">service</span>: <span class="ident">Rc::new</span>(<span class="ident">service</span>),
|
||||
<span class="ident">process_fn</span>: <span class="self">self</span>.<span class="ident">process_fn</span>.<span class="ident">clone</span>(),
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span>,
|
||||
<span class="kw">fn </span>new_transform(<span class="kw-2">&</span><span class="self">self</span>, service: S) -> <span class="self">Self</span>::Future {
|
||||
future::ok(AuthenticationMiddleware {
|
||||
service: Rc::new(service),
|
||||
process_fn: <span class="self">self</span>.process_fn.clone(),
|
||||
_extractor: PhantomData,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">doc</span>(<span class="ident">hidden</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AuthenticationMiddleware</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">F</span>, <span class="ident">T</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">FromRequest</span>,
|
||||
<span class="attribute">#[doc(hidden)]
|
||||
</span><span class="kw">pub struct </span>AuthenticationMiddleware<S, F, T>
|
||||
<span class="kw">where
|
||||
</span>T: FromRequest,
|
||||
{
|
||||
<span class="ident">service</span>: <span class="ident">Rc</span><span class="op"><</span><span class="ident">S</span><span class="op">></span>,
|
||||
<span class="ident">process_fn</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">F</span><span class="op">></span>,
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
|
||||
service: Rc<S>,
|
||||
process_fn: Arc<F>,
|
||||
_extractor: PhantomData<T>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">B</span>, <span class="ident">F</span>, <span class="ident">T</span>, <span class="ident">O</span><span class="op">></span> <span class="ident">Service</span><span class="op"><</span><span class="ident">ServiceRequest</span><span class="op">></span> <span class="kw">for</span> <span class="ident">AuthenticationMiddleware</span><span class="op"><</span><span class="ident">S</span>, <span class="ident">F</span>, <span class="ident">T</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">S</span>: <span class="ident">Service</span><span class="op"><</span><span class="ident">ServiceRequest</span>, <span class="ident">Response</span> <span class="op">=</span> <span class="ident">ServiceResponse</span><span class="op"><</span><span class="ident">B</span><span class="op">></span>, <span class="ident">Error</span> <span class="op">=</span> <span class="ident">Error</span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">S::Future</span>: <span class="lifetime">'static</span>,
|
||||
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="ident">ServiceRequest</span>, <span class="ident">T</span>) -> <span class="ident">O</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">O</span>: <span class="ident">Future</span><span class="op"><</span><span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ServiceRequest</span>, (<span class="ident">Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">T</span>: <span class="ident">FromRequest</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="ident">B</span>: <span class="ident">MessageBody</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||||
<span class="kw">impl</span><S, B, F, T, O> Service<ServiceRequest> <span class="kw">for </span>AuthenticationMiddleware<S, F, T>
|
||||
<span class="kw">where
|
||||
</span>S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + <span class="lifetime">'static</span>,
|
||||
S::Future: <span class="lifetime">'static</span>,
|
||||
F: Fn(ServiceRequest, T) -> O + <span class="lifetime">'static</span>,
|
||||
O: Future<Output = <span class="prelude-ty">Result</span><ServiceRequest, (Error, ServiceRequest)>> + <span class="lifetime">'static</span>,
|
||||
T: FromRequest + <span class="lifetime">'static</span>,
|
||||
B: MessageBody + <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="kw">type</span> <span class="ident">Response</span> <span class="op">=</span> <span class="ident">ServiceResponse</span><span class="op"><</span><span class="ident">EitherBody</span><span class="op"><</span><span class="ident">B</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type</span> <span class="ident">Error</span> <span class="op">=</span> <span class="ident">S::Error</span>;
|
||||
<span class="kw">type</span> <span class="ident">Future</span> <span class="op">=</span> <span class="ident">LocalBoxFuture</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Response</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span><span class="op">></span>;
|
||||
<span class="kw">type </span>Response = ServiceResponse<EitherBody<B>>;
|
||||
<span class="kw">type </span>Error = S::Error;
|
||||
<span class="kw">type </span>Future = LocalBoxFuture<<span class="lifetime">'static</span>, <span class="prelude-ty">Result</span><<span class="self">Self</span>::Response, <span class="self">Self</span>::Error>>;
|
||||
|
||||
<span class="macro">actix_web::dev::forward_ready!</span>(<span class="ident">service</span>);
|
||||
<span class="macro">actix_web::dev::forward_ready!</span>(service);
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">call</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">req</span>: <span class="ident">ServiceRequest</span>) -> <span class="ident"><span class="self">Self</span>::Future</span> {
|
||||
<span class="kw">let</span> <span class="ident">process_fn</span> <span class="op">=</span> <span class="ident">Arc::clone</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">process_fn</span>);
|
||||
<span class="kw">let</span> <span class="ident">service</span> <span class="op">=</span> <span class="ident">Rc::clone</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">service</span>);
|
||||
<span class="kw">fn </span>call(<span class="kw-2">&</span><span class="self">self</span>, req: ServiceRequest) -> <span class="self">Self</span>::Future {
|
||||
<span class="kw">let </span>process_fn = Arc::clone(<span class="kw-2">&</span><span class="self">self</span>.process_fn);
|
||||
<span class="kw">let </span>service = Rc::clone(<span class="kw-2">&</span><span class="self">self</span>.service);
|
||||
|
||||
<span class="ident">Box::pin</span>(<span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="kw">let</span> (<span class="ident">req</span>, <span class="ident">credentials</span>) <span class="op">=</span> <span class="kw">match</span> <span class="ident">Extract</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span><span class="ident">::new</span>(<span class="ident">req</span>).<span class="kw">await</span> {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">req</span>) => <span class="ident">req</span>,
|
||||
<span class="prelude-val">Err</span>((<span class="ident">err</span>, <span class="ident">req</span>)) => {
|
||||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">req</span>.<span class="ident">error_response</span>(<span class="ident">err</span>).<span class="ident">map_into_right_body</span>());
|
||||
Box::pin(<span class="kw">async move </span>{
|
||||
<span class="kw">let </span>(req, credentials) = <span class="kw">match </span>Extract::<T>::new(req).<span class="kw">await </span>{
|
||||
<span class="prelude-val">Ok</span>(req) => req,
|
||||
<span class="prelude-val">Err</span>((err, req)) => {
|
||||
<span class="kw">return </span><span class="prelude-val">Ok</span>(req.error_response(err).map_into_right_body());
|
||||
}
|
||||
};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">process_fn</span>(<span class="ident">req</span>, <span class="ident">credentials</span>).<span class="kw">await</span> {
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">req</span>) => <span class="ident">req</span>,
|
||||
<span class="prelude-val">Err</span>((<span class="ident">err</span>, <span class="ident">req</span>)) => {
|
||||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">req</span>.<span class="ident">error_response</span>(<span class="ident">err</span>).<span class="ident">map_into_right_body</span>());
|
||||
<span class="kw">let </span>req = <span class="kw">match </span>process_fn(req, credentials).<span class="kw">await </span>{
|
||||
<span class="prelude-val">Ok</span>(req) => req,
|
||||
<span class="prelude-val">Err</span>((err, req)) => {
|
||||
<span class="kw">return </span><span class="prelude-val">Ok</span>(req.error_response(err).map_into_right_body());
|
||||
}
|
||||
};
|
||||
|
||||
<span class="ident">service</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>.<span class="ident">map</span>(<span class="op">|</span><span class="ident">res</span><span class="op">|</span> <span class="ident">res</span>.<span class="ident">map_into_left_body</span>())
|
||||
service.call(req).<span class="kw">await</span>.map(|res| res.map_into_left_body())
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">struct</span> <span class="ident">Extract</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="ident">req</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ServiceRequest</span><span class="op">></span>,
|
||||
<span class="ident">fut</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">LocalBoxFuture</span><span class="op"><</span><span class="lifetime">'static</span>, <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">Error</span><span class="op">></span><span class="op">></span><span class="op">></span>,
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span><span class="op"><</span><span class="kw">fn</span>() -> <span class="ident">T</span><span class="op">></span>,
|
||||
<span class="kw">struct </span>Extract<T> {
|
||||
req: <span class="prelude-ty">Option</span><ServiceRequest>,
|
||||
fut: <span class="prelude-ty">Option</span><LocalBoxFuture<<span class="lifetime">'static</span>, <span class="prelude-ty">Result</span><T, Error>>>,
|
||||
_extractor: PhantomData<<span class="kw">fn</span>() -> T>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Extract</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">req</span>: <span class="ident">ServiceRequest</span>) -> <span class="self">Self</span> {
|
||||
<span class="ident">Extract</span> {
|
||||
<span class="ident">req</span>: <span class="prelude-val">Some</span>(<span class="ident">req</span>),
|
||||
<span class="ident">fut</span>: <span class="prelude-val">None</span>,
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span>,
|
||||
<span class="kw">impl</span><T> Extract<T> {
|
||||
<span class="kw">pub fn </span>new(req: ServiceRequest) -> <span class="self">Self </span>{
|
||||
Extract {
|
||||
req: <span class="prelude-val">Some</span>(req),
|
||||
fut: <span class="prelude-val">None</span>,
|
||||
_extractor: PhantomData,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Future</span> <span class="kw">for</span> <span class="ident">Extract</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>
|
||||
<span class="kw">where</span>
|
||||
<span class="ident">T</span>: <span class="ident">FromRequest</span>,
|
||||
<span class="ident">T::Future</span>: <span class="lifetime">'static</span>,
|
||||
<span class="ident">T::Error</span>: <span class="lifetime">'static</span>,
|
||||
<span class="kw">impl</span><T> Future <span class="kw">for </span>Extract<T>
|
||||
<span class="kw">where
|
||||
</span>T: FromRequest,
|
||||
T::Future: <span class="lifetime">'static</span>,
|
||||
T::Error: <span class="lifetime">'static</span>,
|
||||
{
|
||||
<span class="kw">type</span> <span class="ident">Output</span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="ident">ServiceRequest</span>, <span class="ident">T</span>), (<span class="ident">Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span>;
|
||||
<span class="kw">type </span>Output = <span class="prelude-ty">Result</span><(ServiceRequest, T), (Error, ServiceRequest)>;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">poll</span>(<span class="kw-2">mut</span> <span class="self">self</span>: <span class="ident">Pin</span><span class="op"><</span><span class="kw-2">&mut</span> <span class="self">Self</span><span class="op">></span>, <span class="ident">ctx</span>: <span class="kw-2">&mut</span> <span class="ident">Context</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">Poll</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Output</span><span class="op">></span> {
|
||||
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">fut</span>.<span class="ident">is_none</span>() {
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">req</span>.<span class="ident">as_mut</span>().<span class="ident">expect</span>(<span class="string">"Extract future was polled twice!"</span>);
|
||||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="ident">req</span>.<span class="ident">extract</span>::<span class="op"><</span><span class="ident">T</span><span class="op">></span>().<span class="ident">map_err</span>(<span class="ident">Into::into</span>);
|
||||
<span class="self">self</span>.<span class="ident">fut</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">Box::pin</span>(<span class="ident">fut</span>));
|
||||
<span class="kw">fn </span>poll(<span class="kw-2">mut </span><span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, ctx: <span class="kw-2">&mut </span>Context<<span class="lifetime">'_</span>>) -> Poll<<span class="self">Self</span>::Output> {
|
||||
<span class="kw">if </span><span class="self">self</span>.fut.is_none() {
|
||||
<span class="kw">let </span>req = <span class="self">self</span>.req.as_mut().expect(<span class="string">"Extract future was polled twice!"</span>);
|
||||
<span class="kw">let </span>fut = req.extract::<T>().map_err(Into::into);
|
||||
<span class="self">self</span>.fut = <span class="prelude-val">Some</span>(Box::pin(fut));
|
||||
}
|
||||
|
||||
<span class="kw">let</span> <span class="ident">fut</span> <span class="op">=</span> <span class="self">self</span>
|
||||
.<span class="ident">fut</span>
|
||||
.<span class="ident">as_mut</span>()
|
||||
.<span class="ident">expect</span>(<span class="string">"Extraction future should be initialized at this point"</span>);
|
||||
<span class="kw">let </span>fut = <span class="self">self
|
||||
</span>.fut
|
||||
.as_mut()
|
||||
.expect(<span class="string">"Extraction future should be initialized at this point"</span>);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">credentials</span> <span class="op">=</span> <span class="macro">ready!</span>(<span class="ident">fut</span>.<span class="ident">as_mut</span>().<span class="ident">poll</span>(<span class="ident">ctx</span>)).<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> {
|
||||
<span class="kw">let </span>credentials = <span class="macro">ready!</span>(fut.as_mut().poll(ctx)).map_err(|err| {
|
||||
(
|
||||
<span class="ident">err</span>,
|
||||
<span class="comment">// returning request allows a proper error response to be created</span>
|
||||
<span class="self">self</span>.<span class="ident">req</span>.<span class="ident">take</span>().<span class="ident">expect</span>(<span class="string">"Extract future was polled twice!"</span>),
|
||||
err,
|
||||
<span class="comment">// returning request allows a proper error response to be created
|
||||
</span><span class="self">self</span>.req.take().expect(<span class="string">"Extract future was polled twice!"</span>),
|
||||
)
|
||||
})<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">req</span>.<span class="ident">take</span>().<span class="ident">expect</span>(<span class="string">"Extract future was polled twice!"</span>);
|
||||
<span class="ident">Poll::Ready</span>(<span class="prelude-val">Ok</span>((<span class="ident">req</span>, <span class="ident">credentials</span>)))
|
||||
<span class="kw">let </span>req = <span class="self">self</span>.req.take().expect(<span class="string">"Extract future was polled twice!"</span>);
|
||||
Poll::Ready(<span class="prelude-val">Ok</span>((req, credentials)))
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="ident">actix_service::into_service</span>;
|
||||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||||
<span class="ident">dev::Service</span>,
|
||||
<span class="ident">error</span>::{<span class="self">self</span>, <span class="ident">ErrorForbidden</span>},
|
||||
<span class="ident">http::StatusCode</span>,
|
||||
<span class="ident">test::TestRequest</span>,
|
||||
<span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">HttpResponse</span>,
|
||||
<span class="attribute">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use </span>actix_service::into_service;
|
||||
<span class="kw">use </span>actix_web::{
|
||||
dev::Service,
|
||||
error::{<span class="self">self</span>, ErrorForbidden},
|
||||
http::StatusCode,
|
||||
test::TestRequest,
|
||||
web, App, HttpResponse,
|
||||
};
|
||||
|
||||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::extractors</span>::{<span class="ident">basic::BasicAuth</span>, <span class="ident">bearer::BearerAuth</span>};
|
||||
<span class="kw">use super</span>::<span class="kw-2">*</span>;
|
||||
<span class="kw">use </span><span class="kw">crate</span>::extractors::{basic::BasicAuth, bearer::BearerAuth};
|
||||
|
||||
<span class="doccomment">/// This is a test for https://github.com/actix/actix-extras/issues/10</span>
|
||||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">test_middleware_panic</span>() {
|
||||
<span class="kw">let</span> <span class="ident">middleware</span> <span class="op">=</span> <span class="ident">AuthenticationMiddleware</span> {
|
||||
<span class="ident">service</span>: <span class="ident">Rc::new</span>(<span class="ident">into_service</span>(<span class="op">|</span><span class="kw">_</span>: <span class="ident">ServiceRequest</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="ident">actix_web::rt::time::sleep</span>(<span class="ident">std::time::Duration::from_secs</span>(<span class="number">1</span>)).<span class="kw">await</span>;
|
||||
<span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">ServiceResponse</span>, <span class="kw">_</span><span class="op">></span>(<span class="ident">error::ErrorBadRequest</span>(<span class="string">"error"</span>))
|
||||
<span class="doccomment">/// This is a test for https://github.com/actix/actix-extras/issues/10
|
||||
</span><span class="attribute">#[actix_web::test]
|
||||
</span><span class="kw">async fn </span>test_middleware_panic() {
|
||||
<span class="kw">let </span>middleware = AuthenticationMiddleware {
|
||||
service: Rc::new(into_service(|<span class="kw">_</span>: ServiceRequest| <span class="kw">async move </span>{
|
||||
actix_web::rt::time::sleep(std::time::Duration::from_secs(<span class="number">1</span>)).<span class="kw">await</span>;
|
||||
<span class="prelude-val">Err</span>::<ServiceResponse, <span class="kw">_</span>>(error::ErrorBadRequest(<span class="string">"error"</span>))
|
||||
})),
|
||||
<span class="ident">process_fn</span>: <span class="ident">Arc::new</span>(<span class="op">|</span><span class="ident">req</span>, <span class="kw">_</span>: <span class="ident">BearerAuth</span><span class="op">|</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>(<span class="ident">req</span>) }),
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span>,
|
||||
process_fn: Arc::new(|req, <span class="kw">_</span>: BearerAuth| <span class="kw">async </span>{ <span class="prelude-val">Ok</span>(req) }),
|
||||
_extractor: PhantomData,
|
||||
};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest::get</span>()
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.<span class="ident">to_srv_request</span>();
|
||||
<span class="kw">let </span>req = TestRequest::get()
|
||||
.append_header((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.to_srv_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">middleware</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>f = middleware.call(req).<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">_res</span> <span class="op">=</span> <span class="ident">futures_util::future::lazy</span>(<span class="op">|</span><span class="ident">cx</span><span class="op">|</span> <span class="ident">middleware</span>.<span class="ident">poll_ready</span>(<span class="ident">cx</span>)).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>_res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).<span class="kw">await</span>;
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">f</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(f.is_err());
|
||||
}
|
||||
|
||||
<span class="doccomment">/// This is a test for https://github.com/actix/actix-extras/issues/10</span>
|
||||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">test_middleware_panic_several_orders</span>() {
|
||||
<span class="kw">let</span> <span class="ident">middleware</span> <span class="op">=</span> <span class="ident">AuthenticationMiddleware</span> {
|
||||
<span class="ident">service</span>: <span class="ident">Rc::new</span>(<span class="ident">into_service</span>(<span class="op">|</span><span class="kw">_</span>: <span class="ident">ServiceRequest</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="ident">actix_web::rt::time::sleep</span>(<span class="ident">std::time::Duration::from_secs</span>(<span class="number">1</span>)).<span class="kw">await</span>;
|
||||
<span class="prelude-val">Err</span>::<span class="op"><</span><span class="ident">ServiceResponse</span>, <span class="kw">_</span><span class="op">></span>(<span class="ident">error::ErrorBadRequest</span>(<span class="string">"error"</span>))
|
||||
<span class="doccomment">/// This is a test for https://github.com/actix/actix-extras/issues/10
|
||||
</span><span class="attribute">#[actix_web::test]
|
||||
</span><span class="kw">async fn </span>test_middleware_panic_several_orders() {
|
||||
<span class="kw">let </span>middleware = AuthenticationMiddleware {
|
||||
service: Rc::new(into_service(|<span class="kw">_</span>: ServiceRequest| <span class="kw">async move </span>{
|
||||
actix_web::rt::time::sleep(std::time::Duration::from_secs(<span class="number">1</span>)).<span class="kw">await</span>;
|
||||
<span class="prelude-val">Err</span>::<ServiceResponse, <span class="kw">_</span>>(error::ErrorBadRequest(<span class="string">"error"</span>))
|
||||
})),
|
||||
<span class="ident">process_fn</span>: <span class="ident">Arc::new</span>(<span class="op">|</span><span class="ident">req</span>, <span class="kw">_</span>: <span class="ident">BearerAuth</span><span class="op">|</span> <span class="kw">async</span> { <span class="prelude-val">Ok</span>(<span class="ident">req</span>) }),
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span>,
|
||||
process_fn: Arc::new(|req, <span class="kw">_</span>: BearerAuth| <span class="kw">async </span>{ <span class="prelude-val">Ok</span>(req) }),
|
||||
_extractor: PhantomData,
|
||||
};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest::get</span>()
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.<span class="ident">to_srv_request</span>();
|
||||
<span class="kw">let </span>req = TestRequest::get()
|
||||
.append_header((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.to_srv_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">f1</span> <span class="op">=</span> <span class="ident">middleware</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>f1 = middleware.call(req).<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest::get</span>()
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.<span class="ident">to_srv_request</span>();
|
||||
<span class="kw">let </span>req = TestRequest::get()
|
||||
.append_header((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.to_srv_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">f2</span> <span class="op">=</span> <span class="ident">middleware</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>f2 = middleware.call(req).<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest::get</span>()
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.<span class="ident">to_srv_request</span>();
|
||||
<span class="kw">let </span>req = TestRequest::get()
|
||||
.append_header((<span class="string">"Authorization"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.to_srv_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">f3</span> <span class="op">=</span> <span class="ident">middleware</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>f3 = middleware.call(req).<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">_res</span> <span class="op">=</span> <span class="ident">futures_util::future::lazy</span>(<span class="op">|</span><span class="ident">cx</span><span class="op">|</span> <span class="ident">middleware</span>.<span class="ident">poll_ready</span>(<span class="ident">cx</span>)).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>_res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).<span class="kw">await</span>;
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">f1</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">f2</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(<span class="ident">f3</span>.<span class="ident">is_err</span>());
|
||||
<span class="macro">assert!</span>(f1.is_err());
|
||||
<span class="macro">assert!</span>(f2.is_err());
|
||||
<span class="macro">assert!</span>(f3.is_err());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">test_middleware_opt_extractor</span>() {
|
||||
<span class="kw">let</span> <span class="ident">middleware</span> <span class="op">=</span> <span class="ident">AuthenticationMiddleware</span> {
|
||||
<span class="ident">service</span>: <span class="ident">Rc::new</span>(<span class="ident">into_service</span>(<span class="op">|</span><span class="ident">req</span>: <span class="ident">ServiceRequest</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">ServiceResponse</span>, <span class="kw">_</span><span class="op">></span>(<span class="ident">req</span>.<span class="ident">into_response</span>(<span class="ident">HttpResponse::Ok</span>().<span class="ident">finish</span>()))
|
||||
<span class="attribute">#[actix_web::test]
|
||||
</span><span class="kw">async fn </span>test_middleware_opt_extractor() {
|
||||
<span class="kw">let </span>middleware = AuthenticationMiddleware {
|
||||
service: Rc::new(into_service(|req: ServiceRequest| <span class="kw">async move </span>{
|
||||
<span class="prelude-val">Ok</span>::<ServiceResponse, <span class="kw">_</span>>(req.into_response(HttpResponse::Ok().finish()))
|
||||
})),
|
||||
<span class="ident">process_fn</span>: <span class="ident">Arc::new</span>(<span class="op">|</span><span class="ident">req</span>, <span class="ident">auth</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">BearerAuth</span><span class="op">></span><span class="op">|</span> {
|
||||
<span class="macro">assert!</span>(<span class="ident">auth</span>.<span class="ident">is_none</span>());
|
||||
<span class="kw">async</span> { <span class="prelude-val">Ok</span>(<span class="ident">req</span>) }
|
||||
process_fn: Arc::new(|req, auth: <span class="prelude-ty">Option</span><BearerAuth>| {
|
||||
<span class="macro">assert!</span>(auth.is_none());
|
||||
<span class="kw">async </span>{ <span class="prelude-val">Ok</span>(req) }
|
||||
}),
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span>,
|
||||
_extractor: PhantomData,
|
||||
};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest::get</span>()
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization996"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.<span class="ident">to_srv_request</span>();
|
||||
<span class="kw">let </span>req = TestRequest::get()
|
||||
.append_header((<span class="string">"Authorization996"</span>, <span class="string">"Bearer 1"</span>))
|
||||
.to_srv_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">middleware</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>f = middleware.call(req).<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">_res</span> <span class="op">=</span> <span class="ident">futures_util::future::lazy</span>(<span class="op">|</span><span class="ident">cx</span><span class="op">|</span> <span class="ident">middleware</span>.<span class="ident">poll_ready</span>(<span class="ident">cx</span>)).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>_res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).<span class="kw">await</span>;
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">f</span>.<span class="ident">is_ok</span>());
|
||||
<span class="macro">assert!</span>(f.is_ok());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">test_middleware_res_extractor</span>() {
|
||||
<span class="kw">let</span> <span class="ident">middleware</span> <span class="op">=</span> <span class="ident">AuthenticationMiddleware</span> {
|
||||
<span class="ident">service</span>: <span class="ident">Rc::new</span>(<span class="ident">into_service</span>(<span class="op">|</span><span class="ident">req</span>: <span class="ident">ServiceRequest</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> {
|
||||
<span class="prelude-val">Ok</span>::<span class="op"><</span><span class="ident">ServiceResponse</span>, <span class="kw">_</span><span class="op">></span>(<span class="ident">req</span>.<span class="ident">into_response</span>(<span class="ident">HttpResponse::Ok</span>().<span class="ident">finish</span>()))
|
||||
<span class="attribute">#[actix_web::test]
|
||||
</span><span class="kw">async fn </span>test_middleware_res_extractor() {
|
||||
<span class="kw">let </span>middleware = AuthenticationMiddleware {
|
||||
service: Rc::new(into_service(|req: ServiceRequest| <span class="kw">async move </span>{
|
||||
<span class="prelude-val">Ok</span>::<ServiceResponse, <span class="kw">_</span>>(req.into_response(HttpResponse::Ok().finish()))
|
||||
})),
|
||||
<span class="ident">process_fn</span>: <span class="ident">Arc::new</span>(
|
||||
<span class="op">|</span><span class="ident">req</span>, <span class="ident">auth</span>: <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">BearerAuth</span>, <span class="op"><</span><span class="ident">BearerAuth</span> <span class="kw">as</span> <span class="ident">FromRequest</span><span class="op">></span><span class="ident">::Error</span><span class="op">></span><span class="op">|</span> {
|
||||
<span class="macro">assert!</span>(<span class="ident">auth</span>.<span class="ident">is_err</span>());
|
||||
<span class="kw">async</span> { <span class="prelude-val">Ok</span>(<span class="ident">req</span>) }
|
||||
process_fn: Arc::new(
|
||||
|req, auth: <span class="prelude-ty">Result</span><BearerAuth, <BearerAuth <span class="kw">as </span>FromRequest>::Error>| {
|
||||
<span class="macro">assert!</span>(auth.is_err());
|
||||
<span class="kw">async </span>{ <span class="prelude-val">Ok</span>(req) }
|
||||
},
|
||||
),
|
||||
<span class="ident">_extractor</span>: <span class="ident">PhantomData</span>,
|
||||
_extractor: PhantomData,
|
||||
};
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">TestRequest::get</span>()
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization"</span>, <span class="string">"BearerLOL"</span>))
|
||||
.<span class="ident">to_srv_request</span>();
|
||||
<span class="kw">let </span>req = TestRequest::get()
|
||||
.append_header((<span class="string">"Authorization"</span>, <span class="string">"BearerLOL"</span>))
|
||||
.to_srv_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">middleware</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>f = middleware.call(req).<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">_res</span> <span class="op">=</span> <span class="ident">futures_util::future::lazy</span>(<span class="op">|</span><span class="ident">cx</span><span class="op">|</span> <span class="ident">middleware</span>.<span class="ident">poll_ready</span>(<span class="ident">cx</span>)).<span class="kw">await</span>;
|
||||
<span class="kw">let </span>_res = futures_util::future::lazy(|cx| middleware.poll_ready(cx)).<span class="kw">await</span>;
|
||||
|
||||
<span class="macro">assert!</span>(<span class="ident">f</span>.<span class="ident">is_ok</span>());
|
||||
<span class="macro">assert!</span>(f.is_ok());
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">test_middleware_works_with_app</span>() {
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">validator</span>(
|
||||
<span class="ident">req</span>: <span class="ident">ServiceRequest</span>,
|
||||
<span class="ident">_credentials</span>: <span class="ident">BasicAuth</span>,
|
||||
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ServiceRequest</span>, (<span class="ident">actix_web::Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span> {
|
||||
<span class="prelude-val">Err</span>((<span class="ident">ErrorForbidden</span>(<span class="string">"You are not welcome!"</span>), <span class="ident">req</span>))
|
||||
<span class="attribute">#[actix_web::test]
|
||||
</span><span class="kw">async fn </span>test_middleware_works_with_app() {
|
||||
<span class="kw">async fn </span>validator(
|
||||
req: ServiceRequest,
|
||||
_credentials: BasicAuth,
|
||||
) -> <span class="prelude-ty">Result</span><ServiceRequest, (actix_web::Error, ServiceRequest)> {
|
||||
<span class="prelude-val">Err</span>((ErrorForbidden(<span class="string">"You are not welcome!"</span>), req))
|
||||
}
|
||||
<span class="kw">let</span> <span class="ident">middleware</span> <span class="op">=</span> <span class="ident">HttpAuthentication::basic</span>(<span class="ident">validator</span>);
|
||||
<span class="kw">let </span>middleware = HttpAuthentication::basic(validator);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">srv</span> <span class="op">=</span> <span class="ident">actix_web::test::init_service</span>(
|
||||
<span class="ident">App::new</span>()
|
||||
.<span class="ident">wrap</span>(<span class="ident">middleware</span>)
|
||||
.<span class="ident">route</span>(<span class="string">"/"</span>, <span class="ident">web::get</span>().<span class="ident">to</span>(<span class="ident">HttpResponse::Ok</span>)),
|
||||
<span class="kw">let </span>srv = actix_web::test::init_service(
|
||||
App::new()
|
||||
.wrap(middleware)
|
||||
.route(<span class="string">"/"</span>, web::get().to(HttpResponse::Ok)),
|
||||
)
|
||||
.<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">actix_web::test::TestRequest::with_uri</span>(<span class="string">"/"</span>)
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization"</span>, <span class="string">"Basic DontCare"</span>))
|
||||
.<span class="ident">to_request</span>();
|
||||
<span class="kw">let </span>req = actix_web::test::TestRequest::with_uri(<span class="string">"/"</span>)
|
||||
.append_header((<span class="string">"Authorization"</span>, <span class="string">"Basic DontCare"</span>))
|
||||
.to_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">srv</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode::UNAUTHORIZED</span>);
|
||||
<span class="kw">let </span>resp = srv.call(req).<span class="kw">await</span>.unwrap();
|
||||
<span class="macro">assert_eq!</span>(resp.status(), StatusCode::UNAUTHORIZED);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">actix_web::test</span>]</span>
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">test_middleware_works_with_scope</span>() {
|
||||
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">validator</span>(
|
||||
<span class="ident">req</span>: <span class="ident">ServiceRequest</span>,
|
||||
<span class="ident">_credentials</span>: <span class="ident">BasicAuth</span>,
|
||||
) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">ServiceRequest</span>, (<span class="ident">actix_web::Error</span>, <span class="ident">ServiceRequest</span>)<span class="op">></span> {
|
||||
<span class="prelude-val">Err</span>((<span class="ident">ErrorForbidden</span>(<span class="string">"You are not welcome!"</span>), <span class="ident">req</span>))
|
||||
<span class="attribute">#[actix_web::test]
|
||||
</span><span class="kw">async fn </span>test_middleware_works_with_scope() {
|
||||
<span class="kw">async fn </span>validator(
|
||||
req: ServiceRequest,
|
||||
_credentials: BasicAuth,
|
||||
) -> <span class="prelude-ty">Result</span><ServiceRequest, (actix_web::Error, ServiceRequest)> {
|
||||
<span class="prelude-val">Err</span>((ErrorForbidden(<span class="string">"You are not welcome!"</span>), req))
|
||||
}
|
||||
<span class="kw">let</span> <span class="ident">middleware</span> <span class="op">=</span> <span class="ident">actix_web::middleware::Compat::new</span>(<span class="ident">HttpAuthentication::basic</span>(<span class="ident">validator</span>));
|
||||
<span class="kw">let </span>middleware = actix_web::middleware::Compat::new(HttpAuthentication::basic(validator));
|
||||
|
||||
<span class="kw">let</span> <span class="ident">srv</span> <span class="op">=</span> <span class="ident">actix_web::test::init_service</span>(
|
||||
<span class="ident">App::new</span>().<span class="ident">service</span>(
|
||||
<span class="ident">web::scope</span>(<span class="string">"/"</span>)
|
||||
.<span class="ident">wrap</span>(<span class="ident">middleware</span>)
|
||||
.<span class="ident">route</span>(<span class="string">"/"</span>, <span class="ident">web::get</span>().<span class="ident">to</span>(<span class="ident">HttpResponse::Ok</span>)),
|
||||
<span class="kw">let </span>srv = actix_web::test::init_service(
|
||||
App::new().service(
|
||||
web::scope(<span class="string">"/"</span>)
|
||||
.wrap(middleware)
|
||||
.route(<span class="string">"/"</span>, web::get().to(HttpResponse::Ok)),
|
||||
),
|
||||
)
|
||||
.<span class="kw">await</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">actix_web::test::TestRequest::with_uri</span>(<span class="string">"/"</span>)
|
||||
.<span class="ident">append_header</span>((<span class="string">"Authorization"</span>, <span class="string">"Basic DontCare"</span>))
|
||||
.<span class="ident">to_request</span>();
|
||||
<span class="kw">let </span>req = actix_web::test::TestRequest::with_uri(<span class="string">"/"</span>)
|
||||
.append_header((<span class="string">"Authorization"</span>, <span class="string">"Basic DontCare"</span>))
|
||||
.to_request();
|
||||
|
||||
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">srv</span>.<span class="ident">call</span>(<span class="ident">req</span>).<span class="kw">await</span>.<span class="ident">unwrap</span>();
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode::UNAUTHORIZED</span>);
|
||||
<span class="kw">let </span>resp = srv.call(req).<span class="kw">await</span>.unwrap();
|
||||
<span class="macro">assert_eq!</span>(resp.status(), StatusCode::UNAUTHORIZED);
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
@@ -110,117 +110,117 @@
|
||||
<span id="110">110</span>
|
||||
<span id="111">111</span>
|
||||
<span id="112">112</span>
|
||||
</pre><pre class="rust"><code><span class="kw">use</span> <span class="ident">std::str</span>;
|
||||
</pre><pre class="rust"><code><span class="kw">use </span>std::str;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web::web::BytesMut</span>;
|
||||
<span class="kw">use </span>actix_web::web::BytesMut;
|
||||
|
||||
<span class="kw">enum</span> <span class="ident">State</span> {
|
||||
<span class="ident">YieldStr</span>,
|
||||
<span class="ident">YieldQuote</span>,
|
||||
<span class="kw">enum </span>State {
|
||||
YieldStr,
|
||||
YieldQuote,
|
||||
}
|
||||
|
||||
<span class="kw">struct</span> <span class="ident">Quoted</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="ident">inner</span>: <span class="ident">::std::iter::Peekable</span><span class="op"><</span><span class="ident">str::Split</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">char</span><span class="op">></span><span class="op">></span>,
|
||||
<span class="ident">state</span>: <span class="ident">State</span>,
|
||||
<span class="kw">struct </span>Quoted<<span class="lifetime">'a</span>> {
|
||||
inner: ::std::iter::Peekable<str::Split<<span class="lifetime">'a</span>, char>>,
|
||||
state: State,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Quoted</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">s</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>) -> <span class="ident">Quoted</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span> {
|
||||
<span class="ident">Quoted</span> {
|
||||
<span class="ident">inner</span>: <span class="ident">s</span>.<span class="ident">split</span>(<span class="string">'"'</span>).<span class="ident">peekable</span>(),
|
||||
<span class="ident">state</span>: <span class="ident">State::YieldStr</span>,
|
||||
<span class="kw">impl</span><<span class="lifetime">'a</span>> Quoted<<span class="lifetime">'a</span>> {
|
||||
<span class="kw">pub fn </span>new(s: <span class="kw-2">&</span><span class="lifetime">'a </span>str) -> Quoted<<span class="lifetime">'_</span>> {
|
||||
Quoted {
|
||||
inner: s.split(<span class="string">'"'</span>).peekable(),
|
||||
state: State::YieldStr,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> <span class="ident">Iterator</span> <span class="kw">for</span> <span class="ident">Quoted</span><span class="op"><</span><span class="lifetime">'a</span><span class="op">></span> {
|
||||
<span class="kw">type</span> <span class="ident">Item</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">str</span>;
|
||||
<span class="kw">impl</span><<span class="lifetime">'a</span>> Iterator <span class="kw">for </span>Quoted<<span class="lifetime">'a</span>> {
|
||||
<span class="kw">type </span>Item = <span class="kw-2">&</span><span class="lifetime">'a </span>str;
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">next</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident"><span class="self">Self</span>::Item</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">state</span> {
|
||||
<span class="ident">State::YieldStr</span> => <span class="kw">match</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">next</span>() {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">val</span>) => {
|
||||
<span class="self">self</span>.<span class="ident">state</span> <span class="op">=</span> <span class="ident">State::YieldQuote</span>;
|
||||
<span class="prelude-val">Some</span>(<span class="ident">val</span>)
|
||||
<span class="kw">fn </span>next(<span class="kw-2">&mut </span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="self">Self</span>::Item> {
|
||||
<span class="kw">match </span><span class="self">self</span>.state {
|
||||
State::YieldStr => <span class="kw">match </span><span class="self">self</span>.inner.next() {
|
||||
<span class="prelude-val">Some</span>(val) => {
|
||||
<span class="self">self</span>.state = State::YieldQuote;
|
||||
<span class="prelude-val">Some</span>(val)
|
||||
}
|
||||
<span class="prelude-val">None</span> => <span class="prelude-val">None</span>,
|
||||
<span class="prelude-val">None </span>=> <span class="prelude-val">None</span>,
|
||||
},
|
||||
|
||||
<span class="ident">State::YieldQuote</span> => <span class="kw">match</span> <span class="self">self</span>.<span class="ident">inner</span>.<span class="ident">peek</span>() {
|
||||
State::YieldQuote => <span class="kw">match </span><span class="self">self</span>.inner.peek() {
|
||||
<span class="prelude-val">Some</span>(<span class="kw">_</span>) => {
|
||||
<span class="self">self</span>.<span class="ident">state</span> <span class="op">=</span> <span class="ident">State::YieldStr</span>;
|
||||
<span class="self">self</span>.state = State::YieldStr;
|
||||
<span class="prelude-val">Some</span>(<span class="string">"\\\""</span>)
|
||||
}
|
||||
<span class="prelude-val">None</span> => <span class="prelude-val">None</span>,
|
||||
<span class="prelude-val">None </span>=> <span class="prelude-val">None</span>,
|
||||
},
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Escapes the quotes in `val`.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">put_quoted</span>(<span class="ident">buf</span>: <span class="kw-2">&mut</span> <span class="ident">BytesMut</span>, <span class="ident">val</span>: <span class="kw-2">&</span><span class="ident">str</span>) {
|
||||
<span class="kw">for</span> <span class="ident">part</span> <span class="kw">in</span> <span class="ident">Quoted::new</span>(<span class="ident">val</span>) {
|
||||
<span class="ident">buf</span>.<span class="ident">extend_from_slice</span>(<span class="ident">part</span>.<span class="ident">as_bytes</span>());
|
||||
<span class="doccomment">/// Escapes the quotes in `val`.
|
||||
</span><span class="kw">pub fn </span>put_quoted(buf: <span class="kw-2">&mut </span>BytesMut, val: <span class="kw-2">&</span>str) {
|
||||
<span class="kw">for </span>part <span class="kw">in </span>Quoted::new(val) {
|
||||
buf.extend_from_slice(part.as_bytes());
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="ident">std::str</span>;
|
||||
<span class="attribute">#[cfg(test)]
|
||||
</span><span class="kw">mod </span>tests {
|
||||
<span class="kw">use </span>std::str;
|
||||
|
||||
<span class="kw">use</span> <span class="ident">actix_web::web::BytesMut</span>;
|
||||
<span class="kw">use </span>actix_web::web::BytesMut;
|
||||
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::put_quoted</span>;
|
||||
<span class="kw">use </span><span class="kw">super</span>::put_quoted;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_quote_str</span>() {
|
||||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"a \"quoted\" string"</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">BytesMut::new</span>();
|
||||
<span class="ident">put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">output</span>, <span class="ident">input</span>);
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">output</span>).<span class="ident">unwrap</span>();
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_quote_str() {
|
||||
<span class="kw">let </span>input = <span class="string">"a \"quoted\" string"</span>;
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>output = BytesMut::new();
|
||||
put_quoted(<span class="kw-2">&mut </span>output, input);
|
||||
<span class="kw">let </span>result = str::from_utf8(<span class="kw-2">&</span>output).unwrap();
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>, <span class="string">"a \\\"quoted\\\" string"</span>);
|
||||
<span class="macro">assert_eq!</span>(result, <span class="string">"a \\\"quoted\\\" string"</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_without_quotes</span>() {
|
||||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"non-quoted string"</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">BytesMut::new</span>();
|
||||
<span class="ident">put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">output</span>, <span class="ident">input</span>);
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">output</span>).<span class="ident">unwrap</span>();
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_without_quotes() {
|
||||
<span class="kw">let </span>input = <span class="string">"non-quoted string"</span>;
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>output = BytesMut::new();
|
||||
put_quoted(<span class="kw-2">&mut </span>output, input);
|
||||
<span class="kw">let </span>result = str::from_utf8(<span class="kw-2">&</span>output).unwrap();
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>, <span class="string">"non-quoted string"</span>);
|
||||
<span class="macro">assert_eq!</span>(result, <span class="string">"non-quoted string"</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_starts_with_quote</span>() {
|
||||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"\"first-quoted string"</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">BytesMut::new</span>();
|
||||
<span class="ident">put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">output</span>, <span class="ident">input</span>);
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">output</span>).<span class="ident">unwrap</span>();
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_starts_with_quote() {
|
||||
<span class="kw">let </span>input = <span class="string">"\"first-quoted string"</span>;
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>output = BytesMut::new();
|
||||
put_quoted(<span class="kw-2">&mut </span>output, input);
|
||||
<span class="kw">let </span>result = str::from_utf8(<span class="kw-2">&</span>output).unwrap();
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>, <span class="string">"\\\"first-quoted string"</span>);
|
||||
<span class="macro">assert_eq!</span>(result, <span class="string">"\\\"first-quoted string"</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_ends_with_quote</span>() {
|
||||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"last-quoted string\""</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">BytesMut::new</span>();
|
||||
<span class="ident">put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">output</span>, <span class="ident">input</span>);
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">output</span>).<span class="ident">unwrap</span>();
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_ends_with_quote() {
|
||||
<span class="kw">let </span>input = <span class="string">"last-quoted string\""</span>;
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>output = BytesMut::new();
|
||||
put_quoted(<span class="kw-2">&mut </span>output, input);
|
||||
<span class="kw">let </span>result = str::from_utf8(<span class="kw-2">&</span>output).unwrap();
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>, <span class="string">"last-quoted string\\\""</span>);
|
||||
<span class="macro">assert_eq!</span>(result, <span class="string">"last-quoted string\\\""</span>);
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_double_quote</span>() {
|
||||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="string">"quote\"\"string"</span>;
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">output</span> <span class="op">=</span> <span class="ident">BytesMut::new</span>();
|
||||
<span class="ident">put_quoted</span>(<span class="kw-2">&mut</span> <span class="ident">output</span>, <span class="ident">input</span>);
|
||||
<span class="kw">let</span> <span class="ident">result</span> <span class="op">=</span> <span class="ident">str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">output</span>).<span class="ident">unwrap</span>();
|
||||
<span class="attribute">#[test]
|
||||
</span><span class="kw">fn </span>test_double_quote() {
|
||||
<span class="kw">let </span>input = <span class="string">"quote\"\"string"</span>;
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>output = BytesMut::new();
|
||||
put_quoted(<span class="kw-2">&mut </span>output, input);
|
||||
<span class="kw">let </span>result = str::from_utf8(<span class="kw-2">&</span>output).unwrap();
|
||||
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">result</span>, <span class="string">"quote\\\"\\\"string"</span>);
|
||||
<span class="macro">assert_eq!</span>(result, <span class="string">"quote\\\"\\\"string"</span>);
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (34a6cae28 2022-08-09)" ></div></body></html>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_web_httpauth" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>
|
||||
Reference in New Issue
Block a user