      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
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595
    596
    597
    598
    599
    600
    601
    602
    603
    604
    605
    606
    607
    608
    609
    610
    611
    612
    613
    614
    615

    //! User sessions.
    //!
    //! Actix provides a general solution for session management. The
    //! [**SessionStorage**](struct.SessionStorage.html)
    //! middleware can be used with different backend types to store session
    //! data in different backends.
    //!
    //! By default, only cookie session backend is implemented. Other
    //! backend implementations can be added.
    //!
    //! [**CookieSessionBackend**](struct.CookieSessionBackend.html)
    //! uses cookies as session storage. `CookieSessionBackend` creates sessions
    //! which are limited to storing fewer than 4000 bytes of data, as the payload
    //! must fit into a single cookie. An internal server error is generated if a
    //! session contains more than 4000 bytes.
    //!
    //! A cookie may have a security policy of *signed* or *private*. Each has
    //! a respective `CookieSessionBackend` constructor.
    //!
    //! A *signed* cookie may be viewed but not modified by the client. A *private*
    //! cookie may neither be viewed nor modified by the client.
    //!
    //! The constructors take a key as an argument. This is the private key
    //! for cookie session - when this value is changed, all session data is lost.
    //!
    //! In general, you create a `SessionStorage` middleware and initialize it
    //! with specific backend implementation, such as a `CookieSessionBackend`.
    //! To access session data,
    //! [*HttpRequest::session()*](trait.RequestSession.html#tymethod.session)
    //! must be used. This method returns a
    //! [*Session*](struct.Session.html) object, which allows us to get or set
    //! session data.
    //!
    //! ```rust
    //! # extern crate actix_web;
    //! use actix_web::{actix, server, App, HttpRequest, Result};
    //! use actix_web::middleware::session::{RequestSession, SessionStorage, CookieSessionBackend};
    //!
    //! fn index(req: HttpRequest) -> Result<&'static str> {
    //!     // access session data
    //!     if let Some(count) = req.session().get::<i32>("counter")? {
    //!         println!("SESSION value: {}", count);
    //!         req.session().set("counter", count+1)?;
    //!     } else {
    //!         req.session().set("counter", 1)?;
    //!     }
    //!
    //!     Ok("Welcome!")
    //! }
    //!
    //! fn main() {
    //!     actix::System::run(|| {
    //!         server::new(
    //!           || App::new().middleware(
    //!               SessionStorage::new(          // <- create session middleware
    //!                 CookieSessionBackend::signed(&[0; 32]) // <- create signed cookie session backend
    //!                     .secure(false)
    //!              )))
    //!             .bind("127.0.0.1:59880").unwrap()
    //!             .start();
    //! #         actix::System::current().stop();
    //!     });
    //! }
    //! ```
    use std::cell::RefCell;
    use std::collections::HashMap;
    use std::marker::PhantomData;
    use std::rc::Rc;
    use std::sync::Arc;

    use cookie::{Cookie, CookieJar, Key, SameSite};
    use futures::future::{err as FutErr, ok as FutOk, FutureResult};
    use futures::Future;
    use http::header::{self, HeaderValue};
    use serde::de::DeserializeOwned;
    use serde::Serialize;
    use serde_json;
    use serde_json::error::Error as JsonError;
    use time::Duration;

    use error::{Error, ResponseError, Result};
    use handler::FromRequest;
    use httprequest::HttpRequest;
    use httpresponse::HttpResponse;
    use middleware::{Middleware, Response, Started};

    /// The helper trait to obtain your session data from a request.
    ///
    /// ```rust
    /// use actix_web::middleware::session::RequestSession;
    /// use actix_web::*;
    ///
    /// fn index(mut req: HttpRequest) -> Result<&'static str> {
    ///     // access session data
    ///     if let Some(count) = req.session().get::<i32>("counter")? {
    ///         req.session().set("counter", count + 1)?;
    ///     } else {
    ///         req.session().set("counter", 1)?;
    ///     }
    ///
    ///     Ok("Welcome!")
    /// }
    /// # fn main() {}
    /// ```
    pub trait RequestSession {
        /// Get the session from the request
        fn session(&self) -> Session;
    }

    impl<S> RequestSession for HttpRequest<S> {
        fn session(&self) -> Session {
            if let Some(s_impl) = self.extensions().get::<Arc<SessionImplCell>>() {
                return Session(SessionInner::Session(Arc::clone(&s_impl)));
            }
            Session(SessionInner::None)
        }
    }

    /// The high-level interface you use to modify session data.
    ///
    /// Session object could be obtained with
    /// [`RequestSession::session`](trait.RequestSession.html#tymethod.session)
    /// method. `RequestSession` trait is implemented for `HttpRequest`.
    ///
    /// ```rust
    /// use actix_web::middleware::session::RequestSession;
    /// use actix_web::*;
    ///
    /// fn index(mut req: HttpRequest) -> Result<&'static str> {
    ///     // access session data
    ///     if let Some(count) = req.session().get::<i32>("counter")? {
    ///         req.session().set("counter", count + 1)?;
    ///     } else {
    ///         req.session().set("counter", 1)?;
    ///     }
    ///
    ///     Ok("Welcome!")
    /// }
    /// # fn main() {}
    /// ```
    pub struct Session(SessionInner);

    enum SessionInner {
        Session(Arc<SessionImplCell>),
        None,
    }

    impl Session {
        /// Get a `value` from the session.
        pub fn get<T: DeserializeOwned>(&self, key: &str) -> Result<Option<T>> {
            match self.0 {
                SessionInner::Session(ref sess) => {
                    if let Some(s) = sess.as_ref().0.borrow().get(key) {
                        Ok(Some(serde_json::from_str(s)?))
                    } else {
                        Ok(None)
                    }
                }
                SessionInner::None => Ok(None),
            }
        }

        /// Set a `value` from the session.
        pub fn set<T: Serialize>(&self, key: &str, value: T) -> Result<()> {
            match self.0 {
                SessionInner::Session(ref sess) => {
                    sess.as_ref()
                        .0
                        .borrow_mut()
                        .set(key, serde_json::to_string(&value)?);
                    Ok(())
                }
                SessionInner::None => Ok(()),
            }
        }

        /// Remove value from the session.
        pub fn remove(&self, key: &str) {
            match self.0 {
                SessionInner::Session(ref sess) => sess.as_ref().0.borrow_mut().remove(key),
                SessionInner::None => (),
            }
        }

        /// Clear the session.
        pub fn clear(&self) {
            match self.0 {
                SessionInner::Session(ref sess) => sess.as_ref().0.borrow_mut().clear(),
                SessionInner::None => (),
            }
        }
    }

    /// Extractor implementation for Session type.
    ///
    /// ```rust
    /// # use actix_web::*;
    /// use actix_web::middleware::session::Session;
    ///
    /// fn index(session: Session) -> Result<&'static str> {
    ///     // access session data
    ///     if let Some(count) = session.get::<i32>("counter")? {
    ///         session.set("counter", count + 1)?;
    ///     } else {
    ///         session.set("counter", 1)?;
    ///     }
    ///
    ///     Ok("Welcome!")
    /// }
    /// # fn main() {}
    /// ```
    impl<S> FromRequest<S> for Session {
        type Config = ();
        type Result = Session;

        #[inline]
        fn from_request(req: &HttpRequest<S>, _: &Self::Config) -> Self::Result {
            req.session()
        }
    }

    struct SessionImplCell(RefCell<Box<SessionImpl>>);

    /// Session storage middleware
    ///
    /// ```rust
    /// # extern crate actix_web;
    /// use actix_web::middleware::session::{CookieSessionBackend, SessionStorage};
    /// use actix_web::App;
    ///
    /// fn main() {
    ///     let app = App::new().middleware(SessionStorage::new(
    ///         // <- create session middleware
    ///         CookieSessionBackend::signed(&[0; 32]) // <- create cookie session backend
    ///               .secure(false),
    ///     ));
    /// }
    /// ```
    pub struct SessionStorage<T, S>(T, PhantomData<S>);

    impl<S, T: SessionBackend<S>> SessionStorage<T, S> {
        /// Create session storage
        pub fn new(backend: T) -> SessionStorage<T, S> {
            SessionStorage(backend, PhantomData)
        }
    }

    impl<S: 'static, T: SessionBackend<S>> Middleware<S> for SessionStorage<T, S> {
        fn start(&self, req: &HttpRequest<S>) -> Result<Started> {
            let mut req = req.clone();

            let fut = self.0.from_request(&mut req).then(move |res| match res {
                Ok(sess) => {
                    req.extensions_mut()
                        .insert(Arc::new(SessionImplCell(RefCell::new(Box::new(sess)))));
                    FutOk(None)
                }
                Err(err) => FutErr(err),
            });
            Ok(Started::Future(Box::new(fut)))
        }

        fn response(&self, req: &HttpRequest<S>, resp: HttpResponse) -> Result<Response> {
            if let Some(s_box) = req.extensions().get::<Arc<SessionImplCell>>() {
                s_box.0.borrow_mut().write(resp)
            } else {
                Ok(Response::Done(resp))
            }
        }
    }

    /// A simple key-value storage interface that is internally used by `Session`.
    #[doc(hidden)]
    pub trait SessionImpl: 'static {
        fn get(&self, key: &str) -> Option<&str>;

        fn set(&mut self, key: &str, value: String);

        fn remove(&mut self, key: &str);

        fn clear(&mut self);

        /// Write session to storage backend.
        fn write(&self, resp: HttpResponse) -> Result<Response>;
    }

    /// Session's storage backend trait definition.
    #[doc(hidden)]
    pub trait SessionBackend<S>: Sized + 'static {
        type Session: SessionImpl;
        type ReadFuture: Future<Item = Self::Session, Error = Error>;

        /// Parse the session from request and load data from a storage backend.
        fn from_request(&self, request: &mut HttpRequest<S>) -> Self::ReadFuture;
    }

    /// Session that uses signed cookies as session storage
    pub struct CookieSession {
        changed: bool,
        state: HashMap<String, String>,
        inner: Rc<CookieSessionInner>,
    }

    /// Errors that can occur during handling cookie session
    #[derive(Fail, Debug)]
    pub enum CookieSessionError {
        /// Size of the serialized session is greater than 4000 bytes.
        #[fail(display = "Size of the serialized session is greater than 4000 bytes.")]
        Overflow,
        /// Fail to serialize session.
        #[fail(display = "Fail to serialize session")]
        Serialize(JsonError),
    }

    impl ResponseError for CookieSessionError {}

    impl SessionImpl for CookieSession {
        fn get(&self, key: &str) -> Option<&str> {
            if let Some(s) = self.state.get(key) {
                Some(s)
            } else {
                None
            }
        }

        fn set(&mut self, key: &str, value: String) {
            self.changed = true;
            self.state.insert(key.to_owned(), value);
        }

        fn remove(&mut self, key: &str) {
            self.changed = true;
            self.state.remove(key);
        }

        fn clear(&mut self) {
            self.changed = true;
            self.state.clear()
        }

        fn write(&self, mut resp: HttpResponse) -> Result<Response> {
            if self.changed {
                let _ = self.inner.set_cookie(&mut resp, &self.state);
            }
            Ok(Response::Done(resp))
        }
    }

    enum CookieSecurity {
        Signed,
        Private,
    }

    struct CookieSessionInner {
        key: Key,
        security: CookieSecurity,
        name: String,
        path: String,
        domain: Option<String>,
        secure: bool,
        http_only: bool,
        max_age: Option<Duration>,
        same_site: Option<SameSite>,
    }

    impl CookieSessionInner {
        fn new(key: &[u8], security: CookieSecurity) -> CookieSessionInner {
            CookieSessionInner {
                security,
                key: Key::from_master(key),
                name: "actix-session".to_owned(),
                path: "/".to_owned(),
                domain: None,
                secure: true,
                http_only: true,
                max_age: None,
                same_site: None,
            }
        }

        fn set_cookie(
            &self, resp: &mut HttpResponse, state: &HashMap<String, String>,
        ) -> Result<()> {
            let value =
                serde_json::to_string(&state).map_err(CookieSessionError::Serialize)?;
            if value.len() > 4064 {
                return Err(CookieSessionError::Overflow.into());
            }

            let mut cookie = Cookie::new(self.name.clone(), value);
            cookie.set_path(self.path.clone());
            cookie.set_secure(self.secure);
            cookie.set_http_only(self.http_only);

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

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

            if let Some(same_site) = self.same_site {
                cookie.set_same_site(same_site);
            }

            let mut jar = CookieJar::new();

            match self.security {
                CookieSecurity::Signed => jar.signed(&self.key).add(cookie),
                CookieSecurity::Private => jar.private(&self.key).add(cookie),
            }

            for cookie in jar.delta() {
                let val = HeaderValue::from_str(&cookie.encoded().to_string())?;
                resp.headers_mut().append(header::SET_COOKIE, val);
            }

            Ok(())
        }

        fn load<S>(&self, req: &mut HttpRequest<S>) -> HashMap<String, String> {
            if let Ok(cookies) = req.cookies() {
                for cookie in cookies.iter() {
                    if cookie.name() == self.name {
                        let mut jar = CookieJar::new();
                        jar.add_original(cookie.clone());

                        let cookie_opt = match self.security {
                            CookieSecurity::Signed => jar.signed(&self.key).get(&self.name),
                            CookieSecurity::Private => {
                                jar.private(&self.key).get(&self.name)
                            }
                        };
                        if let Some(cookie) = cookie_opt {
                            if let Ok(val) = serde_json::from_str(cookie.value()) {
                                return val;
                            }
                        }
                    }
                }
            }
            HashMap::new()
        }
    }

    /// Use cookies for session storage.
    ///
    /// `CookieSessionBackend` creates sessions which are limited to storing
    /// fewer than 4000 bytes of data (as the payload must fit into a single
    /// cookie). An Internal Server Error is generated if the session contains more
    /// than 4000 bytes.
    ///
    /// A cookie may have a security policy of *signed* or *private*. Each has a
    /// respective `CookieSessionBackend` constructor.
    ///
    /// A *signed* cookie is stored on the client as plaintext alongside
    /// a signature such that the cookie may be viewed but not modified by the
    /// client.
    ///
    /// A *private* cookie is stored on the client as encrypted text
    /// such that it may neither be viewed nor modified by the client.
    ///
    /// The constructors take a key as an argument.
    /// This is the private key for cookie session - when this value is changed,
    /// all session data is lost. The constructors will panic if the key is less
    /// than 32 bytes in length.
    ///
    /// The backend relies on `cookie` crate to create and read cookies.
    /// By default all cookies are percent encoded, but certain symbols may
    /// cause troubles when reading cookie, if they are not properly percent encoded.
    ///
    /// # Example
    ///
    /// ```rust
    /// # extern crate actix_web;
    /// use actix_web::middleware::session::CookieSessionBackend;
    ///
    /// # fn main() {
    /// let backend: CookieSessionBackend = CookieSessionBackend::signed(&[0; 32])
    ///     .domain("www.rust-lang.org")
    ///     .name("actix_session")
    ///     .path("/")
    ///     .secure(true);
    /// # }
    /// ```
    pub struct CookieSessionBackend(Rc<CookieSessionInner>);

    impl CookieSessionBackend {
        /// Construct new *signed* `CookieSessionBackend` instance.
        ///
        /// Panics if key length is less than 32 bytes.
        pub fn signed(key: &[u8]) -> CookieSessionBackend {
            CookieSessionBackend(Rc::new(CookieSessionInner::new(
                key,
                CookieSecurity::Signed,
            )))
        }

        /// Construct new *private* `CookieSessionBackend` instance.
        ///
        /// Panics if key length is less than 32 bytes.
        pub fn private(key: &[u8]) -> CookieSessionBackend {
            CookieSessionBackend(Rc::new(CookieSessionInner::new(
                key,
                CookieSecurity::Private,
            )))
        }

        /// Sets the `path` field in the session cookie being built.
        pub fn path<S: Into<String>>(mut self, value: S) -> CookieSessionBackend {
            Rc::get_mut(&mut self.0).unwrap().path = value.into();
            self
        }

        /// Sets the `name` field in the session cookie being built.
        pub fn name<S: Into<String>>(mut self, value: S) -> CookieSessionBackend {
            Rc::get_mut(&mut self.0).unwrap().name = value.into();
            self
        }

        /// Sets the `domain` field in the session cookie being built.
        pub fn domain<S: Into<String>>(mut self, value: S) -> CookieSessionBackend {
            Rc::get_mut(&mut self.0).unwrap().domain = Some(value.into());
            self
        }

        /// Sets the `secure` field in the session cookie being built.
        ///
        /// If the `secure` field is set, a cookie will only be transmitted when the
        /// connection is secure - i.e. `https`
        pub fn secure(mut self, value: bool) -> CookieSessionBackend {
            Rc::get_mut(&mut self.0).unwrap().secure = value;
            self
        }

        /// Sets the `http_only` field in the session cookie being built.
        pub fn http_only(mut self, value: bool) -> CookieSessionBackend {
            Rc::get_mut(&mut self.0).unwrap().http_only = value;
            self
        }

        /// Sets the `same_site` field in the session cookie being built.
        pub fn same_site(mut self, value: SameSite) -> CookieSessionBackend {
            Rc::get_mut(&mut self.0).unwrap().same_site = Some(value);
            self
        }

        /// Sets the `max-age` field in the session cookie being built.
        pub fn max_age(mut self, value: Duration) -> CookieSessionBackend {
            Rc::get_mut(&mut self.0).unwrap().max_age = Some(value);
            self
        }
    }

    impl<S> SessionBackend<S> for CookieSessionBackend {
        type Session = CookieSession;
        type ReadFuture = FutureResult<CookieSession, Error>;

        fn from_request(&self, req: &mut HttpRequest<S>) -> Self::ReadFuture {
            let state = self.0.load(req);
            FutOk(CookieSession {
                changed: false,
                inner: Rc::clone(&self.0),
                state,
            })
        }
    }

    #[cfg(test)]
    mod tests {
        use super::*;
        use application::App;
        use test;

        #[test]
        fn cookie_session() {
            let mut srv = test::TestServer::with_factory(|| {
                App::new()
                    .middleware(SessionStorage::new(
                        CookieSessionBackend::signed(&[0; 32]).secure(false),
                    ))
                    .resource("/", |r| {
                        r.f(|req| {
                            let _ = req.session().set("counter", 100);
                            "test"
                        })
                    })
            });

            let request = srv.get().uri(srv.url("/")).finish().unwrap();
            let response = srv.execute(request.send()).unwrap();
            assert!(response.cookie("actix-session").is_some());
        }

        #[test]
        fn cookie_session_extractor() {
            let mut srv = test::TestServer::with_factory(|| {
                App::new()
                    .middleware(SessionStorage::new(
                        CookieSessionBackend::signed(&[0; 32]).secure(false),
                    ))
                    .resource("/", |r| {
                        r.with(|ses: Session| {
                            let _ = ses.set("counter", 100);
                            "test"
                        })
                    })
            });

            let request = srv.get().uri(srv.url("/")).finish().unwrap();
            let response = srv.execute(request.send()).unwrap();
            assert!(response.cookie("actix-session").is_some());
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)