<!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/www_authenticate/challenge/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="../../../../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../../../static.files/rustdoc-eabf764633b9d7be.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../../../../static.files/light-777f3e9583f8c92d.css"><link rel="stylesheet" disabled href="../../../../../static.files/dark-e2f4109f2e82e3af.css"><link rel="stylesheet" disabled href="../../../../../static.files/ayu-c360e709a65bed99.css"><script id="default-settings" ></script><script src="../../../../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../../../../static.files/source-script-74087aa2e88f4475.js"></script><script defer src="../../../../../source-files.js"></script><script defer src="../../../../../static.files/main-c2d2a5dbaed13e6b.js"></script><noscript><link rel="stylesheet" href="../../../../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../../../static.files/favicon-2c020d218678b618.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="../../../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><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="../../../../../static.files/wheel-5ec35bf9ca753509.svg"></a></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>
</pre><pre class="rust"><code><span class="doccomment">//! Challenge for the "Basic" HTTP Authentication Scheme.
</span><span class="kw">use </span>std::{borrow::Cow, fmt, str};
<span class="kw">use </span>actix_web::{
http::header::{HeaderValue, InvalidHeaderValue, TryIntoHeaderValue},
web::{BufMut, Bytes, BytesMut},
};
<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,
/// 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="attr">#[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>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.
///
/// # 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>>,
{
Basic {
realm: <span class="prelude-val">Some</span>(value.into()),
}
}
}
<span class="attr">#[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>);
}
buffer.freeze()
}
}
<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>;
f.write_str(repr)
}
}
<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> {
HeaderValue::from_maybe_shared(<span class="self">self</span>.to_bytes())
}
}
<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attr">#[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>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="attr">#[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>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-static-root-path="../../../../../static.files/" data-current-crate="actix_web_httpauth" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.0-nightly (42325c525 2022-11-11)" data-search-js="search-39ee4160c7dc16c9.js" data-settings-js="settings-3a0b9947ba1bd99a.js" data-settings-css="settings-a66f7524084a489a.css" ></div></body></html>