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
use chrono::{DateTime, Duration, Utc};
use std::fmt::Debug;
use std::mem;
/// A session with a client.
/// This type handles the creation, updating and deletion of sessions.
/// It is marked `#[must_use]`, as dropping it will not update the session store.
/// Instead, it should be passed to [`SessionStore::store_session`](crate::session_store::SessionStore::store_session).
///
/// `SessionData` is the data associated with a session.
/// `COOKIE_LENGTH` is the length of the session cookie, in characters.
/// The default choice is 32, which is secure.
/// It should be a multiple of 32, which is the block size of blake3.
#[derive(Debug, Clone)]
#[must_use]
pub struct Session<SessionData, const COOKIE_LENGTH: usize = 32> {
pub(crate) state: SessionState<SessionData>,
}
#[derive(Debug, Clone)]
pub(crate) enum SessionState<SessionData> {
/// The session was newly generated for this request, and at most the expiry was written to.
/// In this state, the session does not necessarily need to be communicated to the client.
NewUnchanged {
expiry: SessionExpiry,
data: SessionData,
},
/// The session was newly generated for this request, and the data was written to.
/// In this state, the session must be communicated to the client.
NewChanged {
expiry: SessionExpiry,
data: SessionData,
},
/// The session was loaded from the session store, and was not changed.
Unchanged {
current_id: SessionId,
expiry: SessionExpiry,
data: SessionData,
},
/// The session was loaded from the session store, and was changed.
/// Either the expiry datetime or the data have changed.
Changed {
current_id: SessionId,
expiry: SessionExpiry,
data: SessionData,
},
/// The session was marked for deletion.
Deleted { current_id: SessionId },
/// The session was marked for deletion before it was ever communicated to database or client.
NewDeleted,
/// Used internally to avoid unsafe code when replacing the session state through a mutable reference.
Invalid,
}
/// The expiry of a session.
/// Either a given date and time, or never.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum SessionExpiry {
/// The session expires at the given date and time.
DateTime(DateTime<Utc>),
/// The session never expires, unless it is explicitly deleted.
Never,
}
/// The type of a session id.
pub type SessionIdType = [u8; blake3::OUT_LEN];
/// A session id.
#[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct SessionId(Box<SessionIdType>);
impl<SessionData, const COOKIE_LENGTH: usize> Session<SessionData, COOKIE_LENGTH> {
/// Extract the optionally associated data and expiry while consuming the session.
///
/// **This function is supposed to be used in tests only.**
/// This loses the association of the data to the actual session, making it useless for most
/// purposes.
pub fn into_data_expiry_pair(self) -> (Option<SessionData>, Option<SessionExpiry>) {
self.state.into_data_expiry_pair()
}
}
impl<SessionData: Default, const COOKIE_LENGTH: usize> Session<SessionData, COOKIE_LENGTH> {
/// Create a new session with default data. Does not set an expiry.
/// Using this method does not mark the session as changed, i.e. it will be silently dropped if
/// neither the data nor the expiry are accessed mutably.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { use typed_session::SessionExpiry;
/// # async_std::task::block_on(async {
/// let session: Session<i32> = Session::new();
/// assert_eq!(&SessionExpiry::Never, session.expiry());
/// assert_eq!(i32::default(), *session.data());
/// # Ok(()) }) }
pub fn new() -> Self {
Self {
state: SessionState::new(),
}
}
}
impl<SessionData, const COOKIE_LENGTH: usize> Session<SessionData, COOKIE_LENGTH> {
/// Create a new session with the given session data. Does not set an expiry.
/// Using this method marks the session as changed, i.e. it will be stored in the backend and
/// communicated to the client even if it was created with default data and never accessed mutably.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { use typed_session::SessionExpiry;
/// # async_std::task::block_on(async {
/// let session: Session<_> = Session::new_with_data(4);
/// assert_eq!(&SessionExpiry::Never, session.expiry());
/// assert_eq!(4, *session.data());
/// # Ok(()) }) }
pub fn new_with_data(data: SessionData) -> Self {
Self {
state: SessionState::new_with_data(data),
}
}
/// **This method should only be called by a session store!**
///
/// Create a session instance from parts loaded by a session store.
/// The session state will be `Unchanged`.
pub fn new_from_session_store(
current_id: SessionId,
expiry: SessionExpiry,
data: SessionData,
) -> Self {
Self {
state: SessionState::new_from_session_store(current_id, expiry, data),
}
}
/// Returns true if this session is marked for destruction.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert!(!session.is_deleted());
/// session.delete();
/// assert!(session.is_deleted());
/// # Ok(()) }) }
pub fn is_deleted(&self) -> bool {
self.state.is_deleted()
}
/// Returns true if this session was changed since it was loaded from the session store.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert!(!session.is_changed());
/// session.data_mut();
/// assert!(session.is_changed());
/// # Ok(()) }) }
pub fn is_changed(&self) -> bool {
self.state.is_changed()
}
/// Returns true if this session was changed since it was loaded from the session store, or if it is marked for destruction.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert!(!session.is_changed_or_deleted());
/// session.data_mut();
/// assert!(session.is_changed_or_deleted());
/// let mut session: Session<()> = Session::new();
/// assert!(!session.is_changed_or_deleted());
/// session.delete();
/// assert!(session.is_changed_or_deleted());
/// # Ok(()) }) }
pub fn is_changed_or_deleted(&self) -> bool {
self.state.is_changed_or_deleted()
}
}
impl<SessionData: Debug, const COOKIE_LENGTH: usize> Session<SessionData, COOKIE_LENGTH> {
/// Returns the expiry timestamp of this session, if there is one.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { use chrono::Utc;
/// # use typed_session::SessionExpiry;
/// # async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert_eq!(&SessionExpiry::Never, session.expiry());
/// session.expire_in(Utc::now(), std::time::Duration::from_secs(1));
/// assert!(matches!(session.expiry(), SessionExpiry::DateTime { .. }));
/// # Ok(()) }) }
/// ```
pub fn expiry(&self) -> &SessionExpiry {
self.state.expiry()
}
/// Returns a reference to the data associated with this session.
/// This does not mark the session as changed.
pub fn data(&self) -> &SessionData {
self.state.data()
}
/// Returns a mutable reference to the data associated with this session,
/// and marks the session as changed.
///
/// Note that the session gets marked as changed, even if the returned reference is never written to.
///
/// **Panics** if the session was marked for deletion before.
pub fn data_mut(&mut self) -> &mut SessionData {
self.state.data_mut()
}
/// Mark this session for destruction.
/// Further access to this session will result in a panic.
/// Note that the session is only deleted from the session store if [`SessionStore::store_session`](crate::session_store::SessionStore::store_session) is called.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert!(!session.is_deleted());
/// session.delete();
/// assert!(session.is_deleted());
/// # Ok(()) }) }
pub fn delete(&mut self) {
self.state.delete();
}
/// Forces the generation of a new id and cookie for this session, unless the session is new and its data was not accessed mutably.
pub fn regenerate(&mut self) {
// Calling this marks the state as changed, unless it is new and its data was not accessed mutably.
self.state.change_expiry();
}
/// Updates the expiry timestamp of this session.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { use typed_session::SessionExpiry;
/// # async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert_eq!(&SessionExpiry::Never, session.expiry());
/// session.set_expiry(chrono::Utc::now());
/// assert!(matches!(session.expiry(), SessionExpiry::DateTime { .. }));
/// # Ok(()) }) }
/// ```
pub fn set_expiry(&mut self, expiry: DateTime<Utc>) {
*self.state.expiry_mut() = SessionExpiry::DateTime(expiry);
}
/// Sets this session to never expire.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { use typed_session::SessionExpiry;
/// # async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert_eq!(&SessionExpiry::Never, session.expiry());
/// session.set_expiry(chrono::Utc::now());
/// assert!(matches!(session.expiry(), SessionExpiry::DateTime { .. }));
/// session.do_not_expire();
/// assert!(matches!(session.expiry(), SessionExpiry::Never));
/// # Ok(()) }) }
/// ```
pub fn do_not_expire(&mut self) {
*self.state.expiry_mut() = SessionExpiry::Never;
}
/// Sets this session to expire `ttl` time into the future.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # fn main() -> typed_session::Result { use chrono::Utc;
/// # use typed_session::SessionExpiry;
/// # async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert_eq!(&SessionExpiry::Never, session.expiry());
/// session.expire_in(Utc::now(), std::time::Duration::from_secs(1));
/// assert!(matches!(session.expiry(), SessionExpiry::DateTime { .. }));
/// # Ok(()) }) }
/// ```
pub fn expire_in(&mut self, now: DateTime<Utc>, ttl: std::time::Duration) {
*self.state.expiry_mut() = SessionExpiry::DateTime(now + Duration::from_std(ttl).unwrap());
}
/// Return true if the session is expired.
/// The session is expired if it has an expiry timestamp that is in the future.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # use std::time::Duration;
/// # use async_std::task;
/// # fn main() -> typed_session::Result { use chrono::Utc;
/// # use typed_session::SessionExpiry;
/// # async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// assert_eq!(&SessionExpiry::Never, session.expiry());
/// assert!(!session.is_expired(Utc::now()));
/// session.expire_in(Utc::now(), Duration::from_secs(1));
/// assert!(!session.is_expired(Utc::now()));
/// task::sleep(Duration::from_secs(2)).await;
/// assert!(session.is_expired(Utc::now()));
/// # Ok(()) }) }
/// ```
pub fn is_expired(&self, now: DateTime<Utc>) -> bool {
match self.state.expiry() {
SessionExpiry::DateTime(expiry) => *expiry < now,
SessionExpiry::Never => false,
}
}
/// Returns the duration from now to the expiry time of this session.
/// Returns `None` if it is expired.
///
/// # Example
///
/// ```rust
/// # use typed_session::Session;
/// # use std::time::Duration;
/// # use async_std::task;
/// # fn main() -> typed_session::Result { use chrono::Utc;
/// # async_std::task::block_on(async {
/// let mut session: Session<()> = Session::new();
/// session.expire_in(Utc::now(), Duration::from_secs(123));
/// let expires_in = session.expires_in(Utc::now()).unwrap();
/// assert!(123 - expires_in.as_secs() < 2);
/// # Ok(()) }) }
/// ```
pub fn expires_in(&self, now: DateTime<Utc>) -> Option<std::time::Duration> {
match self.state.expiry() {
SessionExpiry::DateTime(date_time) => {
let duration = date_time.signed_duration_since(now);
if duration > Duration::zero() {
Some(duration.to_std().unwrap())
} else {
None
}
}
SessionExpiry::Never => None,
}
}
}
impl<SessionData: Default, const COOKIE_LENGTH: usize> Default
for Session<SessionData, COOKIE_LENGTH>
{
fn default() -> Self {
Self::new()
}
}
impl<SessionData: Default> SessionState<SessionData> {
fn new() -> Self {
Self::NewUnchanged {
expiry: SessionExpiry::Never,
data: Default::default(),
}
}
}
impl<SessionData> SessionState<SessionData> {
fn new_with_data(data: SessionData) -> Self {
Self::NewChanged {
expiry: SessionExpiry::Never,
data,
}
}
fn new_from_session_store(
current_id: SessionId,
expiry: SessionExpiry,
data: SessionData,
) -> Self {
Self::Unchanged {
current_id,
expiry,
data,
}
}
fn is_deleted(&self) -> bool {
matches!(self, Self::Deleted { .. } | Self::NewDeleted)
}
fn is_changed(&self) -> bool {
matches!(self, Self::Changed { .. } | Self::NewChanged { .. })
}
fn is_changed_or_deleted(&self) -> bool {
self.is_changed() || self.is_deleted()
}
fn into_data_expiry_pair(self) -> (Option<SessionData>, Option<SessionExpiry>) {
match self {
SessionState::NewUnchanged { data, expiry }
| SessionState::NewChanged { data, expiry }
| SessionState::Unchanged { data, expiry, .. }
| SessionState::Changed { data, expiry, .. } => (Some(data), Some(expiry)),
SessionState::Deleted { .. } | SessionState::NewDeleted => (None, None),
SessionState::Invalid => unreachable!("Invalid state is used internally only"),
}
}
}
impl<SessionData: Debug> SessionState<SessionData> {
fn expiry(&self) -> &SessionExpiry {
match self {
Self::NewUnchanged { expiry, .. }
| Self::NewChanged { expiry, .. }
| Self::Unchanged { expiry, .. }
| Self::Changed { expiry, .. } => expiry,
Self::Deleted { .. } | Self::NewDeleted => {
panic!("Attempted to retrieve the expiry of a purged session {self:?}")
}
Self::Invalid => unreachable!("Invalid state is used internally only"),
}
}
fn expiry_mut(&mut self) -> &mut SessionExpiry {
self.change_expiry();
match self {
Self::NewUnchanged { expiry, .. }
| Self::NewChanged { expiry, .. }
| Self::Changed { expiry, .. } => expiry,
Self::Deleted { .. } | Self::NewDeleted => {
panic!("Attempted to retrieve the expiry of a purged session {self:?}")
}
Self::Unchanged { .. } => {
unreachable!("Cannot be unchanged after explicitly changing expiry")
}
Self::Invalid => unreachable!("Invalid state is used internally only"),
}
}
fn data(&self) -> &SessionData {
match self {
Self::NewUnchanged { data, .. }
| Self::NewChanged { data, .. }
| Self::Unchanged { data, .. }
| Self::Changed { data, .. } => data,
Self::Deleted { .. } | Self::NewDeleted => {
panic!("Attempted to retrieve the data of a purged session {self:?}")
}
Self::Invalid => unreachable!("Invalid state is used internally only"),
}
}
fn data_mut(&mut self) -> &mut SessionData {
self.change_data();
match self {
Self::NewChanged { data, .. } | Self::Changed { data, .. } => data,
Self::Deleted { .. } | Self::NewDeleted => {
panic!("Attempted to retrieve the data of a purged session {self:?}")
}
Self::NewUnchanged { .. } | Self::Unchanged { .. } => {
unreachable!("Cannot be unchanged after explicitly changing")
}
Self::Invalid => unreachable!("Invalid state is used internally only"),
}
}
fn change_expiry(&mut self) {
match self {
Self::Unchanged { .. } => {
let Self::Unchanged { current_id, expiry, data } = mem::replace(self, Self::Invalid) else {unreachable!()};
*self = Self::Changed {
current_id,
expiry,
data,
};
}
Self::Changed { .. } | Self::NewChanged { .. } => { /* Already changed. */ }
Self::NewUnchanged { .. } => { /* Changing expiry is not enough reason to store the session. */
}
Self::Deleted { .. } | Self::NewDeleted => {
panic!("Attempted to change purged session {self:?}")
}
Self::Invalid => unreachable!("Invalid state is used internally only"),
}
}
fn change_data(&mut self) {
match self {
Self::NewUnchanged { .. } => {
let Self::NewUnchanged { expiry, data } = mem::replace(self, Self::Invalid) else {unreachable!()};
*self = Self::NewChanged { expiry, data };
}
Self::Unchanged { .. } => {
let Self::Unchanged { current_id, expiry, data } = mem::replace(self, Self::Invalid) else {unreachable!()};
*self = Self::Changed {
current_id,
expiry,
data,
};
}
Self::Changed { .. } | Self::NewChanged { .. } => { /* Already changed. */ }
Self::Deleted { .. } | Self::NewDeleted => {
panic!("Attempted to change purged session {self:?}")
}
Self::Invalid => unreachable!("Invalid state is used internally only"),
}
}
fn delete(&mut self) {
match self {
Self::NewUnchanged { .. } | Self::NewChanged { .. } => {
*self = Self::NewDeleted;
}
Self::Unchanged { .. } => {
let Self::Unchanged { current_id, .. } = mem::replace(self, Self::Invalid) else { unreachable!() };
*self = Self::Deleted { current_id };
}
Self::Changed { .. } => {
let Self::Changed { current_id, .. } = mem::replace(self, Self::Invalid) else { unreachable!() };
*self = Self::Deleted { current_id };
}
Self::Deleted { .. } | Self::NewDeleted => {
panic!("Attempted to purge a purged session {self:?}")
}
Self::Invalid => unreachable!("Invalid state is used internally only"),
}
}
}
impl SessionId {
/// Applies a cryptographic hash function on a cookie value to obtain the session id for that cookie.
///
/// This is automatically done by the [`SessionStore`](crate::SessionStore), and this function is only public for test purposes.
pub fn from_cookie_value(cookie_value: &str) -> Self {
// The original code used base64 encoded binary ids of length of a multiple of the blake3 block size.
// We do the same, but instead of base64 encoding a binary ids, we use normal alphanumerical ids with a length multiple of the blake3 block size.
// This gives less entropy, but still more than enough to be secure (see crate-level documentation).
let hash = blake3::hash(cookie_value.as_bytes());
Self(Box::new(hash.into()))
}
}
impl From<SessionId> for SessionIdType {
fn from(id: SessionId) -> Self {
*id.0
}
}