<!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`."><title>middleware.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="actix_identity" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0-nightly (2dceda4f3 2024-03-01)" data-channel="nightly" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="../../static.files/src-script-e66d777a5a92e9b2.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title">
<h2>Files</h2></div></nav><div class="sidebar-resizer"></div>
<main><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../actix_identity/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</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-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a>
<a href="#192" id="192">192</a>
<a href="#193" id="193">193</a>
<a href="#194" id="194">194</a>
<a href="#195" id="195">195</a>
<a href="#196" id="196">196</a>
<a href="#197" id="197">197</a>
<a href="#198" id="198">198</a>
<a href="#199" id="199">199</a>
<a href="#200" id="200">200</a>
<a href="#201" id="201">201</a>
<a href="#202" id="202">202</a>
<a href="#203" id="203">203</a>
<a href="#204" id="204">204</a>
<a href="#205" id="205">205</a>
<a href="#206" id="206">206</a>
<a href="#207" id="207">207</a>
<a href="#208" id="208">208</a>
<a href="#209" id="209">209</a>
<a href="#210" id="210">210</a>
<a href="#211" id="211">211</a>
<a href="#212" id="212">212</a>
<a href="#213" id="213">213</a>
<a href="#214" id="214">214</a>
<a href="#215" id="215">215</a>
<a href="#216" id="216">216</a>
<a href="#217" id="217">217</a>
<a href="#218" id="218">218</a>
<a href="#219" id="219">219</a>
<a href="#220" id="220">220</a>
<a href="#221" id="221">221</a>
<a href="#222" id="222">222</a>
<a href="#223" id="223">223</a>
<a href="#224" id="224">224</a>
<a href="#225" id="225">225</a>
<a href="#226" id="226">226</a>
<a href="#227" id="227">227</a>
<a href="#228" id="228">228</a>
<a href="#229" id="229">229</a>
<a href="#230" id="230">230</a>
<a href="#231" id="231">231</a>
<a href="#232" id="232">232</a>
<a href="#233" id="233">233</a>
<a href="#234" id="234">234</a>
<a href="#235" id="235">235</a>
<a href="#236" id="236">236</a>
<a href="#237" id="237">237</a>
<a href="#238" id="238">238</a>
<a href="#239" id="239">239</a>
<a href="#240" id="240">240</a>
<a href="#241" id="241">241</a>
<a href="#242" id="242">242</a>
<a href="#243" id="243">243</a>
<a href="#244" id="244">244</a>
<a href="#245" id="245">245</a>
<a href="#246" id="246">246</a>
<a href="#247" id="247">247</a>
<a href="#248" id="248">248</a>
<a href="#249" id="249">249</a>
<a href="#250" id="250">250</a>
<a href="#251" id="251">251</a>
<a href="#252" id="252">252</a>
<a href="#253" id="253">253</a>
<a href="#254" id="254">254</a>
<a href="#255" id="255">255</a>
<a href="#256" id="256">256</a>
<a href="#257" id="257">257</a>
<a href="#258" id="258">258</a>
<a href="#259" id="259">259</a>
</pre></div><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="attr">#[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="attr">#[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(),
id_key: configuration.id_key,
last_visit_unix_timestamp_key: configuration.last_visit_unix_timestamp_key,
login_unix_timestamp_key: configuration.login_unix_timestamp_key,
};
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="attr">#[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></main></body></html>