      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    343
    344
    345
    346
    347
    348
    349
    350
    351
    352
    353
    354
    355
    356
    357
    358
    359
    360
    361
    362
    363
    364
    365
    366
    367
    368
    369
    370
    371
    372
    373
    374
    375
    376
    377
    378
    379
    380
    381
    382
    383
    384
    385
    386
    387
    388
    389
    390
    391
    392
    393
    394
    395
    396
    397
    398
    399
    400
    401
    402
    403
    404
    405
    406
    407
    408
    409
    410
    411
    412
    413
    414
    415
    416
    417
    418
    419
    420
    421
    422
    423
    424
    425
    426
    427
    428
    429
    430
    431
    432
    433
    434
    435
    436
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581

    //! Session management for Actix Web
    //!
    //! The HTTP protocol, at a first glance, is stateless: the client sends a request, the server
    //! parses its content, performs some processing and returns a response. The outcome is only
    //! influenced by the provided inputs (i.e. the request content) and whatever state the server
    //! queries while performing its processing.
    //!
    //! Stateless systems are easier to reason about, but they are not quite as powerful as we need to
    //! be - e.g. how do you authenticate a user? The user would be forced to authenticate **for every
    //! single request**. That is, for example, how 'Basic' Authentication works. While it may work for
    //! a machine user (i.e. an API client), it is impractical for a person—you do not want a login
    //! prompt on every single page you navigate to!
    //!
    //! There is a solution - **sessions**. Using sessions the server can attach state to a set of
    //! requests coming from the same client. They are built on top of cookies - the server sets a
    //! cookie in the HTTP response (`Set-Cookie` header), the client (e.g. the browser) will store the
    //! cookie and play it back to the server when sending new requests (using the `Cookie` header).
    //!
    //! We refer to the cookie used for sessions as a **session cookie**. Its content is called
    //! **session key** (or **session ID**), while the state attached to the session is referred to as
    //! **session state**.
    //!
    //! `actix-session` provides an easy-to-use framework to manage sessions in applications built on
    //! top of Actix Web. [`SessionMiddleware`] is the middleware underpinning the functionality
    //! provided by `actix-session`; it takes care of all the session cookie handling and instructs the
    //! **storage backend** to create/delete/update the session state based on the operations performed
    //! against the active [`Session`].
    //!
    //! `actix-session` provides some built-in storage backends: ([`storage::CookieSessionStore`],
    //! [`storage::RedisSessionStore`], and [`storage::RedisActorSessionStore`]) - you can create a
    //! custom storage backend by implementing the [`SessionStore`](storage::SessionStore) trait.
    //!
    //! Further reading on sessions:
    //! - [RFC6265](https://datatracker.ietf.org/doc/html/rfc6265);
    //! - [OWASP's session management cheat-sheet](https://cheatsheetseries.owasp.org/cheatsheets/Session_Management_Cheat_Sheet.html).
    //!
    //! # Getting started
    //! To start using sessions in your Actix Web application you must register [`SessionMiddleware`]
    //! as a middleware on your `App`:
    //!
    //! ```no_run
    //! use actix_web::{web, App, HttpServer, HttpResponse, Error};
    //! use actix_session::{Session, SessionMiddleware, storage::RedisActorSessionStore};
    //! use actix_web::cookie::Key;
    //!
    //! #[actix_web::main]
    //! async fn main() -> std::io::Result<()> {
    //!     // The secret key would usually be read from a configuration file/environment variables.
    //!     let secret_key = Key::generate();
    //!     let redis_connection_string = "127.0.0.1:6379";
    //!     HttpServer::new(move ||
    //!             App::new()
    //!             // Add session management to your application using Redis for session state storage
    //!             .wrap(
    //!                 SessionMiddleware::new(
    //!                     RedisActorSessionStore::new(redis_connection_string),
    //!                     secret_key.clone()
    //!                 )
    //!             )
    //!             .default_service(web::to(|| HttpResponse::Ok())))
    //!         .bind(("127.0.0.1", 8080))?
    //!         .run()
    //!         .await
    //! }
    //! ```
    //!
    //! The session state can be accessed and modified by your request handlers using the [`Session`]
    //! extractor.
    //!
    //! ```no_run
    //! use actix_web::Error;
    //! use actix_session::Session;
    //!
    //! fn index(session: Session) -> Result<&'static str, Error> {
    //!     // Access the session state
    //!     if let Some(count) = session.get::<i32>("counter")? {
    //!         println!("SESSION value: {}", count);
    //!         // Modify the session state
    //!         session.insert("counter", count + 1)?;
    //!     } else {
    //!         session.insert("counter", 1)?;
    //!     }
    //!
    //!     Ok("Welcome!")
    //! }
    //! ```
    //!
    //! # Choosing A Backend
    //!
    //! By default, `actix-session` does not provide any storage backend to retrieve and save the state
    //! attached to your sessions. You can enable:
    //!
    //! - a purely cookie-based "backend", [`storage::CookieSessionStore`], using the `cookie-session`
    //!   feature flag.
    //!
    //! ```toml
    //! [dependencies]
    //! # ...
    //! actix-session = { version = "...", features = ["cookie-session"] }
    //! ```
    //!
    //! - a Redis-based backend via `actix-redis`, [`storage::RedisActorSessionStore`], using the
    //!   `redis-actor-session` feature flag.
    //!
    //! ```toml
    //! [dependencies]
    //! # ...
    //! actix-session = { version = "...", features = ["redis-actor-session"] }
    //! ```
    //!
    //! - a Redis-based backend via [`redis-rs`](https://github.com/mitsuhiko/redis-rs),
    //!   [`storage::RedisSessionStore`], using the `redis-rs-session` feature flag.
    //!
    //! ```toml
    //! [dependencies]
    //! # ...
    //! actix-session = { version = "...", features = ["redis-rs-session"] }
    //! ```
    //!
    //! Add the `redis-rs-tls-session` feature flag if you want to connect to Redis using a secured
    //! connection:
    //!
    //! ```toml
    //! [dependencies]
    //! # ...
    //! actix-session = { version = "...", features = ["redis-rs-session", "redis-rs-tls-session"] }
    //! ```
    //!
    //! You can provide a different session store by implementing the [`storage::SessionStore`] trait.

    #![deny(rust_2018_idioms, nonstandard_style)]
    #![warn(future_incompatible, missing_docs)]
    #![doc(html_logo_url = "https://actix.rs/img/logo.png")]
    #![doc(html_favicon_url = "https://actix.rs/favicon.ico")]
    #![cfg_attr(docsrs, feature(doc_cfg))]

    mod middleware;
    mod session;
    mod session_ext;
    pub mod storage;

    pub use self::middleware::{
        CookieContentSecurity, SessionLength, SessionMiddleware, SessionMiddlewareBuilder,
    };
    pub use self::session::{Session, SessionStatus};
    pub use self::session_ext::SessionExt;

    #[cfg(test)]
    pub mod test_helpers {
        use actix_web::cookie::Key;
        use rand::{distributions::Alphanumeric, thread_rng, Rng};

        use crate::{storage::SessionStore, CookieContentSecurity};

        /// Generate a random cookie signing/encryption key.
        pub fn key() -> Key {
            let signing_key: String = thread_rng()
                .sample_iter(&Alphanumeric)
                .take(64)
                .map(char::from)
                .collect();
            Key::from(signing_key.as_bytes())
        }

        /// A ready-to-go acceptance test suite to verify that sessions behave as expected
        /// regardless of the underlying session store.
        ///
        /// `is_invalidation_supported` must be set to `true` if the backend supports
        /// "remembering" that a session has been invalidated (e.g. by logging out).
        /// It should be to `false` if the backend allows multiple cookies to be active
        /// at the same time (e.g. cookie store backend).
        pub async fn acceptance_test_suite<F, Store>(store_builder: F, is_invalidation_supported: bool)
        where
            Store: SessionStore + 'static,
            F: Fn() -> Store + Clone + Send + 'static,
        {
            for policy in &[
                CookieContentSecurity::Signed,
                CookieContentSecurity::Private,
            ] {
                println!("Using {:?} as cookie content security policy.", policy);
                acceptance_tests::basic_workflow(store_builder.clone(), *policy).await;
                acceptance_tests::expiration_is_refreshed_on_changes(store_builder.clone(), *policy)
                    .await;
                acceptance_tests::complex_workflow(
                    store_builder.clone(),
                    is_invalidation_supported,
                    *policy,
                )
                .await;
            }
        }

        mod acceptance_tests {
            use actix_web::{
                dev::Service,
                middleware, test,
                web::{self, get, post, resource, Bytes},
                App, HttpResponse, Result,
            };
            use serde::{Deserialize, Serialize};
            use serde_json::json;
            use time::Duration;

            use crate::{
                middleware::SessionLength, storage::SessionStore, test_helpers::key,
                CookieContentSecurity, Session, SessionMiddleware,
            };

            pub(super) async fn basic_workflow<F, Store>(
                store_builder: F,
                policy: CookieContentSecurity,
            ) where
                Store: SessionStore + 'static,
                F: Fn() -> Store + Clone + Send + 'static,
            {
                let app = test::init_service(
                    App::new()
                        .wrap(
                            SessionMiddleware::builder(store_builder(), key())
                                .cookie_path("/test/".into())
                                .cookie_name("actix-test".into())
                                .cookie_domain(Some("localhost".into()))
                                .cookie_content_security(policy)
                                .session_length(SessionLength::Predetermined {
                                    max_session_length: Some(time::Duration::seconds(100)),
                                })
                                .build(),
                        )
                        .service(web::resource("/").to(|ses: Session| async move {
                            let _ = ses.insert("counter", 100);
                            "test"
                        }))
                        .service(web::resource("/test/").to(|ses: Session| async move {
                            let val: usize = ses.get("counter").unwrap().unwrap();
                            format!("counter: {}", val)
                        })),
                )
                .await;

                let request = test::TestRequest::get().to_request();
                let response = app.call(request).await.unwrap();
                let cookie = response
                    .response()
                    .cookies()
                    .find(|c| c.name() == "actix-test")
                    .unwrap()
                    .clone();
                assert_eq!(cookie.path().unwrap(), "/test/");

                let request = test::TestRequest::with_uri("/test/")
                    .cookie(cookie)
                    .to_request();
                let body = test::call_and_read_body(&app, request).await;
                assert_eq!(body, Bytes::from_static(b"counter: 100"));
            }

            pub(super) async fn expiration_is_refreshed_on_changes<F, Store>(
                store_builder: F,
                policy: CookieContentSecurity,
            ) where
                Store: SessionStore + 'static,
                F: Fn() -> Store + Clone + Send + 'static,
            {
                let app = test::init_service(
                    App::new()
                        .wrap(
                            SessionMiddleware::builder(store_builder(), key())
                                .cookie_content_security(policy)
                                .session_length(SessionLength::Predetermined {
                                    max_session_length: Some(time::Duration::seconds(60)),
                                })
                                .build(),
                        )
                        .service(web::resource("/").to(|ses: Session| async move {
                            let _ = ses.insert("counter", 100);
                            "test"
                        }))
                        .service(web::resource("/test/").to(|| async move { "no-changes-in-session" })),
                )
                .await;

                let request = test::TestRequest::get().to_request();
                let response = app.call(request).await.unwrap();
                let cookie_1 = response
                    .response()
                    .cookies()
                    .find(|c| c.name() == "id")
                    .expect("Cookie is set");
                assert_eq!(cookie_1.max_age(), Some(Duration::seconds(60)));

                let request = test::TestRequest::with_uri("/test/").to_request();
                let response = app.call(request).await.unwrap();
                assert!(response.response().cookies().next().is_none());

                let request = test::TestRequest::get().to_request();
                let response = app.call(request).await.unwrap();
                let cookie_2 = response
                    .response()
                    .cookies()
                    .find(|c| c.name() == "id")
                    .expect("Cookie is set");
                assert_eq!(cookie_2.max_age(), Some(Duration::seconds(60)));
            }

            pub(super) async fn complex_workflow<F, Store>(
                store_builder: F,
                is_invalidation_supported: bool,
                policy: CookieContentSecurity,
            ) where
                Store: SessionStore + 'static,
                F: Fn() -> Store + Clone + Send + 'static,
            {
                let srv = actix_test::start(move || {
                    App::new()
                        .wrap(
                            SessionMiddleware::builder(store_builder(), key())
                                .cookie_name("test-session".into())
                                .cookie_content_security(policy)
                                .session_length(SessionLength::Predetermined {
                                    max_session_length: Some(time::Duration::days(7)),
                                })
                                .build(),
                        )
                        .wrap(middleware::Logger::default())
                        .service(resource("/").route(get().to(index)))
                        .service(resource("/do_something").route(post().to(do_something)))
                        .service(resource("/login").route(post().to(login)))
                        .service(resource("/logout").route(post().to(logout)))
                });

                // Step 1:  GET index
                //   - set-cookie actix-session should NOT be in response (session data is empty)
                //   - response should be: {"counter": 0, "user_id": None}
                let req_1a = srv.get("/").send();
                let mut resp_1 = req_1a.await.unwrap();
                assert!(resp_1.cookies().unwrap().is_empty());
                let result_1 = resp_1.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_1,
                    IndexResponse {
                        user_id: None,
                        counter: 0
                    }
                );

                // Step 2: POST to do_something
                //   - adds new session state in redis:  {"counter": 1}
                //   - set-cookie actix-session should be in response (session cookie #1)
                //   - response should be: {"counter": 1, "user_id": None}
                let req_2 = srv.post("/do_something").send();
                let mut resp_2 = req_2.await.unwrap();
                let result_2 = resp_2.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_2,
                    IndexResponse {
                        user_id: None,
                        counter: 1
                    }
                );
                let cookie_1 = resp_2
                    .cookies()
                    .unwrap()
                    .clone()
                    .into_iter()
                    .find(|c| c.name() == "test-session")
                    .unwrap();
                assert_eq!(cookie_1.max_age(), Some(Duration::days(7)));

                // Step 3:  GET index, including session cookie #1 in request
                //   - set-cookie will *not* be in response
                //   - response should be: {"counter": 1, "user_id": None}
                let req_3 = srv.get("/").cookie(cookie_1.clone()).send();
                let mut resp_3 = req_3.await.unwrap();
                assert!(resp_3.cookies().unwrap().is_empty());
                let result_3 = resp_3.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_3,
                    IndexResponse {
                        user_id: None,
                        counter: 1
                    }
                );

                // Step 4: POST again to do_something, including session cookie #1 in request
                //   - set-cookie will be in response (session cookie #2)
                //   - updates session state:  {"counter": 2}
                //   - response should be: {"counter": 2, "user_id": None}
                let req_4 = srv.post("/do_something").cookie(cookie_1.clone()).send();
                let mut resp_4 = req_4.await.unwrap();
                let result_4 = resp_4.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_4,
                    IndexResponse {
                        user_id: None,
                        counter: 2
                    }
                );
                let cookie_2 = resp_4
                    .cookies()
                    .unwrap()
                    .clone()
                    .into_iter()
                    .find(|c| c.name() == "test-session")
                    .unwrap();
                assert_eq!(cookie_2.max_age(), Some(Duration::days(7)));

                // Step 5: POST to login, including session cookie #2 in request
                //   - set-cookie actix-session will be in response  (session cookie #3)
                //   - updates session state: {"counter": 2, "user_id": "ferris"}
                let req_5 = srv
                    .post("/login")
                    .cookie(cookie_2.clone())
                    .send_json(&json!({"user_id": "ferris"}));
                let mut resp_5 = req_5.await.unwrap();
                let cookie_3 = resp_5
                    .cookies()
                    .unwrap()
                    .clone()
                    .into_iter()
                    .find(|c| c.name() == "test-session")
                    .unwrap();
                assert_ne!(cookie_2.value(), cookie_3.value());

                let result_5 = resp_5.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_5,
                    IndexResponse {
                        user_id: Some("ferris".into()),
                        counter: 2
                    }
                );

                // Step 6: GET index, including session cookie #3 in request
                //   - response should be: {"counter": 2, "user_id": "ferris"}
                let req_6 = srv.get("/").cookie(cookie_3.clone()).send();
                let mut resp_6 = req_6.await.unwrap();
                let result_6 = resp_6.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_6,
                    IndexResponse {
                        user_id: Some("ferris".into()),
                        counter: 2
                    }
                );

                // Step 7: POST again to do_something, including session cookie #3 in request
                //   - updates session state: {"counter": 3, "user_id": "ferris"}
                //   - response should be: {"counter": 3, "user_id": "ferris"}
                let req_7 = srv.post("/do_something").cookie(cookie_3.clone()).send();
                let mut resp_7 = req_7.await.unwrap();
                let result_7 = resp_7.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_7,
                    IndexResponse {
                        user_id: Some("ferris".into()),
                        counter: 3
                    }
                );

                // Step 8: GET index, including session cookie #2 in request
                // If invalidation is supported, no state will be found associated to this session.
                // If invalidation is not supported, the old state will still be retrieved.
                let req_8 = srv.get("/").cookie(cookie_2.clone()).send();
                let mut resp_8 = req_8.await.unwrap();
                if is_invalidation_supported {
                    assert!(resp_8.cookies().unwrap().is_empty());
                    let result_8 = resp_8.json::<IndexResponse>().await.unwrap();
                    assert_eq!(
                        result_8,
                        IndexResponse {
                            user_id: None,
                            counter: 0
                        }
                    );
                } else {
                    let result_8 = resp_8.json::<IndexResponse>().await.unwrap();
                    assert_eq!(
                        result_8,
                        IndexResponse {
                            user_id: None,
                            counter: 2
                        }
                    );
                }

                // Step 9: POST to logout, including session cookie #3
                //   - set-cookie actix-session will be in response with session cookie #3
                //     invalidation logic
                let req_9 = srv.post("/logout").cookie(cookie_3.clone()).send();
                let resp_9 = req_9.await.unwrap();
                let cookie_3 = resp_9
                    .cookies()
                    .unwrap()
                    .clone()
                    .into_iter()
                    .find(|c| c.name() == "test-session")
                    .unwrap();
                assert_eq!(0, cookie_3.max_age().map(|t| t.whole_seconds()).unwrap());
                assert_eq!("/", cookie_3.path().unwrap());

                // Step 10: GET index, including session cookie #3 in request
                //   - set-cookie actix-session should NOT be in response if invalidation is supported
                //   - response should be: {"counter": 0, "user_id": None}
                let req_10 = srv.get("/").cookie(cookie_3.clone()).send();
                let mut resp_10 = req_10.await.unwrap();
                if is_invalidation_supported {
                    assert!(resp_10.cookies().unwrap().is_empty());
                }
                let result_10 = resp_10.json::<IndexResponse>().await.unwrap();
                assert_eq!(
                    result_10,
                    IndexResponse {
                        user_id: None,
                        counter: 0
                    }
                );
            }

            #[derive(Serialize, Deserialize, Debug, PartialEq)]
            pub struct IndexResponse {
                user_id: Option<String>,
                counter: i32,
            }

            async fn index(session: Session) -> Result<HttpResponse> {
                let user_id: Option<String> = session.get::<String>("user_id").unwrap();
                let counter: i32 = session
                    .get::<i32>("counter")
                    .unwrap_or(Some(0))
                    .unwrap_or(0);

                Ok(HttpResponse::Ok().json(&IndexResponse { user_id, counter }))
            }

            async fn do_something(session: Session) -> Result<HttpResponse> {
                let user_id: Option<String> = session.get::<String>("user_id").unwrap();
                let counter: i32 = session
                    .get::<i32>("counter")
                    .unwrap_or(Some(0))
                    .map_or(1, |inner| inner + 1);
                session.insert("counter", &counter)?;

                Ok(HttpResponse::Ok().json(&IndexResponse { user_id, counter }))
            }

            #[derive(Deserialize)]
            struct Identity {
                user_id: String,
            }

            async fn login(user_id: web::Json<Identity>, session: Session) -> Result<HttpResponse> {
                let id = user_id.into_inner().user_id;
                session.insert("user_id", &id)?;
                session.renew();

                let counter: i32 = session
                    .get::<i32>("counter")
                    .unwrap_or(Some(0))
                    .unwrap_or(0);

                Ok(HttpResponse::Ok().json(&IndexResponse {
                    user_id: Some(id),
                    counter,
                }))
            }

            async fn logout(session: Session) -> Result<HttpResponse> {
                let id: Option<String> = session.get("user_id")?;

                let body = if let Some(x) = id {
                    session.purge();
                    format!("Logged out: {}", x)
                } else {
                    "Could not log out anonymous user".to_owned()
                };

                Ok(HttpResponse::Ok().body(body))
            }
        }
    }