mirror of
https://github.com/actix/actix-extras.git
synced 2025-01-24 07:43:49 +01:00
311 lines
20 KiB
HTML
311 lines
20 KiB
HTML
<!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/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
|
||
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../actix_identity/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
|
||
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><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>
|
||
</pre><div class="example-wrap"><pre class="rust ">
|
||
<span class="doccomment">//! Opinionated request identity service for Actix Web apps.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! [`IdentityService`] middleware can be used with different policies types to store</span>
|
||
<span class="doccomment">//! identity information.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! A cookie based policy is provided. [`CookieIdentityPolicy`] uses cookies as identity storage.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! To access current request identity, use the [`Identity`] extractor.</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! ```</span>
|
||
<span class="doccomment">//! use actix_web::*;</span>
|
||
<span class="doccomment">//! use actix_identity::{Identity, CookieIdentityPolicy, IdentityService};</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! #[get("/")]</span>
|
||
<span class="doccomment">//! async fn index(id: Identity) -> String {</span>
|
||
<span class="doccomment">//! // access request identity</span>
|
||
<span class="doccomment">//! if let Some(id) = id.identity() {</span>
|
||
<span class="doccomment">//! format!("Welcome! {}", id)</span>
|
||
<span class="doccomment">//! } else {</span>
|
||
<span class="doccomment">//! "Welcome Anonymous!".to_owned()</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! #[post("/login")]</span>
|
||
<span class="doccomment">//! async fn login(id: Identity) -> HttpResponse {</span>
|
||
<span class="doccomment">//! id.remember("User1".to_owned()); // <- remember identity</span>
|
||
<span class="doccomment">//! HttpResponse::Ok().finish()</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! #[post("/logout")]</span>
|
||
<span class="doccomment">//! async fn logout(id: Identity) -> HttpResponse {</span>
|
||
<span class="doccomment">//! id.forget(); // <- remove identity</span>
|
||
<span class="doccomment">//! HttpResponse::Ok().finish()</span>
|
||
<span class="doccomment">//! }</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! // create cookie identity backend</span>
|
||
<span class="doccomment">//! let policy = CookieIdentityPolicy::new(&[0; 32])</span>
|
||
<span class="doccomment">//! .name("auth-cookie")</span>
|
||
<span class="doccomment">//! .secure(false);</span>
|
||
<span class="doccomment">//!</span>
|
||
<span class="doccomment">//! let app = App::new()</span>
|
||
<span class="doccomment">//! // wrap policy into middleware identity middleware</span>
|
||
<span class="doccomment">//! .wrap(IdentityService::new(policy))</span>
|
||
<span class="doccomment">//! .service(services![index, login, logout]);</span>
|
||
<span class="doccomment">//! ```</span>
|
||
|
||
<span class="attribute">#![<span class="ident">deny</span>(<span class="ident">rust_2018_idioms</span>, <span class="ident">nonstandard_style</span>)]</span>
|
||
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">future</span>::<span class="ident">Future</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{
|
||
<span class="ident">dev</span>::{<span class="ident">ServiceRequest</span>, <span class="ident">ServiceResponse</span>},
|
||
<span class="ident">Error</span>, <span class="ident">HttpMessage</span>, <span class="prelude-ty">Result</span>,
|
||
};
|
||
|
||
<span class="kw">mod</span> <span class="ident">cookie</span>;
|
||
<span class="kw">mod</span> <span class="ident">identity</span>;
|
||
<span class="kw">mod</span> <span class="ident">middleware</span>;
|
||
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">cookie</span>::<span class="ident">CookieIdentityPolicy</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">identity</span>::<span class="ident">Identity</span>;
|
||
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">middleware</span>::<span class="ident">IdentityService</span>;
|
||
|
||
<span class="doccomment">/// Identity policy.</span>
|
||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">IdentityPolicy</span>: <span class="ident">Sized</span> <span class="op">+</span> <span class="lifetime">'static</span> {
|
||
<span class="doccomment">/// The return type of the middleware</span>
|
||
<span class="kw">type</span> <span class="ident">Future</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="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">Error</span><span class="op">></span><span class="op">></span>;
|
||
|
||
<span class="doccomment">/// The return type of the middleware</span>
|
||
<span class="kw">type</span> <span class="ident">ResponseFuture</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">Error</span><span class="op">></span><span class="op">></span>;
|
||
|
||
<span class="doccomment">/// Parse the session from request and load data from a service identity.</span>
|
||
<span class="kw">fn</span> <span class="ident">from_request</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">req</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ServiceRequest</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>::<span class="ident">Future</span>;
|
||
|
||
<span class="doccomment">/// Write changes to response</span>
|
||
<span class="kw">fn</span> <span class="ident">to_response</span><span class="op"><</span><span class="ident">B</span><span class="op">></span>(
|
||
<span class="kw-2">&</span><span class="self">self</span>,
|
||
<span class="ident">identity</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>,
|
||
<span class="ident">changed</span>: <span class="ident">bool</span>,
|
||
<span class="ident">response</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">ServiceResponse</span><span class="op"><</span><span class="ident">B</span><span class="op">></span>,
|
||
) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>::<span class="ident">ResponseFuture</span>;
|
||
}
|
||
|
||
<span class="doccomment">/// Helper trait that allows to get Identity.</span>
|
||
<span class="doccomment">///</span>
|
||
<span class="doccomment">/// It could be used in middleware but identity policy must be set before any other middleware that</span>
|
||
<span class="doccomment">/// needs identity. RequestIdentity is implemented both for `ServiceRequest` and `HttpRequest`.</span>
|
||
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">RequestIdentity</span> {
|
||
<span class="kw">fn</span> <span class="ident">get_identity</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</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">RequestIdentity</span> <span class="kw">for</span> <span class="ident">T</span>
|
||
<span class="kw">where</span>
|
||
<span class="ident">T</span>: <span class="ident">HttpMessage</span>,
|
||
{
|
||
<span class="kw">fn</span> <span class="ident">get_identity</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> {
|
||
<span class="ident">Identity</span>::<span class="ident">get_identity</span>(<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">extensions</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="ident">std</span>::<span class="ident">time</span>::<span class="ident">SystemTime</span>;
|
||
|
||
<span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">dev</span>::<span class="ident">ServiceResponse</span>, <span class="ident">test</span>, <span class="ident">web</span>, <span class="ident">App</span>, <span class="ident">Error</span>};
|
||
|
||
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
|
||
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">COOKIE_KEY_MASTER</span>: [<span class="ident">u8</span>; <span class="number">32</span>] <span class="op">=</span> [<span class="number">0</span>; <span class="number">32</span>];
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">COOKIE_NAME</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"actix_auth"</span>;
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const</span> <span class="ident">COOKIE_LOGIN</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"test"</span>;
|
||
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">clippy</span>::<span class="ident">enum_variant_names</span>)]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">LoginTimestampCheck</span> {
|
||
<span class="ident">NoTimestamp</span>,
|
||
<span class="ident">NewTimestamp</span>,
|
||
<span class="ident">OldTimestamp</span>(<span class="ident">SystemTime</span>),
|
||
}
|
||
|
||
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">clippy</span>::<span class="ident">enum_variant_names</span>)]</span>
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">VisitTimeStampCheck</span> {
|
||
<span class="ident">NoTimestamp</span>,
|
||
<span class="ident">NewTimestamp</span>,
|
||
}
|
||
|
||
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">create_identity_server</span><span class="op"><</span>
|
||
<span class="ident">F</span>: <span class="ident">Fn</span>(<span class="ident">CookieIdentityPolicy</span>) <span class="op">-</span><span class="op">></span> <span class="ident">CookieIdentityPolicy</span> <span class="op">+</span> <span class="ident">Sync</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Clone</span> <span class="op">+</span> <span class="lifetime">'static</span>,
|
||
<span class="op">></span>(
|
||
<span class="ident">f</span>: <span class="ident">F</span>,
|
||
) <span class="op">-</span><span class="op">></span> <span class="kw">impl</span> <span class="ident">actix_service</span>::<span class="ident">Service</span><span class="op"><</span>
|
||
<span class="ident">actix_http</span>::<span class="ident">Request</span>,
|
||
<span class="ident">Response</span> <span class="op">=</span> <span class="ident">ServiceResponse</span><span class="op"><</span><span class="ident">actix_web</span>::<span class="ident">body</span>::<span class="ident">Body</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="ident">test</span>::<span class="ident">init_service</span>(
|
||
<span class="ident">App</span>::<span class="ident">new</span>()
|
||
.<span class="ident">wrap</span>(<span class="ident">IdentityService</span>::<span class="ident">new</span>(<span class="ident">f</span>(<span class="ident">CookieIdentityPolicy</span>::<span class="ident">new</span>(
|
||
<span class="kw-2">&</span><span class="ident">COOKIE_KEY_MASTER</span>,
|
||
)
|
||
.<span class="ident">secure</span>(<span class="bool-val">false</span>)
|
||
.<span class="ident">name</span>(<span class="ident">COOKIE_NAME</span>))))
|
||
.<span class="ident">service</span>(<span class="ident">web</span>::<span class="ident">resource</span>(<span class="string">"/"</span>).<span class="ident">to</span>(<span class="op">|</span><span class="ident">id</span>: <span class="ident">Identity</span><span class="op">|</span> <span class="kw">async</span> <span class="kw">move</span> {
|
||
<span class="kw">let</span> <span class="ident">identity</span> <span class="op">=</span> <span class="ident">id</span>.<span class="ident">identity</span>();
|
||
<span class="kw">if</span> <span class="ident">identity</span>.<span class="ident">is_none</span>() {
|
||
<span class="ident">id</span>.<span class="ident">remember</span>(<span class="ident">COOKIE_LOGIN</span>.<span class="ident">to_string</span>())
|
||
}
|
||
<span class="ident">web</span>::<span class="ident">Json</span>(<span class="ident">identity</span>)
|
||
})),
|
||
)
|
||
.<span class="kw">await</span>
|
||
}
|
||
}
|
||
</pre></div>
|
||
</section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="actix_identity" data-search-js="../../search-index.js"></div>
|
||
<script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script></body></html> |