    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

    use actix_session::Session;
    use actix_utils::future::{ready, Ready};
    use actix_web::{
        cookie::time::OffsetDateTime,
        dev::{Extensions, Payload},
        http::StatusCode,
        Error, FromRequest, HttpMessage, HttpRequest, HttpResponse,
    };

    use crate::{
        config::LogoutBehaviour,
        error::{
            GetIdentityError, LoginError, LostIdentityError, MissingIdentityError, SessionExpiryError,
        },
    };

    /// A verified user identity. It can be used as a request extractor.
    ///
    /// The lifecycle of a user identity is tied to the lifecycle of the underlying session. If the
    /// session is destroyed (e.g. the session expired), the user identity will be forgotten, de-facto
    /// forcing a user log out.
    ///
    /// # Examples
    /// ```
    /// use actix_web::{
    ///     get, post, Responder, HttpRequest, HttpMessage, HttpResponse
    /// };
    /// use actix_identity::Identity;
    ///
    /// #[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 {
    ///     Identity::login(&request.extensions(), "User1".into());
    ///     HttpResponse::Ok()
    /// }
    ///
    /// #[post("/logout")]
    /// async fn logout(user: Identity) -> impl Responder {
    ///     user.logout();
    ///     HttpResponse::Ok()
    /// }
    /// ```
    ///
    /// # Extractor Behaviour
    /// What happens if you try to extract an `Identity` out of a request that does not have a valid
    /// identity attached? The API will return a `401 UNAUTHORIZED` to the caller.
    ///
    /// If you want to customise this behaviour, consider extracting `Option<Identity>` or
    /// `Result<Identity, actix_web::Error>` instead of a bare `Identity`: you will then be fully in
    /// control of the error path.
    ///
    /// ## Examples
    /// ```
    /// use actix_web::{http::header::LOCATION, get, HttpResponse, Responder};
    /// use actix_identity::Identity;
    ///
    /// #[get("/")]
    /// async fn index(user: Option<Identity>) -> impl Responder {
    ///     if let Some(user) = user {
    ///         HttpResponse::Ok().finish()
    ///     } else {
    ///         // Redirect to login page if unauthenticated
    ///         HttpResponse::TemporaryRedirect()
    ///             .insert_header((LOCATION, "/login"))
    ///             .finish()
    ///     }
    /// }
    /// ```
    pub struct Identity(IdentityInner);

    #[derive(Clone)]
    pub(crate) struct IdentityInner {
        pub(crate) session: Session,
        pub(crate) logout_behaviour: LogoutBehaviour,
        pub(crate) is_login_deadline_enabled: bool,
        pub(crate) is_visit_deadline_enabled: bool,
    }

    impl IdentityInner {
        fn extract(ext: &Extensions) -> Self {
            ext.get::<Self>()
                .expect(
                    "No `IdentityInner` instance was found in the extensions attached to the \
                    incoming request. This usually means that `IdentityMiddleware` has not been \
                    registered as an application middleware via `App::wrap`. `Identity` cannot be used \
                    unless the identity machine is properly mounted: register `IdentityMiddleware` as \
                    a middleware for your application to fix this panic. If the problem persists, \
                    please file an issue on GitHub.",
                )
                .to_owned()
        }

        /// Retrieve the user id attached to the current session.
        fn get_identity(&self) -> Result<String, GetIdentityError> {
            self.session
                .get::<String>(ID_KEY)?
                .ok_or_else(|| MissingIdentityError.into())
        }
    }

    pub(crate) const ID_KEY: &str = "actix_identity.user_id";
    pub(crate) const LAST_VISIT_UNIX_TIMESTAMP_KEY: &str = "actix_identity.last_visited_at";
    pub(crate) const LOGIN_UNIX_TIMESTAMP_KEY: &str = "actix_identity.logged_in_at";

    impl Identity {
        /// Return the user id associated to the current session.
        ///
        /// # Examples
        /// ```
        /// use actix_web::{get, Responder};
        /// use actix_identity::Identity;
        ///
        /// #[get("/")]
        /// async fn index(user: Option<Identity>) -> impl Responder {
        ///     if let Some(user) = user {
        ///         format!("Welcome! {}", user.id().unwrap())
        ///     } else {
        ///         "Welcome Anonymous!".to_owned()
        ///     }
        /// }
        /// ```
        pub fn id(&self) -> Result<String, GetIdentityError> {
            self.0
                .session
                .get(ID_KEY)?
                .ok_or_else(|| LostIdentityError.into())
        }

        /// Attach a valid user identity to the current session.
        ///
        /// This method should be called after you have successfully authenticated the user. After
        /// `login` has been called, the user will be able to access all routes that require a valid
        /// [`Identity`].
        ///
        /// # Examples
        /// ```
        /// use actix_web::{post, Responder, HttpRequest, HttpMessage, HttpResponse};
        /// use actix_identity::Identity;
        ///
        /// #[post("/login")]
        /// async fn login(request: HttpRequest) -> impl Responder {
        ///     Identity::login(&request.extensions(), "User1".into());
        ///     HttpResponse::Ok()
        /// }
        /// ```
        pub fn login(ext: &Extensions, id: String) -> Result<Self, LoginError> {
            let inner = IdentityInner::extract(ext);
            inner.session.insert(ID_KEY, id)?;
            let now = OffsetDateTime::now_utc().unix_timestamp();
            if inner.is_login_deadline_enabled {
                inner.session.insert(LOGIN_UNIX_TIMESTAMP_KEY, now)?;
            }
            if inner.is_visit_deadline_enabled {
                inner.session.insert(LAST_VISIT_UNIX_TIMESTAMP_KEY, now)?;
            }
            inner.session.renew();
            Ok(Self(inner))
        }

        /// Remove the user identity from the current session.
        ///
        /// After `logout` has been called, the user will no longer be able to access routes that
        /// require a valid [`Identity`].
        ///
        /// The behaviour on logout is determined by [`IdentityMiddlewareBuilder::logout_behaviour`].
        ///
        /// # Examples
        /// ```
        /// use actix_web::{post, Responder, HttpResponse};
        /// use actix_identity::Identity;
        ///
        /// #[post("/logout")]
        /// async fn logout(user: Identity) -> impl Responder {
        ///     user.logout();
        ///     HttpResponse::Ok()
        /// }
        /// ```
        ///
        /// [`IdentityMiddlewareBuilder::logout_behaviour`]: crate::config::IdentityMiddlewareBuilder::logout_behaviour
        pub fn logout(self) {
            match self.0.logout_behaviour {
                LogoutBehaviour::PurgeSession => {
                    self.0.session.purge();
                }
                LogoutBehaviour::DeleteIdentityKeys => {
                    self.0.session.remove(ID_KEY);
                    if self.0.is_login_deadline_enabled {
                        self.0.session.remove(LOGIN_UNIX_TIMESTAMP_KEY);
                    }
                    if self.0.is_visit_deadline_enabled {
                        self.0.session.remove(LAST_VISIT_UNIX_TIMESTAMP_KEY);
                    }
                }
            }
        }

        pub(crate) fn extract(ext: &Extensions) -> Result<Self, GetIdentityError> {
            let inner = IdentityInner::extract(ext);
            inner.get_identity()?;
            Ok(Self(inner))
        }

        pub(crate) fn logged_at(&self) -> Result<Option<OffsetDateTime>, GetIdentityError> {
            Ok(self
                .0
                .session
                .get(LOGIN_UNIX_TIMESTAMP_KEY)?
                .map(OffsetDateTime::from_unix_timestamp)
                .transpose()
                .map_err(SessionExpiryError)?)
        }

        pub(crate) fn last_visited_at(&self) -> Result<Option<OffsetDateTime>, GetIdentityError> {
            Ok(self
                .0
                .session
                .get(LAST_VISIT_UNIX_TIMESTAMP_KEY)?
                .map(OffsetDateTime::from_unix_timestamp)
                .transpose()
                .map_err(SessionExpiryError)?)
        }

        pub(crate) fn set_last_visited_at(&self) -> Result<(), LoginError> {
            let now = OffsetDateTime::now_utc().unix_timestamp();
            self.0.session.insert(LAST_VISIT_UNIX_TIMESTAMP_KEY, now)?;
            Ok(())
        }
    }

    /// Extractor implementation for [`Identity`].
    ///
    /// # Examples
    /// ```
    /// use actix_web::{get, Responder};
    /// use actix_identity::Identity;
    ///
    /// #[get("/")]
    /// async fn index(user: Option<Identity>) -> impl Responder {
    ///     if let Some(user) = user {
    ///         format!("Welcome! {}", user.id().unwrap())
    ///     } else {
    ///         "Welcome Anonymous!".to_owned()
    ///     }
    /// }
    /// ```
    impl FromRequest for Identity {
        type Error = Error;
        type Future = Ready<Result<Self, Self::Error>>;

        #[inline]
        fn from_request(req: &HttpRequest, _: &mut Payload) -> Self::Future {
            ready(Identity::extract(&req.extensions()).map_err(|err| {
                let res = actix_web::error::InternalError::from_response(
                    err,
                    HttpResponse::new(StatusCode::UNAUTHORIZED),
                );

                actix_web::Error::from(res)
            }))
        }
    }