mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-02 21:16:37 +02:00
Deploying to gh-pages from @ 1e682e7a59 🚀
This commit is contained in:
robjtede
@@ -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>
|
||||
Reference in New Issue
Block a user