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
//! A middleware that provides [`Session`] as a request extension.
use std::{
future::Future,
pin::Pin,
task::{Context, Poll},
};
use http::{Request, Response};
use time::Duration;
use tower_cookies::{cookie::SameSite, Cookie, CookieManager, Cookies};
use tower_layer::Layer;
use tower_service::Service;
use crate::{
session::{SessionDeletion, SessionId},
CookieConfig, Session, SessionStore,
};
/// A middleware that provides [`Session`] as a request extension.
#[derive(Debug, Clone)]
pub struct SessionManager<S, Store: SessionStore> {
inner: S,
session_store: Store,
cookie_config: CookieConfig,
}
impl<S, Store: SessionStore> SessionManager<S, Store> {
/// Create a new [`SessionManager`].
pub fn new(inner: S, session_store: Store, cookie_config: CookieConfig) -> Self {
Self {
inner,
session_store,
cookie_config,
}
}
}
impl<ReqBody, ResBody, S, Store: SessionStore> Service<Request<ReqBody>>
for SessionManager<S, Store>
where
S: Service<Request<ReqBody>, Response = Response<ResBody>> + Clone + Send + 'static,
S::Error: Into<Box<dyn std::error::Error + Send + Sync>> + 'static,
S::Future: Send,
ReqBody: Send + 'static,
ResBody: Send,
{
type Response = S::Response;
type Error = Box<dyn std::error::Error + Send + Sync>;
type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;
#[inline]
fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
self.inner.poll_ready(cx).map_err(Into::into)
}
fn call(&mut self, mut req: Request<ReqBody>) -> Self::Future {
let session_store = self.session_store.clone();
let cookie_config = self.cookie_config.clone();
let clone = self.inner.clone();
let mut inner = std::mem::replace(&mut self.inner, clone);
Box::pin(async move {
let cookies = req
.extensions()
.get::<Cookies>()
.cloned()
.expect("Something has gone wrong with tower-cookies.");
let mut session_loaded_from_store = false;
let mut session = if let Some(session_cookie) =
cookies.get(&cookie_config.name).map(Cookie::into_owned)
{
// We do have a session cookie, so let's see if our store has the associated
// session.
//
// N.B.: Our store will *not* have the session if the session is empty.
let session_id = session_cookie.value().try_into()?;
let session = session_store.load(&session_id).await?;
// If the store does not know about this session, we should remove the cookie.
if session.is_none() {
cookies.remove(session_cookie);
} else {
session_loaded_from_store = true;
}
session
} else {
// We don't have a session cookie, so let's create a new session.
Some((&cookie_config).into())
}
.filter(Session::active)
.unwrap_or_else(|| {
// We either:
//
// 1. Didn't find the session in the store (but had a cookie) or,
// 2. We found a session but it was filtered out by `Session::active`.
//
// In both cases we want to create a new session.
(&cookie_config).into()
});
req.extensions_mut().insert(session.clone());
let res = Ok(inner.call(req).await.map_err(Into::into)?);
if let Some(session_deletion) = session.deleted() {
match session_deletion {
SessionDeletion::Deleted => {
session_store.delete(&session.id()).await?;
cookies.remove(cookie_config.build_cookie(&session));
// Since the session has been deleted, there's no need for further
// processing.
return res;
}
SessionDeletion::Cycled(deleted_id) => {
session_store.delete(&deleted_id).await?;
session.id = SessionId::default();
}
}
};
// In order to ensure removing the last value of a session updates the store, we
// check for an empty session. Empty sessions should be removed from the store.
if session_loaded_from_store && session.is_empty() {
session_store.delete(&session.id()).await?;
cookies.remove(cookie_config.build_cookie(&session));
return res;
}
// For further consideration:
//
// We only persist the session in the store when the `modified` flag is set.
//
// However, we could offer additional configuration of this behavior via an
// extended interface in the future. For instance, we might consider providing
// the `Set-Cookie` header whenever modified or if some "always save" marker is
// set.
if session.modified() {
let session_record = (&session).into();
session_store.save(&session_record).await?;
cookies.add(cookie_config.build_cookie(&session))
}
res
})
}
}
/// A layer for providing [`Session`] as a request extension.
#[derive(Debug, Clone)]
pub struct SessionManagerLayer<Store: SessionStore> {
session_store: Store,
cookie_config: CookieConfig,
}
impl<Store: SessionStore> SessionManagerLayer<Store> {
/// Configures the name of the cookie used for the session.
///
/// # Examples
///
/// ```rust
/// use tower_sessions::{MemoryStore, SessionManagerLayer};
///
/// let session_store = MemoryStore::default();
/// let session_service = SessionManagerLayer::new(session_store).with_name("my.sid");
/// ```
pub fn with_name(mut self, name: &str) -> Self {
self.cookie_config.name = name.to_string();
self
}
/// Configures the `"SameSite"` attribute of the cookie used for the
/// session.
///
/// # Examples
///
/// ```rust
/// use tower_sessions::{cookie::SameSite, MemoryStore, SessionManagerLayer};
///
/// let session_store = MemoryStore::default();
/// let session_service = SessionManagerLayer::new(session_store).with_same_site(SameSite::Lax);
/// ```
pub fn with_same_site(mut self, same_site: SameSite) -> Self {
self.cookie_config.same_site = same_site;
self
}
/// Configures the `"Max-Age"` attribute of the cookie used for the session.
///
/// # Examples
///
/// ```rust
/// use time::Duration;
/// use tower_sessions::{MemoryStore, SessionManagerLayer};
///
/// let session_store = MemoryStore::default();
/// let session_service = SessionManagerLayer::new(session_store).with_max_age(Duration::hours(1));
/// ```
pub fn with_max_age(mut self, max_age: Duration) -> Self {
self.cookie_config.max_age = Some(max_age);
self
}
/// Configures the `"Secure"` attribute of the cookie used for the session.
///
/// # Examples
///
/// ```rust
/// use tower_sessions::{MemoryStore, SessionManagerLayer};
///
/// let session_store = MemoryStore::default();
/// let session_service = SessionManagerLayer::new(session_store).with_secure(true);
/// ```
pub fn with_secure(mut self, secure: bool) -> Self {
self.cookie_config.secure = secure;
self
}
/// Configures the `"Path"` attribute of the cookie used for the session.
///
/// # Examples
///
/// ```rust
/// use tower_sessions::{MemoryStore, SessionManagerLayer};
///
/// let session_store = MemoryStore::default();
/// let session_service =
/// SessionManagerLayer::new(session_store).with_path("/some/path".to_string());
/// ```
pub fn with_path(mut self, path: String) -> Self {
self.cookie_config.path = path;
self
}
/// Configures the `"Domain"` attribute of the cookie used for the session.
///
/// # Examples
///
/// ```rust
/// use tower_sessions::{MemoryStore, SessionManagerLayer};
///
/// let session_store = MemoryStore::default();
/// let session_service =
/// SessionManagerLayer::new(session_store).with_domain("localhost".to_string());
/// ```
pub fn with_domain(mut self, domain: String) -> Self {
self.cookie_config.domain = Some(domain);
self
}
}
impl<Store: SessionStore> SessionManagerLayer<Store> {
/// Create a new [`SessionManagerLayer`] with the provided session store
/// and default cookie configuration.
///
/// # Examples
///
/// ```rust
/// use tower_sessions::{MemoryStore, SessionManagerLayer};
///
/// let session_store = MemoryStore::default();
/// let session_service = SessionManagerLayer::new(session_store);
/// ```
pub fn new(session_store: Store) -> Self {
let cookie_config = CookieConfig::default();
Self {
session_store,
cookie_config,
}
}
}
impl<S, Store: SessionStore> Layer<S> for SessionManagerLayer<Store> {
type Service = CookieManager<SessionManager<S, Store>>;
fn layer(&self, inner: S) -> Self::Service {
let session_manager = SessionManager {
inner,
session_store: self.session_store.clone(),
cookie_config: self.cookie_config.clone(),
};
CookieManager::new(session_manager)
}
}