<!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/headers/authorization/scheme/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" href="../../../../../normalize.css"><link rel="stylesheet" href="../../../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../../../ayu.css" disabled><link rel="stylesheet" href="../../../../../dark.css" disabled><link rel="stylesheet" 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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../../../actix_web_httpauth/index.html"><img class="rust-logo" src="../../../../../rust-logo.svg" alt="logo"></a><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"><a href="../../../../../help.html">?</a></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><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<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>std::{borrow::Cow, fmt, str};
<span class="kw">use </span>actix_web::{
http::header::{HeaderValue, InvalidHeaderValue, TryIntoHeaderValue},
web::{BufMut, BytesMut},
};
<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">#[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>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>>,
{
Basic {
user_id: user_id.into(),
password: password.map(Into::into),
}
}
<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 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>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>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>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>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>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>(Basic { user_id, password })
}
}
<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>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>TryIntoHeaderValue <span class="kw">for </span>Basic {
<span class="kw">type </span>Error = InvalidHeaderValue;
<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()),
);
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
// 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());
HeaderValue::from_maybe_shared(value.freeze())
}
}
<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">#[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>(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">#[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>(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">#[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>(scheme.is_err());
}
<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>(scheme.is_err());
}
<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>(scheme.is_err());
}
<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>(scheme.is_err());
}
<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>result = basic.try_into_value();
<span class="macro">assert!</span>(result.is_ok());
<span class="macro">assert_eq!</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.66.0-nightly (0da281b60 2022-10-27)" ></div></body></html>