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
use crate::{
CookiesExt, DatabasePool, SecurityMode, SessionData, SessionID, SessionKey, SessionStore,
};
use async_trait::async_trait;
use axum_core::extract::FromRequestParts;
use cookie::CookieJar;
#[cfg(feature = "key-store")]
use fastbloom_rs::Membership;
use http::{self, request::Parts, StatusCode};
use serde::Serialize;
use std::{
convert::From,
fmt::Debug,
marker::{Send, Sync},
};
use uuid::Uuid;
/// A Session Store.
///
/// Provides a Storage Handler to SessionStore and contains the SessionID(UUID) of the current session.
///
/// This is Auto generated by the Session Layer Upon Service Execution.
#[derive(Debug, Clone)]
pub struct Session<T>
where
T: DatabasePool + Clone + Debug + Sync + Send + 'static,
{
/// The SessionStore that holds all the Sessions.
pub(crate) store: SessionStore<T>,
/// The Sessions current ID for lookng up its store.
pub(crate) id: SessionID,
}
/// Adds FromRequestParts<B> for Session
///
/// Returns the Session from Axums request extensions state.
#[async_trait]
impl<T, S> FromRequestParts<S> for Session<T>
where
T: DatabasePool + Clone + Debug + Sync + Send + 'static,
S: Send + Sync,
{
type Rejection = (http::StatusCode, &'static str);
async fn from_request_parts(parts: &mut Parts, _state: &S) -> Result<Self, Self::Rejection> {
parts.extensions.get::<Session<T>>().cloned().ok_or((
StatusCode::INTERNAL_SERVER_ERROR,
"Can't extract Axum `Session`. Is `SessionLayer` enabled?",
))
}
}
impl<S> Session<S>
where
S: DatabasePool + Clone + Debug + Sync + Send + 'static,
{
#[allow(clippy::needless_pass_by_ref_mut)]
pub(crate) async fn new(
store: &mut SessionStore<S>,
cookies: &CookieJar,
session_key: &SessionKey,
) -> (Self, bool) {
let key = match store.config.security_mode {
SecurityMode::PerSession => Some(session_key.key.clone()),
SecurityMode::Simple => store.config.key.clone(),
};
let value = cookies
.get_cookie(&store.config.cookie_name, &key)
.and_then(|c| Uuid::parse_str(c.value()).ok());
let (id, is_new) = match value {
Some(v) => (SessionID(v), false),
None => (Self::generate_uuid(store).await, true),
};
#[cfg(feature = "key-store")]
if store.config.use_bloom_filters
&& !store.auto_handles_expiry()
&& !store.filter.contains(id.inner().as_bytes())
{
store.filter.add(id.inner().as_bytes());
}
(
Self {
id,
store: store.clone(),
},
is_new,
)
}
#[cfg(feature = "key-store")]
pub(crate) async fn generate_uuid(store: &SessionStore<S>) -> SessionID {
loop {
let token = Uuid::new_v4();
if (!store.config.use_bloom_filters || store.auto_handles_expiry())
&& !store.inner.contains_key(&token.to_string())
&& !store.keys.contains_key(&token.to_string())
{
//This fixes an already used but in database issue.
if let Some(client) = &store.client {
// Unwrap should be safe to use as we would want it to crash if there was a major database error.
// This would mean the database no longer is online or the table missing etc.
if !client
.exists(&token.to_string(), &store.config.table_name)
.await
.unwrap()
{
return SessionID(token);
}
} else {
return SessionID(token);
}
} else if !store.filter.contains(token.to_string().as_bytes()) {
return SessionID(token);
}
}
}
#[cfg(not(feature = "key-store"))]
pub(crate) async fn generate_uuid(store: &SessionStore<S>) -> SessionID {
loop {
let token = Uuid::new_v4();
if !store.inner.contains_key(&token.to_string())
&& !store.keys.contains_key(&token.to_string())
{
//This fixes an already used but in database issue.
if let Some(client) = &store.client {
// Unwrap should be safe to use as we would want it to crash if there was a major database error.
// This would mean the database no longer is online or the table missing etc.
if !client
.exists(&token.to_string(), &store.config.table_name)
.await
.unwrap()
{
return SessionID(token);
}
} else {
return SessionID(token);
}
}
}
}
/// Sets the Session to create the SessionData based on the current Session ID.
/// You can only use this if SessionMode::Manual is set or it will Panic.
/// This will also set the store to true similair to session.set_store(true);
///
/// # Examples
/// ```rust ignore
/// session.create_data();
/// ```
///
#[inline]
pub fn create_data(&self) {
if !self.store.config.session_mode.is_manual() {
panic!(
"Session must be set to SessionMode::Manual in order to use create_data,
as the Session data is created already."
);
}
let sess = SessionData::new(self.id.0, true, &self.store.config);
self.store.inner.insert(self.id.inner(), sess);
}
/// Checks if the SessionData was created or not.
///
/// # Examples
/// ```rust ignore
/// if session.data_exists() {
/// println!("data Exists");
/// }
/// ```
///
#[inline]
pub fn data_exists(&self) -> bool {
self.store.inner.contains_key(&self.id.inner())
}
/// Sets the Session to renew its Session ID.
/// This Deletes Session data from the database
/// associated with the old key. This helps to enhance
/// Security when logging into Secure area's across a website.
///
/// # Examples
/// ```rust ignore
/// session.renew();
/// ```
///
#[inline]
pub fn renew(&self) {
self.store.renew(self.id.inner());
}
/// Sets the Session to renew its Session's Encryption Key.
/// This renews the Session's Encryption Key in the database.
/// Also it Generates a new Uuid for the Session's Key.
/// This helps to enhance Security when logging into Secure
/// area's across a website.
///
/// # Examples
/// ```rust ignore
/// session.renew_key();
/// ```
///
#[inline]
pub fn renew_key(&self) {
self.store.renew_key(self.id.inner());
}
/// Sets the Current Session to be Destroyed on the next run.
///
/// # Examples
/// ```rust ignore
/// session.destroy();
/// ```
///
#[inline]
pub fn destroy(&self) {
self.store.destroy(self.id.inner());
}
/// Sets the Current Session to a long term expiration. Useful for Remember Me setups.
///
/// # Examples
/// ```rust ignore
/// session.set_longterm(true);
/// ```
///
#[inline]
pub fn set_longterm(&self, longterm: bool) {
self.store.set_longterm(self.id.inner(), longterm);
}
/// Sets the Current Session to be storable.
///
/// This will allow the Session to save its data for the lifetime if set to true.
/// If this is set to false it will unload the stored session.
///
/// # Examples
/// ```rust ignore
/// session.set_store(true);
/// ```
///
#[inline]
pub fn set_store(&self, storable: bool) {
self.store.set_store(self.id.inner(), storable);
}
/// Gets data from the Session's HashMap
///
/// Provides an Option<T> that returns the requested data from the Sessions store.
/// Returns None if Key does not exist or if serdes_json failed to deserialize.
///
/// # Examples
/// ```rust ignore
/// let id = session.get("user-id").unwrap_or(0);
/// ```
///
///Used to get data stored within SessionDatas hashmap from a key value.
///
#[inline]
pub fn get<T: serde::de::DeserializeOwned>(&self, key: &str) -> Option<T> {
self.store.get(self.id.inner(), key)
}
/// Removes a Key from the Current Session's HashMap returning it.
///
/// Provides an Option<T> that returns the requested data from the Sessions store.
/// Returns None if Key does not exist or if serdes_json failed to deserialize.
///
/// # Examples
/// ```rust ignore
/// let id = session.get_remove("user-id").unwrap_or(0);
/// ```
///
/// Used to get data stored within SessionDatas hashmap from a key value.
///
#[inline]
pub fn get_remove<T: serde::de::DeserializeOwned>(&self, key: &str) -> Option<T> {
self.store.get_remove(self.id.inner(), key)
}
/// Sets data to the Current Session's HashMap.
///
/// # Examples
/// ```rust ignore
/// session.set("user-id", 1);
/// ```
///
#[inline]
pub fn set(&self, key: &str, value: impl Serialize) {
self.store.set(self.id.inner(), key, value);
}
/// Removes a Key from the Current Session's HashMap.
/// Does not process the String into a Type, Just removes it.
///
/// # Examples
/// ```rust ignore
/// let _ = session.remove("user-id");
/// ```
///
#[inline]
pub fn remove(&self, key: &str) {
self.store.remove(self.id.inner(), key);
}
/// Clears all data from the Current Session's HashMap.
///
/// # Examples
/// ```rust ignore
/// session.clear();
/// ```
///
#[inline]
pub fn clear(&self) {
self.store.clear_session_data(self.id.inner());
}
/// Returns a i64 count of how many Sessions exist.
///
/// If the Session is persistant it will return all sessions within the database.
/// If the Session is not persistant it will return a count within SessionStore.
///
/// # Examples
/// ```rust ignore
/// let count = session.count().await;
/// ```
///
#[inline]
pub async fn count(&self) -> i64 {
self.store.count_sessions().await
}
/// Returns the SessionID for this Session.
///
/// The SessionID contains the Uuid generated at the beginning of this Session.
///
/// # Examples
/// ```rust ignore
/// let session_id = session.get_session_id().await;
/// ```
///
#[inline]
pub async fn get_session_id(&self) -> SessionID {
self.id
}
}
#[derive(Debug, Clone)]
pub struct ReadOnlySession<T>
where
T: DatabasePool + Clone + Debug + Sync + Send + 'static,
{
pub(crate) store: SessionStore<T>,
pub(crate) id: SessionID,
}
impl<T> From<Session<T>> for ReadOnlySession<T>
where
T: DatabasePool + Clone + Debug + Sync + Send + 'static,
{
fn from(session: Session<T>) -> Self {
ReadOnlySession {
store: session.store,
id: session.id,
}
}
}
/// Adds FromRequestParts<B> for Session
///
/// Returns the Session from Axums request extensions state.
#[async_trait]
impl<T, S> FromRequestParts<S> for ReadOnlySession<T>
where
T: DatabasePool + Clone + Debug + Sync + Send + 'static,
S: Send + Sync,
{
type Rejection = (http::StatusCode, &'static str);
async fn from_request_parts(parts: &mut Parts, _state: &S) -> Result<Self, Self::Rejection> {
let session = parts.extensions.get::<Session<T>>().cloned().ok_or((
StatusCode::INTERNAL_SERVER_ERROR,
"Can't extract Axum `Session`. Is `SessionLayer` enabled?",
))?;
Ok(session.into())
}
}
impl<S> ReadOnlySession<S>
where
S: DatabasePool + Clone + Debug + Sync + Send + 'static,
{
/// Gets data from the Session's HashMap
///
/// Provides an Option<T> that returns the requested data from the Sessions store.
/// Returns None if Key does not exist or if serdes_json failed to deserialize.
///
/// # Examples
/// ```rust ignore
/// let id = session.get("user-id").unwrap_or(0);
/// ```
///
///Used to get data stored within SessionDatas hashmap from a key value.
///
#[inline]
pub fn get<T: serde::de::DeserializeOwned>(&self, key: &str) -> Option<T> {
self.store.get(self.id.inner(), key)
}
/// Returns a i64 count of how many Sessions exist.
///
/// If the Session is persistant it will return all sessions within the database.
/// If the Session is not persistant it will return a count within SessionStore.
///
/// # Examples
/// ```rust ignore
/// let count = session.count().await;
/// ```
///
#[inline]
pub async fn count(&self) -> i64 {
self.store.count_sessions().await
}
}