mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-02 13:06:38 +02:00
205 lines
9.9 KiB
HTML
205 lines
9.9 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`."><title>lib.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-c67e44d78ab2db17.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.76.0-nightly (e9013ac0e 2023-12-05)" data-channel="nightly" data-search-js="search-5a66c239c06b3a66.js" data-settings-js="settings-fe03fdc259827cd2.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-77dede896d6ac08e.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.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"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../actix_identity/index.html"><img src="https://actix.rs/img/logo.png" alt="actix_identity"></a><form class="search-form"><span></span><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" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-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>
|
||
</pre></div><pre class="rust"><code><span class="doccomment">//! Identity management for Actix Web.
|
||
//!
|
||
//! `actix-identity` can be used to track identity of a user across multiple requests. It is built
|
||
//! on top of HTTP sessions, via [`actix-session`](https://docs.rs/actix-session).
|
||
//!
|
||
//! # Getting started
|
||
//! To start using identity management in your Actix Web application you must register
|
||
//! [`IdentityMiddleware`] and `SessionMiddleware` as middleware on your `App`:
|
||
//!
|
||
//! ```no_run
|
||
//! # use actix_web::web;
|
||
//! use actix_web::{cookie::Key, App, HttpServer, HttpResponse};
|
||
//! use actix_identity::IdentityMiddleware;
|
||
//! use actix_session::{storage::RedisSessionStore, 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`. The session middleware must be mounted
|
||
//! // AFTER the identity middleware: `actix-web` invokes middleware in the OPPOSITE
|
||
//! // order of registration when it receives an incoming request.
|
||
//! .wrap(SessionMiddleware::new(
|
||
//! redis_store.clone(),
|
||
//! secret_key.clone()
|
||
//! ))
|
||
//! // Your request handlers [...]
|
||
//! # .default_service(web::to(|| HttpResponse::Ok()))
|
||
//! })
|
||
//! # ;
|
||
//! }
|
||
//! ```
|
||
//!
|
||
//! User identities can be created, accessed and destroyed using the [`Identity`] extractor in your
|
||
//! request handlers:
|
||
//!
|
||
//! ```no_run
|
||
//! use actix_web::{get, post, HttpResponse, Responder, HttpRequest, HttpMessage};
|
||
//! use actix_identity::Identity;
|
||
//! use actix_session::storage::RedisSessionStore;
|
||
//!
|
||
//! #[get("/")]
|
||
//! async fn index(user: Option<Identity>) -> impl Responder {
|
||
//! if let Some(user) = user {
|
||
//! format!("Welcome! {}", user.id().unwrap())
|
||
//! } else {
|
||
//! "Welcome Anonymous!".to_owned()
|
||
//! }
|
||
//! }
|
||
//!
|
||
//! #[post("/login")]
|
||
//! async fn login(request: HttpRequest) -> impl Responder {
|
||
//! // Some kind of authentication should happen here
|
||
//! // e.g. password-based, biometric, etc.
|
||
//! // [...]
|
||
//!
|
||
//! // attach a verified user identity to the active session
|
||
//! Identity::login(&request.extensions(), "User1".into()).unwrap();
|
||
//!
|
||
//! HttpResponse::Ok()
|
||
//! }
|
||
//!
|
||
//! #[post("/logout")]
|
||
//! async fn logout(user: Identity) -> impl Responder {
|
||
//! user.logout();
|
||
//! HttpResponse::Ok()
|
||
//! }
|
||
//! ```
|
||
//!
|
||
//! # Advanced configuration
|
||
//! By default, `actix-identity` does not automatically log out users. You can change this behaviour
|
||
//! by customising the configuration for [`IdentityMiddleware`] via [`IdentityMiddleware::builder`].
|
||
//!
|
||
//! In particular, you can automatically log out users who:
|
||
//! - have been inactive for a while (see [`IdentityMiddlewareBuilder::visit_deadline`];
|
||
//! - logged in too long ago (see [`IdentityMiddlewareBuilder::login_deadline`]).
|
||
//!
|
||
//! [`IdentityMiddlewareBuilder::visit_deadline`]: config::IdentityMiddlewareBuilder::visit_deadline
|
||
//! [`IdentityMiddlewareBuilder::login_deadline`]: config::IdentityMiddlewareBuilder::login_deadline
|
||
|
||
</span><span class="attr">#![forbid(unsafe_code)]
|
||
#![deny(rust_2018_idioms, nonstandard_style, missing_docs)]
|
||
#![warn(future_incompatible)]
|
||
#![doc(html_logo_url = <span class="string">"https://actix.rs/img/logo.png"</span>)]
|
||
#![doc(html_favicon_url = <span class="string">"https://actix.rs/favicon.ico"</span>)]
|
||
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
|
||
|
||
</span><span class="kw">pub mod </span>config;
|
||
<span class="kw">pub mod </span>error;
|
||
<span class="kw">mod </span>identity;
|
||
<span class="kw">mod </span>identity_ext;
|
||
<span class="kw">mod </span>middleware;
|
||
|
||
<span class="kw">pub use </span><span class="self">self</span>::{identity::Identity, identity_ext::IdentityExt, middleware::IdentityMiddleware};
|
||
</code></pre></div></section></main></body></html> |