# middleware.rs - source
Source of the Rust file `actix-session/src/middleware.rs`.
Keywords: rust, rustlang, rust-lang

    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

    use std::{collections::HashMap, convert::TryInto, fmt, future::Future, pin::Pin, rc::Rc};

    use actix_utils::future::{ready, Ready};
    use actix_web::{
        body::MessageBody,
        cookie::{Cookie, CookieJar, Key},
        dev::{forward_ready, ResponseHead, Service, ServiceRequest, ServiceResponse, Transform},
        http::header::{HeaderValue, SET_COOKIE},
        HttpResponse,
    };
    use anyhow::Context;

    use crate::{
        config::{
            self, Configuration, CookieConfiguration, CookieContentSecurity, SessionMiddlewareBuilder,
            TtlExtensionPolicy,
        },
        storage::{LoadError, SessionKey, SessionStore},
        Session, SessionStatus,
    };

    /// A middleware for session management in Actix Web applications.
    ///
    /// [`SessionMiddleware`] takes care of a few jobs:
    ///
    /// - Instructs the session storage backend to create/update/delete/retrieve the state attached to
    ///   a session according to its status and the operations that have been performed against it;
    /// - Set/remove a cookie, on the client side, to enable a user to be consistently associated with
    ///   the same session across multiple HTTP requests.
    ///
    /// Use [`SessionMiddleware::new`] to initialize the session framework using the default parameters.
    /// To create a new instance of [`SessionMiddleware`] you need to provide:
    ///
    /// - an instance of the session storage backend you wish to use (i.e. an implementation of
    ///   [`SessionStore`]);
    /// - a secret key, to sign or encrypt the content of client-side session cookie.
    ///
    /// # How did we choose defaults?
    /// You should not regret adding `actix-session` to your dependencies and going to production using
    /// the default configuration. That is why, when in doubt, we opt to use the most secure option for
    /// each configuration parameter.
    ///
    /// We expose knobs to change the default to suit your needs—i.e., if you know what you are doing,
    /// we will not stop you. But being a subject-matter expert should not be a requirement to deploy
    /// reasonably secure implementation of sessions.
    ///
    /// # Examples
    /// ```no_run
    /// use actix_web::{web, App, HttpServer, HttpResponse, Error};
    /// use actix_session::{Session, SessionMiddleware, storage::RedisActorSessionStore};
    /// use actix_web::cookie::Key;
    ///
    /// // The secret key would usually be read from a configuration file/environment variables.
    /// fn get_secret_key() -> Key {
    ///     # todo!()
    ///     // [...]
    /// }
    ///
    /// #[actix_web::main]
    /// async fn main() -> std::io::Result<()> {
    ///     let secret_key = get_secret_key();
    ///     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
    /// }
    /// ```
    ///
    /// If you want to customise use [`builder`](Self::builder) instead of [`new`](Self::new):
    ///
    /// ```no_run
    /// use actix_web::{App, cookie::{Key, time}, Error, HttpResponse, HttpServer, web};
    /// use actix_session::{Session, SessionMiddleware, storage::RedisActorSessionStore};
    /// use actix_session::config::PersistentSession;
    ///
    /// // The secret key would usually be read from a configuration file/environment variables.
    /// fn get_secret_key() -> Key {
    ///     # todo!()
    ///     // [...]
    /// }
    ///
    /// #[actix_web::main]
    /// async fn main() -> std::io::Result<()> {
    ///     let secret_key = get_secret_key();
    ///     let redis_connection_string = "127.0.0.1:6379";
    ///     HttpServer::new(move ||
    ///             App::new()
    ///             // Customise session length!
    ///             .wrap(
    ///                 SessionMiddleware::builder(
    ///                     RedisActorSessionStore::new(redis_connection_string),
    ///                     secret_key.clone()
    ///                 )
    ///                 .session_lifecycle(
    ///                     PersistentSession::default()
    ///                         .session_ttl(time::Duration::days(5))
    ///                 )
    ///                 .build(),
    ///             )
    ///             .default_service(web::to(|| HttpResponse::Ok())))
    ///         .bind(("127.0.0.1", 8080))?
    ///         .run()
    ///         .await
    /// }
    /// ```
    #[derive(Clone)]
    pub struct SessionMiddleware<Store: SessionStore> {
        storage_backend: Rc<Store>,
        configuration: Rc<Configuration>,
    }

    impl<Store: SessionStore> SessionMiddleware<Store> {
        /// Use [`SessionMiddleware::new`] to initialize the session framework using the default
        /// parameters.
        ///
        /// To create a new instance of [`SessionMiddleware`] you need to provide:
        /// - an instance of the session storage backend you wish to use (i.e. an implementation of
        ///   [`SessionStore`]);
        /// - a secret key, to sign or encrypt the content of client-side session cookie.
        pub fn new(store: Store, key: Key) -> Self {
            Self::builder(store, key).build()
        }

        /// A fluent API to configure [`SessionMiddleware`].
        ///
        /// It takes as input the two required inputs to create a new instance of [`SessionMiddleware`]:
        /// - an instance of the session storage backend you wish to use (i.e. an implementation of
        ///   [`SessionStore`]);
        /// - a secret key, to sign or encrypt the content of client-side session cookie.
        pub fn builder(store: Store, key: Key) -> SessionMiddlewareBuilder<Store> {
            SessionMiddlewareBuilder::new(store, config::default_configuration(key))
        }

        pub(crate) fn from_parts(store: Store, configuration: Configuration) -> Self {
            Self {
                storage_backend: Rc::new(store),
                configuration: Rc::new(configuration),
            }
        }
    }

    impl<S, B, Store> Transform<S, ServiceRequest> for SessionMiddleware<Store>
    where
        S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = actix_web::Error> + 'static,
        S::Future: 'static,
        B: MessageBody + 'static,
        Store: SessionStore + 'static,
    {
        type Response = ServiceResponse<B>;
        type Error = actix_web::Error;
        type Transform = InnerSessionMiddleware<S, Store>;
        type InitError = ();
        type Future = Ready<Result<Self::Transform, Self::InitError>>;

        fn new_transform(&self, service: S) -> Self::Future {
            ready(Ok(InnerSessionMiddleware {
                service: Rc::new(service),
                configuration: Rc::clone(&self.configuration),
                storage_backend: Rc::clone(&self.storage_backend),
            }))
        }
    }

    /// Short-hand to create an `actix_web::Error` instance that will result in an `Internal Server
    /// Error` response while preserving the error root cause (e.g. in logs).
    fn e500<E: fmt::Debug + fmt::Display + 'static>(err: E) -> actix_web::Error {
        // We do not use `actix_web::error::ErrorInternalServerError` because we do not want to
        // leak internal implementation details to the caller.
        //
        // `actix_web::error::ErrorInternalServerError` includes the error Display representation
        // as body of the error responses, leading to messages like "There was an issue persisting
        // the session state" reaching API clients. We don't want that, we want opaque 500s.
        actix_web::error::InternalError::from_response(
            err,
            HttpResponse::InternalServerError().finish(),
        )
        .into()
    }

    #[doc(hidden)]
    #[non_exhaustive]
    pub struct InnerSessionMiddleware<S, Store: SessionStore + 'static> {
        service: Rc<S>,
        configuration: Rc<Configuration>,
        storage_backend: Rc<Store>,
    }

    impl<S, B, Store> Service<ServiceRequest> for InnerSessionMiddleware<S, Store>
    where
        S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = actix_web::Error> + 'static,
        S::Future: 'static,
        Store: SessionStore + 'static,
    {
        type Response = ServiceResponse<B>;
        type Error = actix_web::Error;
        #[allow(clippy::type_complexity)]
        type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>>>>;

        forward_ready!(service);

        fn call(&self, mut req: ServiceRequest) -> Self::Future {
            let service = Rc::clone(&self.service);
            let storage_backend = Rc::clone(&self.storage_backend);
            let configuration = Rc::clone(&self.configuration);

            Box::pin(async move {
                let session_key = extract_session_key(&req, &configuration.cookie);
                let (session_key, session_state) =
                    load_session_state(session_key, storage_backend.as_ref()).await?;

                Session::set_session(&mut req, session_state);

                let mut res = service.call(req).await?;
                let (status, session_state) = Session::get_changes(&mut res);

                match session_key {
                    None => {
                        // we do not create an entry in the session store if there is no state attached
                        // to a fresh session
                        if !session_state.is_empty() {
                            let session_key = storage_backend
                                .save(session_state, &configuration.session.state_ttl)
                                .await
                                .map_err(e500)?;

                            set_session_cookie(
                                res.response_mut().head_mut(),
                                session_key,
                                &configuration.cookie,
                            )
                            .map_err(e500)?;
                        }
                    }

                    Some(session_key) => {
                        match status {
                            SessionStatus::Changed => {
                                let session_key = storage_backend
                                    .update(
                                        session_key,
                                        session_state,
                                        &configuration.session.state_ttl,
                                    )
                                    .await
                                    .map_err(e500)?;

                                set_session_cookie(
                                    res.response_mut().head_mut(),
                                    session_key,
                                    &configuration.cookie,
                                )
                                .map_err(e500)?;
                            }

                            SessionStatus::Purged => {
                                storage_backend.delete(&session_key).await.map_err(e500)?;

                                delete_session_cookie(
                                    res.response_mut().head_mut(),
                                    &configuration.cookie,
                                )
                                .map_err(e500)?;
                            }

                            SessionStatus::Renewed => {
                                storage_backend.delete(&session_key).await.map_err(e500)?;

                                let session_key = storage_backend
                                    .save(session_state, &configuration.session.state_ttl)
                                    .await
                                    .map_err(e500)?;

                                set_session_cookie(
                                    res.response_mut().head_mut(),
                                    session_key,
                                    &configuration.cookie,
                                )
                                .map_err(e500)?;
                            }

                            SessionStatus::Unchanged => {
                                if matches!(
                                    configuration.ttl_extension_policy,
                                    TtlExtensionPolicy::OnEveryRequest
                                ) {
                                    storage_backend
                                        .update_ttl(&session_key, &configuration.session.state_ttl)
                                        .await
                                        .map_err(e500)?;

                                    if configuration.cookie.max_age.is_some() {
                                        set_session_cookie(
                                            res.response_mut().head_mut(),
                                            session_key,
                                            &configuration.cookie,
                                        )
                                        .map_err(e500)?;
                                    }
                                }
                            }
                        };
                    }
                }

                Ok(res)
            })
        }
    }

    /// Examines the session cookie attached to the incoming request, if there is one, and tries
    /// to extract the session key.
    ///
    /// It returns `None` if there is no session cookie or if the session cookie is considered invalid
    /// (e.g., when failing a signature check).
    fn extract_session_key(req: &ServiceRequest, config: &CookieConfiguration) -> Option<SessionKey> {
        let cookies = req.cookies().ok()?;
        let session_cookie = cookies
            .iter()
            .find(|&cookie| cookie.name() == config.name)?;

        let mut jar = CookieJar::new();
        jar.add_original(session_cookie.clone());

        let verification_result = match config.content_security {
            CookieContentSecurity::Signed => jar.signed(&config.key).get(&config.name),
            CookieContentSecurity::Private => jar.private(&config.key).get(&config.name),
        };

        if verification_result.is_none() {
            tracing::warn!(
                "The session cookie attached to the incoming request failed to pass cryptographic \
                checks (signature verification/decryption)."
            );
        }

        match verification_result?.value().to_owned().try_into() {
            Ok(session_key) => Some(session_key),
            Err(err) => {
                tracing::warn!(
                    error.message = %err,
                    error.cause_chain = ?err,
                    "Invalid session key, ignoring."
                );

                None
            }
        }
    }

    async fn load_session_state<Store: SessionStore>(
        session_key: Option<SessionKey>,
        storage_backend: &Store,
    ) -> Result<(Option<SessionKey>, HashMap<String, String>), actix_web::Error> {
        if let Some(session_key) = session_key {
            match storage_backend.load(&session_key).await {
                Ok(state) => {
                    if let Some(state) = state {
                        Ok((Some(session_key), state))
                    } else {
                        // We discard the existing session key given that the state attached to it can
                        // no longer be found (e.g. it expired or we suffered some data loss in the
                        // storage). Regenerating the session key will trigger the `save` workflow
                        // instead of the `update` workflow if the session state is modified during the
                        // lifecycle of the current request.

                        tracing::info!(
                            "No session state has been found for a valid session key, creating a new \
                            empty session."
                        );

                        Ok((None, HashMap::new()))
                    }
                }

                Err(err) => match err {
                    LoadError::Deserialization(err) => {
                        tracing::warn!(
                            error.message = %err,
                            error.cause_chain = ?err,
                            "Invalid session state, creating a new empty session."
                        );

                        Ok((Some(session_key), HashMap::new()))
                    }

                    LoadError::Other(err) => Err(e500(err)),
                },
            }
        } else {
            Ok((None, HashMap::new()))
        }
    }

    fn set_session_cookie(
        response: &mut ResponseHead,
        session_key: SessionKey,
        config: &CookieConfiguration,
    ) -> Result<(), anyhow::Error> {
        let value: String = session_key.into();
        let mut cookie = Cookie::new(config.name.clone(), value);

        cookie.set_secure(config.secure);
        cookie.set_http_only(config.http_only);
        cookie.set_same_site(config.same_site);
        cookie.set_path(config.path.clone());

        if let Some(max_age) = config.max_age {
            cookie.set_max_age(max_age);
        }

        if let Some(ref domain) = config.domain {
            cookie.set_domain(domain.clone());
        }

        let mut jar = CookieJar::new();
        match config.content_security {
            CookieContentSecurity::Signed => jar.signed_mut(&config.key).add(cookie),
            CookieContentSecurity::Private => jar.private_mut(&config.key).add(cookie),
        }

        // set cookie
        let cookie = jar.delta().next().unwrap();
        let val = HeaderValue::from_str(&cookie.encoded().to_string())
            .context("Failed to attach a session cookie to the outgoing response")?;

        response.headers_mut().append(SET_COOKIE, val);

        Ok(())
    }

    fn delete_session_cookie(
        response: &mut ResponseHead,
        config: &CookieConfiguration,
    ) -> Result<(), anyhow::Error> {
        let removal_cookie = Cookie::build(config.name.clone(), "")
            .path(config.path.clone())
            .http_only(config.http_only);

        let mut removal_cookie = if let Some(ref domain) = config.domain {
            removal_cookie.domain(domain)
        } else {
            removal_cookie
        }
        .finish();

        removal_cookie.make_removal();

        let val = HeaderValue::from_str(&removal_cookie.to_string())
            .context("Failed to attach a session removal cookie to the outgoing response")?;
        response.headers_mut().append(SET_COOKIE, val);

        Ok(())
    }