<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `actix-web-httpauth/src/extractors/basic.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>basic.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../../actix_web_httpauth/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../actix_web_httpauth/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../actix_web_httpauth/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span> <span id="2">2</span> <span id="3">3</span> <span id="4">4</span> <span id="5">5</span> <span id="6">6</span> <span id="7">7</span> <span id="8">8</span> <span id="9">9</span> <span id="10">10</span> <span id="11">11</span> <span id="12">12</span> <span id="13">13</span> <span id="14">14</span> <span id="15">15</span> <span id="16">16</span> <span id="17">17</span> <span id="18">18</span> <span id="19">19</span> <span id="20">20</span> <span id="21">21</span> <span id="22">22</span> <span id="23">23</span> <span id="24">24</span> <span id="25">25</span> <span id="26">26</span> <span id="27">27</span> <span id="28">28</span> <span id="29">29</span> <span id="30">30</span> <span id="31">31</span> <span id="32">32</span> <span id="33">33</span> <span id="34">34</span> <span id="35">35</span> <span id="36">36</span> <span id="37">37</span> <span id="38">38</span> <span id="39">39</span> <span id="40">40</span> <span id="41">41</span> <span id="42">42</span> <span id="43">43</span> <span id="44">44</span> <span id="45">45</span> <span id="46">46</span> <span id="47">47</span> <span id="48">48</span> <span id="49">49</span> <span id="50">50</span> <span id="51">51</span> <span id="52">52</span> <span id="53">53</span> <span id="54">54</span> <span id="55">55</span> <span id="56">56</span> <span id="57">57</span> <span id="58">58</span> <span id="59">59</span> <span id="60">60</span> <span id="61">61</span> <span id="62">62</span> <span id="63">63</span> <span id="64">64</span> <span id="65">65</span> <span id="66">66</span> <span id="67">67</span> <span id="68">68</span> <span id="69">69</span> <span id="70">70</span> <span id="71">71</span> <span id="72">72</span> <span id="73">73</span> <span id="74">74</span> <span id="75">75</span> <span id="76">76</span> <span id="77">77</span> <span id="78">78</span> <span id="79">79</span> <span id="80">80</span> <span id="81">81</span> <span id="82">82</span> <span id="83">83</span> <span id="84">84</span> <span id="85">85</span> <span id="86">86</span> <span id="87">87</span> <span id="88">88</span> <span id="89">89</span> <span id="90">90</span> <span id="91">91</span> <span id="92">92</span> <span id="93">93</span> <span id="94">94</span> <span id="95">95</span> <span id="96">96</span> <span id="97">97</span> <span id="98">98</span> <span id="99">99</span> <span id="100">100</span> <span id="101">101</span> <span id="102">102</span> <span id="103">103</span> <span id="104">104</span> <span id="105">105</span> <span id="106">106</span> <span id="107">107</span> <span id="108">108</span> <span id="109">109</span> <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> <span class="kw">use</span> <span class="ident">std::borrow::Cow</span>; <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> <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="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="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="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="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> <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> <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 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>) }), ) } } </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 (d394408fb 2022-08-07)" ></div></body></html>