<!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/middleware.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>middleware.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 src="../../crates.js"></script><script defer src="../../main.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.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"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></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> <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> <span id="196">196</span> <span id="197">197</span> <span id="198">198</span> <span id="199">199</span> <span id="200">200</span> <span id="201">201</span> <span id="202">202</span> <span id="203">203</span> <span id="204">204</span> <span id="205">205</span> <span id="206">206</span> <span id="207">207</span> <span id="208">208</span> <span id="209">209</span> <span id="210">210</span> <span id="211">211</span> <span id="212">212</span> <span id="213">213</span> <span id="214">214</span> <span id="215">215</span> <span id="216">216</span> <span id="217">217</span> <span id="218">218</span> <span id="219">219</span> <span id="220">220</span> <span id="221">221</span> <span id="222">222</span> <span id="223">223</span> <span id="224">224</span> <span id="225">225</span> <span id="226">226</span> <span id="227">227</span> <span id="228">228</span> <span id="229">229</span> <span id="230">230</span> <span id="231">231</span> <span id="232">232</span> <span id="233">233</span> <span id="234">234</span> <span id="235">235</span> <span id="236">236</span> <span id="237">237</span> <span id="238">238</span> <span id="239">239</span> <span id="240">240</span> <span id="241">241</span> <span id="242">242</span> <span id="243">243</span> <span id="244">244</span> <span id="245">245</span> <span id="246">246</span> <span id="247">247</span> <span id="248">248</span> <span id="249">249</span> <span id="250">250</span> <span id="251">251</span> <span id="252">252</span> <span id="253">253</span> <span id="254">254</span> <span id="255">255</span> <span id="256">256</span> <span id="257">257</span> <span id="258">258</span> <span id="259">259</span> <span id="260">260</span> <span id="261">261</span> <span id="262">262</span> <span id="263">263</span> <span id="264">264</span> <span id="265">265</span> <span id="266">266</span> <span id="267">267</span> <span id="268">268</span> <span id="269">269</span> <span id="270">270</span> <span id="271">271</span> <span id="272">272</span> <span id="273">273</span> <span id="274">274</span> <span id="275">275</span> <span id="276">276</span> <span id="277">277</span> <span id="278">278</span> <span id="279">279</span> <span id="280">280</span> <span id="281">281</span> <span id="282">282</span> <span id="283">283</span> <span id="284">284</span> <span id="285">285</span> <span id="286">286</span> <span id="287">287</span> <span id="288">288</span> <span id="289">289</span> <span id="290">290</span> <span id="291">291</span> <span id="292">292</span> <span id="293">293</span> <span id="294">294</span> <span id="295">295</span> <span id="296">296</span> <span id="297">297</span> <span id="298">298</span> <span id="299">299</span> <span id="300">300</span> <span id="301">301</span> <span id="302">302</span> <span id="303">303</span> <span id="304">304</span> <span id="305">305</span> <span id="306">306</span> <span id="307">307</span> <span id="308">308</span> <span id="309">309</span> <span id="310">310</span> <span id="311">311</span> <span id="312">312</span> <span id="313">313</span> <span id="314">314</span> <span id="315">315</span> <span id="316">316</span> <span id="317">317</span> <span id="318">318</span> <span id="319">319</span> <span id="320">320</span> <span id="321">321</span> <span id="322">322</span> <span id="323">323</span> <span id="324">324</span> <span id="325">325</span> <span id="326">326</span> <span id="327">327</span> <span id="328">328</span> <span id="329">329</span> <span id="330">330</span> <span id="331">331</span> <span id="332">332</span> <span id="333">333</span> <span id="334">334</span> <span id="335">335</span> <span id="336">336</span> <span id="337">337</span> <span id="338">338</span> <span id="339">339</span> <span id="340">340</span> <span id="341">341</span> <span id="342">342</span> <span id="343">343</span> <span id="344">344</span> <span id="345">345</span> <span id="346">346</span> <span id="347">347</span> <span id="348">348</span> <span id="349">349</span> <span id="350">350</span> <span id="351">351</span> <span id="352">352</span> <span id="353">353</span> <span id="354">354</span> <span id="355">355</span> <span id="356">356</span> <span id="357">357</span> </pre><pre class="rust"><code><span class="doccomment">//! HTTP Authentication middleware.</span> <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 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="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">FutureExt</span> <span class="kw">as</span> <span class="kw">_</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> <span class="ident"><span class="kw">crate</span>::extractors</span>::{<span class="ident">basic</span>, <span class="ident">bearer</span>, <span class="ident">AuthExtractor</span>}; <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">AuthExtractor</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>, } <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">AuthExtractor</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="op">></span><span class="op">></span>, { <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="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="op">></span><span class="op">></span>, { <span class="doccomment">/// Construct `HttpAuthentication` middleware for the HTTP "Basic" authentication scheme.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Example</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// # use actix_web::Error;</span> <span class="doccomment">/// # use actix_web::dev::ServiceRequest;</span> <span class="doccomment">/// # use actix_web_httpauth::middleware::HttpAuthentication;</span> <span class="doccomment">/// # use actix_web_httpauth::extractors::basic::BasicAuth;</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> {</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="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="op">></span><span class="op">></span>, { <span class="doccomment">/// Construct `HttpAuthentication` middleware for the HTTP "Bearer" authentication scheme.</span> <span class="doccomment">///</span> <span class="doccomment">/// # Example</span> <span class="doccomment">/// ```</span> <span class="doccomment">/// # use actix_web::Error;</span> <span class="doccomment">/// # use actix_web::dev::ServiceRequest;</span> <span class="doccomment">/// # use actix_web_httpauth::middleware::HttpAuthentication;</span> <span class="doccomment">/// # use actix_web_httpauth::extractors::bearer::{Config, BearerAuth};</span> <span class="doccomment">/// # use actix_web_httpauth::extractors::{AuthenticationError, AuthExtractorConfig};</span> <span class="doccomment">/// async fn validator(req: ServiceRequest, credentials: BearerAuth) -> Result<ServiceRequest, Error> {</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::<Config>()</span> <span class="doccomment">/// .map(|data| data.clone())</span> <span class="doccomment">/// .unwrap_or_else(Default::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())</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="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="op">></span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'static</span>, <span class="ident">T</span>: <span class="ident">AuthExtractor</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">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">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="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">AuthExtractor</span>, { <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>, } <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="op">></span><span class="op">></span> <span class="op">+</span> <span class="lifetime">'static</span>, <span class="ident">T</span>: <span class="ident">AuthExtractor</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">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="macro">actix_service::forward_ready!</span>(<span class="ident">service</span>); <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">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>()); } }; <span class="comment">// TODO: alter to remove ? operator; an error response is required for downstream</span> <span class="comment">// middleware to do their thing (eg. cors adding headers)</span> <span class="kw">let</span> <span class="ident">req</span> <span class="op">=</span> <span class="ident">process_fn</span>(<span class="ident">req</span>, <span class="ident">credentials</span>).<span class="kw">await</span><span class="question-mark">?</span>; <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>()) } .<span class="ident">boxed_local</span>() } } <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">f</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">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">f</span>: <span class="prelude-val">None</span>, <span class="ident">_extractor</span>: <span class="ident">PhantomData</span>, } } } <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">AuthExtractor</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">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">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">f</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_ref</span>().<span class="ident">expect</span>(<span class="string">"Extract future was polled twice!"</span>); <span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="ident">T::from_service_request</span>(<span class="ident">req</span>).<span class="ident">map_err</span>(<span class="ident">Into::into</span>); <span class="self">self</span>.<span class="ident">f</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">f</span>.<span class="ident">boxed_local</span>()); } <span class="kw">let</span> <span class="ident">f</span> <span class="op">=</span> <span class="self">self</span> .<span class="ident">f</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> <span class="ident">credentials</span> <span class="op">=</span> <span class="macro">ready!</span>(<span class="ident">f</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="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>), ) })<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="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="kw">use</span> <span class="ident"><span class="kw">crate</span>::extractors::bearer::BearerAuth</span>; <span class="kw">use</span> <span class="ident">actix_service</span>::{<span class="ident">into_service</span>, <span class="ident">Service</span>}; <span class="kw">use</span> <span class="ident">actix_web::test::TestRequest</span>; <span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">error</span>, <span class="ident">HttpResponse</span>}; <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="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>, }; <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> <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> <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="macro">assert!</span>(<span class="ident">f</span>.<span class="ident">is_err</span>()); } <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="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>, }; <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> <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> <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> <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> <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> <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> <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="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="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="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>) } }), <span class="ident">_extractor</span>: <span class="ident">PhantomData</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">"Authorization996"</span>, <span class="string">"Bearer 1"</span>)) .<span class="ident">to_srv_request</span>(); <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> <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="macro">assert!</span>(<span class="ident">f</span>.<span class="ident">is_ok</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_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="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">AuthExtractor</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>) } }, ), <span class="ident">_extractor</span>: <span class="ident">PhantomData</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">"BearerLOL"</span>)) .<span class="ident">to_srv_request</span>(); <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> <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="macro">assert!</span>(<span class="ident">f</span>.<span class="ident">is_ok</span>()); } } </code></pre></div> </section><section id="search" class="content hidden"></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.60.0-nightly (f624427f8 2022-02-06)" ></div> </body></html>