<!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-identity/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 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_identity/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_identity/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_identity/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>
<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>
</pre><pre class="rust"><code><span class="kw">use </span>std::rc::Rc;
<span class="kw">use </span>actix_session::SessionExt;
<span class="kw">use </span>actix_utils::future::{ready, Ready};
<span class="kw">use </span>actix_web::{
body::MessageBody,
cookie::time::{format_description::well_known::Rfc3339, OffsetDateTime},
dev::{Service, ServiceRequest, ServiceResponse, Transform},
Error, HttpMessage <span class="kw">as _</span>, <span class="prelude-ty">Result</span>,
};
<span class="kw">use </span>futures_core::future::LocalBoxFuture;
<span class="kw">use crate</span>::{
config::{Configuration, IdentityMiddlewareBuilder},
identity::IdentityInner,
Identity,
};
<span class="doccomment">/// Identity management middleware.
///
/// ```no_run
/// use actix_web::{cookie::Key, App, HttpServer};
/// use actix_session::storage::RedisSessionStore;
/// use actix_identity::{Identity, IdentityMiddleware};
/// use actix_session::{Session, SessionMiddleware};
///
/// #[actix_web::main]
/// async fn main() {
/// let secret_key = Key::generate();
/// let redis_store = RedisSessionStore::new("redis://127.0.0.1:6379").await.unwrap();
///
/// HttpServer::new(move || {
/// App::new()
/// // Install the identity framework first.
/// .wrap(IdentityMiddleware::default())
/// // The identity system is built on top of sessions.
/// // You must install the session middleware to leverage `actix-identity`.
/// .wrap(SessionMiddleware::new(redis_store.clone(), secret_key.clone()))
/// })
/// # ;
/// }
/// ```
</span><span class="attribute">#[derive(Default, Clone)]
</span><span class="kw">pub struct </span>IdentityMiddleware {
configuration: Rc<Configuration>,
}
<span class="kw">impl </span>IdentityMiddleware {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(configuration: Configuration) -> <span class="self">Self </span>{
<span class="self">Self </span>{
configuration: Rc::new(configuration),
}
}
<span class="doccomment">/// A fluent API to configure [`IdentityMiddleware`].
</span><span class="kw">pub fn </span>builder() -> IdentityMiddlewareBuilder {
IdentityMiddlewareBuilder::new()
}
}
<span class="kw">impl</span><S, B> Transform<S, ServiceRequest> <span class="kw">for </span>IdentityMiddleware
<span class="kw">where
</span>S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + <span class="lifetime">'static</span>,
S::Future: <span class="lifetime">'static</span>,
B: MessageBody + <span class="lifetime">'static</span>,
{
<span class="kw">type </span>Response = ServiceResponse<B>;
<span class="kw">type </span>Error = Error;
<span class="kw">type </span>Transform = InnerIdentityMiddleware<S>;
<span class="kw">type </span>InitError = ();
<span class="kw">type </span>Future = Ready<<span class="prelude-ty">Result</span><<span class="self">Self</span>::Transform, <span class="self">Self</span>::InitError>>;
<span class="kw">fn </span>new_transform(<span class="kw-2">&</span><span class="self">self</span>, service: S) -> <span class="self">Self</span>::Future {
ready(<span class="prelude-val">Ok</span>(InnerIdentityMiddleware {
service: Rc::new(service),
configuration: Rc::clone(<span class="kw-2">&</span><span class="self">self</span>.configuration),
}))
}
}
<span class="attribute">#[doc(hidden)]
</span><span class="kw">pub struct </span>InnerIdentityMiddleware<S> {
service: Rc<S>,
configuration: Rc<Configuration>,
}
<span class="kw">impl</span><S> Clone <span class="kw">for </span>InnerIdentityMiddleware<S> {
<span class="kw">fn </span>clone(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="self">Self </span>{
<span class="self">Self </span>{
service: Rc::clone(<span class="kw-2">&</span><span class="self">self</span>.service),
configuration: Rc::clone(<span class="kw-2">&</span><span class="self">self</span>.configuration),
}
}
}
<span class="kw">impl</span><S, B> Service<ServiceRequest> <span class="kw">for </span>InnerIdentityMiddleware<S>
<span class="kw">where
</span>S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + <span class="lifetime">'static</span>,
S::Future: <span class="lifetime">'static</span>,
B: MessageBody + <span class="lifetime">'static</span>,
{
<span class="kw">type </span>Response = ServiceResponse<B>;
<span class="kw">type </span>Error = Error;
<span class="kw">type </span>Future = LocalBoxFuture<<span class="lifetime">'static</span>, <span class="prelude-ty">Result</span><<span class="self">Self</span>::Response, <span class="self">Self</span>::Error>>;
<span class="macro">actix_service::forward_ready!</span>(service);
<span class="kw">fn </span>call(<span class="kw-2">&</span><span class="self">self</span>, req: ServiceRequest) -> <span class="self">Self</span>::Future {
<span class="kw">let </span>srv = Rc::clone(<span class="kw-2">&</span><span class="self">self</span>.service);
<span class="kw">let </span>configuration = Rc::clone(<span class="kw-2">&</span><span class="self">self</span>.configuration);
Box::pin(<span class="kw">async move </span>{
<span class="kw">let </span>identity_inner = IdentityInner {
session: req.get_session(),
logout_behaviour: configuration.on_logout.clone(),
is_login_deadline_enabled: configuration.login_deadline.is_some(),
is_visit_deadline_enabled: configuration.visit_deadline.is_some(),
};
req.extensions_mut().insert(identity_inner);
enforce_policies(<span class="kw-2">&</span>req, <span class="kw-2">&</span>configuration);
srv.call(req).<span class="kw">await
</span>})
}
}
<span class="comment">// easier to scan with returns where they are
// especially if the function body were to evolve in the future
</span><span class="attribute">#[allow(clippy::needless_return)]
</span><span class="kw">fn </span>enforce_policies(req: <span class="kw-2">&</span>ServiceRequest, configuration: <span class="kw-2">&</span>Configuration) {
<span class="kw">let </span>must_extract_identity =
configuration.login_deadline.is_some() || configuration.visit_deadline.is_some();
<span class="kw">if </span>!must_extract_identity {
<span class="kw">return</span>;
}
<span class="kw">let </span>identity = <span class="kw">match </span>Identity::extract(<span class="kw-2">&</span>req.extensions()) {
<span class="prelude-val">Ok</span>(identity) => identity,
<span class="prelude-val">Err</span>(err) => {
<span class="macro">tracing::debug!</span>(
error.display = %err,
error.debug = <span class="question-mark">?</span>err,
<span class="string">"Failed to extract an `Identity` from the incoming request."
</span>);
<span class="kw">return</span>;
}
};
<span class="kw">if let </span><span class="prelude-val">Some</span>(login_deadline) = configuration.login_deadline {
<span class="kw">if </span><span class="macro">matches!</span>(
enforce_login_deadline(<span class="kw-2">&</span>identity, login_deadline),
PolicyDecision::LogOut
) {
identity.logout();
<span class="kw">return</span>;
}
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(visit_deadline) = configuration.visit_deadline {
<span class="kw">if </span><span class="macro">matches!</span>(
enforce_visit_deadline(<span class="kw-2">&</span>identity, visit_deadline),
PolicyDecision::LogOut
) {
identity.logout();
<span class="kw">return</span>;
} <span class="kw">else if let </span><span class="prelude-val">Err</span>(err) = identity.set_last_visited_at() {
<span class="macro">tracing::warn!</span>(
error.display = %err,
error.debug = <span class="question-mark">?</span>err,
<span class="string">"Failed to set the last visited timestamp on `Identity` for an incoming request."
</span>);
}
}
}
<span class="kw">fn </span>enforce_login_deadline(
identity: <span class="kw-2">&</span>Identity,
login_deadline: std::time::Duration,
) -> PolicyDecision {
<span class="kw">match </span>identity.logged_at() {
<span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>) => {
<span class="macro">tracing::info!</span>(
<span class="string">"Login deadline is enabled, but there is no login timestamp in the session \
state attached to the incoming request. Logging the user out."
</span>);
PolicyDecision::LogOut
}
<span class="prelude-val">Err</span>(err) => {
<span class="macro">tracing::info!</span>(
error.display = %err,
error.debug = <span class="question-mark">?</span>err,
<span class="string">"Login deadline is enabled but we failed to extract the login timestamp from the \
session state attached to the incoming request. Logging the user out."
</span>);
PolicyDecision::LogOut
}
<span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(logged_in_at)) => {
<span class="kw">let </span>elapsed = OffsetDateTime::now_utc() - logged_in_at;
<span class="kw">if </span>elapsed > login_deadline {
<span class="macro">tracing::info!</span>(
user.logged_in_at = %logged_in_at.format(<span class="kw-2">&</span>Rfc3339).unwrap_or_default(),
identity.login_deadline_seconds = login_deadline.as_secs(),
identity.elapsed_since_login_seconds = elapsed.whole_seconds(),
<span class="string">"Login deadline is enabled and too much time has passed since the user logged \
in. Logging the user out."
</span>);
PolicyDecision::LogOut
} <span class="kw">else </span>{
PolicyDecision::StayLoggedIn
}
}
}
}
<span class="kw">fn </span>enforce_visit_deadline(
identity: <span class="kw-2">&</span>Identity,
visit_deadline: std::time::Duration,
) -> PolicyDecision {
<span class="kw">match </span>identity.last_visited_at() {
<span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>) => {
<span class="macro">tracing::info!</span>(
<span class="string">"Last visit deadline is enabled, but there is no last visit timestamp in the \
session state attached to the incoming request. Logging the user out."
</span>);
PolicyDecision::LogOut
}
<span class="prelude-val">Err</span>(err) => {
<span class="macro">tracing::info!</span>(
error.display = %err,
error.debug = <span class="question-mark">?</span>err,
<span class="string">"Last visit deadline is enabled but we failed to extract the last visit timestamp \
from the session state attached to the incoming request. Logging the user out."
</span>);
PolicyDecision::LogOut
}
<span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(last_visited_at)) => {
<span class="kw">let </span>elapsed = OffsetDateTime::now_utc() - last_visited_at;
<span class="kw">if </span>elapsed > visit_deadline {
<span class="macro">tracing::info!</span>(
user.last_visited_at = %last_visited_at.format(<span class="kw-2">&</span>Rfc3339).unwrap_or_default(),
identity.visit_deadline_seconds = visit_deadline.as_secs(),
identity.elapsed_since_last_visit_seconds = elapsed.whole_seconds(),
<span class="string">"Last visit deadline is enabled and too much time has passed since the last \
time the user visited. Logging the user out."
</span>);
PolicyDecision::LogOut
} <span class="kw">else </span>{
PolicyDecision::StayLoggedIn
}
}
}
}
<span class="kw">enum </span>PolicyDecision {
StayLoggedIn,
LogOut,
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_identity" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0-nightly (060e47f74 2022-08-23)" ></div></body></html>