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
use chrono::{DateTime, Duration, Utc}; use rand::RngCore; use serde::{Deserialize, Serialize}; use std::{ collections::HashMap, sync::{ atomic::{AtomicBool, Ordering}, Arc, RwLock, }, }; /// # The main session type. /// /// ## Cloning and Serialization /// /// The `cookie_value` field is not cloned or serialized, and it can /// only be read through `into_cookie_value`. The intent of this field /// is that it is set either by initialization or by a session store, /// and read exactly once in order to set the cookie value. /// /// ## Change tracking session tracks whether any of its inner data /// was changed since it was last serialized. Any sessoin store that /// does not undergo a serialization-deserialization cycle must call /// [`Session::reset_data_changed`] in order to reset the change tracker on /// an individual record. /// /// ### Change tracking example /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert!(!session.data_changed()); /// /// session.insert("key", 1)?; /// assert!(session.data_changed()); /// /// session.reset_data_changed(); /// assert_eq!(session.get::<usize>("key").unwrap(), 1); /// assert!(!session.data_changed()); /// /// session.insert("key", 2)?; /// assert!(session.data_changed()); /// assert_eq!(session.get::<usize>("key").unwrap(), 2); /// /// session.insert("key", 1)?; /// assert!(session.data_changed(), "reverting the data still counts as a change"); /// /// session.reset_data_changed(); /// assert!(!session.data_changed()); /// session.remove("nonexistent key"); /// assert!(!session.data_changed()); /// session.remove("key"); /// assert!(session.data_changed()); /// # Ok(()) }) } /// ``` #[derive(Debug, Serialize, Deserialize)] pub struct Session { id: String, expiry: Option<DateTime<Utc>>, data: Arc<RwLock<HashMap<String, String>>>, #[serde(skip)] cookie_value: Option<String>, #[serde(skip)] data_changed: Arc<AtomicBool>, #[serde(skip)] destroy: Arc<AtomicBool>, } impl Clone for Session { fn clone(&self) -> Self { Self { cookie_value: None, id: self.id.clone(), data: self.data.clone(), expiry: self.expiry, destroy: self.destroy.clone(), data_changed: self.data_changed.clone(), } } } impl Default for Session { fn default() -> Self { Self::new() } } /// generates a random cookie value fn generate_cookie(len: usize) -> String { let mut key = vec![0u8; len]; rand::thread_rng().fill_bytes(&mut key); base64::encode(key) } impl Session { /// Create a new session. Generates a random id and matching /// cookie value. Does not set an expiry by default /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let session = Session::new(); /// assert_eq!(None, session.expiry()); /// assert!(session.into_cookie_value().is_some()); /// # Ok(()) }) } pub fn new() -> Self { let cookie_value = generate_cookie(64); let id = Session::id_from_cookie_value(&cookie_value).unwrap(); Self { data_changed: Arc::new(AtomicBool::new(false)), expiry: None, data: Arc::new(RwLock::new(HashMap::default())), cookie_value: Some(cookie_value), id, destroy: Arc::new(AtomicBool::new(false)), } } /// applies a cryptographic hash function on a cookie value /// returned by [`Session::into_cookie_value`] to obtain the /// session id for that cookie. Returns an error if the cookie /// format is not recognized /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let session = Session::new(); /// let id = session.id().to_string(); /// let cookie_value = session.into_cookie_value().unwrap(); /// assert_eq!(id, Session::id_from_cookie_value(&cookie_value)?); /// # Ok(()) }) } /// ``` pub fn id_from_cookie_value(string: &str) -> Result<String, base64::DecodeError> { let decoded = base64::decode(string)?; let hash = blake3::hash(&decoded); Ok(base64::encode(&hash.as_bytes())) } /// mark this session for destruction. the actual session record /// is not destroyed until the end of this response cycle. /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert!(!session.is_destroyed()); /// session.destroy(); /// assert!(session.is_destroyed()); /// # Ok(()) }) } pub fn destroy(&mut self) { self.destroy.store(true, Ordering::Relaxed); } /// returns true if this session is marked for destruction /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert!(!session.is_destroyed()); /// session.destroy(); /// assert!(session.is_destroyed()); /// # Ok(()) }) } pub fn is_destroyed(&self) -> bool { self.destroy.load(Ordering::Relaxed) } /// Gets the session id /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let session = Session::new(); /// let id = session.id().to_owned(); /// let cookie_value = session.into_cookie_value().unwrap(); /// assert_eq!(id, Session::id_from_cookie_value(&cookie_value)?); /// # Ok(()) }) } pub fn id(&self) -> &str { &self.id } /// inserts a serializable value into the session hashmap. returns /// an error if the serialization was unsuccessful. /// /// # Example /// /// ```rust /// # use serde::{Serialize, Deserialize}; /// # use async_session::Session; /// #[derive(Serialize, Deserialize)] /// struct User { /// name: String, /// legs: u8 /// } /// let mut session = Session::new(); /// session.insert("user", User { name: "chashu".into(), legs: 4 }).expect("serializable"); /// assert_eq!(r#"{"name":"chashu","legs":4}"#, session.get_raw("user").unwrap()); /// ``` pub fn insert(&mut self, key: &str, value: impl Serialize) -> Result<(), serde_json::Error> { self.insert_raw(key, serde_json::to_string(&value)?); Ok(()) } /// inserts a string into the session hashmap /// /// # Example /// /// ```rust /// # use async_session::Session; /// let mut session = Session::new(); /// session.insert_raw("ten", "10".to_string()); /// let ten: usize = session.get("ten").unwrap(); /// assert_eq!(ten, 10); /// ``` pub fn insert_raw(&mut self, key: &str, value: String) { let mut data = self.data.write().unwrap(); if data.get(key) != Some(&value) { data.insert(key.to_string(), value); self.data_changed.store(true, Ordering::Relaxed); } } /// deserializes a type T out of the session hashmap /// /// # Example /// /// ```rust /// # use async_session::Session; /// let mut session = Session::new(); /// session.insert("key", vec![1, 2, 3]); /// let numbers: Vec<usize> = session.get("key").unwrap(); /// assert_eq!(vec![1, 2, 3], numbers); /// ``` pub fn get<T: serde::de::DeserializeOwned>(&self, key: &str) -> Option<T> { let data = self.data.read().unwrap(); let string = data.get(key)?; serde_json::from_str(string).ok() } /// returns the String value contained in the session hashmap /// /// # Example /// /// ```rust /// # use async_session::Session; /// let mut session = Session::new(); /// session.insert("key", vec![1, 2, 3]); /// assert_eq!("[1,2,3]", session.get_raw("key").unwrap()); /// ``` pub fn get_raw(&self, key: &str) -> Option<String> { let data = self.data.read().unwrap(); data.get(key).cloned() } /// removes an entry from the session hashmap /// /// # Example /// /// ```rust /// # use async_session::Session; /// let mut session = Session::new(); /// session.insert("key", "value"); /// session.remove("key"); /// assert!(session.get_raw("key").is_none()); /// assert_eq!(session.len(), 0); /// ``` pub fn remove(&mut self, key: &str) { let mut data = self.data.write().unwrap(); if data.remove(key).is_some() { self.data_changed.store(true, Ordering::Relaxed); } } /// returns the number of elements in the session hashmap /// /// # Example /// /// ```rust /// # use async_session::Session; /// let mut session = Session::new(); /// assert_eq!(session.len(), 0); /// session.insert("key", 0); /// assert_eq!(session.len(), 1); /// ``` pub fn len(&self) -> usize { let data = self.data.read().unwrap(); data.len() } /// Generates a new id and cookie for this session /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// let old_id = session.id().to_string(); /// session.regenerate(); /// assert!(session.id() != &old_id); /// let new_id = session.id().to_string(); /// let cookie_value = session.into_cookie_value().unwrap(); /// assert_eq!(new_id, Session::id_from_cookie_value(&cookie_value)?); /// # Ok(()) }) } /// ``` pub fn regenerate(&mut self) { let cookie_value = generate_cookie(64); self.id = Session::id_from_cookie_value(&cookie_value).unwrap(); self.cookie_value = Some(cookie_value); } /// sets the cookie value that this session will use to serialize /// itself. this should only be called by cookie stores. any other /// uses of this method will result in the cookie not getting /// correctly deserialized on subsequent requests. /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// session.set_cookie_value("hello".to_owned()); /// let cookie_value = session.into_cookie_value().unwrap(); /// assert_eq!(cookie_value, "hello".to_owned()); /// # Ok(()) }) } /// ``` pub fn set_cookie_value(&mut self, cookie_value: String) { self.cookie_value = Some(cookie_value) } /// returns the expiry timestamp of this session, if there is one /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert_eq!(None, session.expiry()); /// session.expire_in(std::time::Duration::from_secs(1)); /// assert!(session.expiry().is_some()); /// # Ok(()) }) } /// ``` pub fn expiry(&self) -> Option<&DateTime<Utc>> { self.expiry.as_ref() } /// assigns an expiry timestamp to this session /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert_eq!(None, session.expiry()); /// session.set_expiry(chrono::Utc::now()); /// assert!(session.expiry().is_some()); /// # Ok(()) }) } /// ``` pub fn set_expiry(&mut self, expiry: DateTime<Utc>) { self.expiry = Some(expiry); } /// assigns the expiry timestamp to a duration from the current time. /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert_eq!(None, session.expiry()); /// session.expire_in(std::time::Duration::from_secs(1)); /// assert!(session.expiry().is_some()); /// # Ok(()) }) } /// ``` pub fn expire_in(&mut self, ttl: std::time::Duration) { self.expiry = Some(Utc::now() + Duration::from_std(ttl).unwrap()); } /// predicate function to determine if this session is /// expired. returns false if there is no expiry set, or if it is /// in the past. /// /// # Example /// /// ```rust /// # use async_session::Session; /// # use std::time::Duration; /// # use async_std::task; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert_eq!(None, session.expiry()); /// assert!(!session.is_expired()); /// session.expire_in(Duration::from_secs(1)); /// assert!(!session.is_expired()); /// task::sleep(Duration::from_secs(2)).await; /// assert!(session.is_expired()); /// # Ok(()) }) } /// ``` pub fn is_expired(&self) -> bool { match self.expiry { Some(expiry) => expiry < Utc::now(), None => false, } } /// Ensures that this session is not expired. Returns None if it is expired /// /// # Example /// /// ```rust /// # use async_session::Session; /// # use std::time::Duration; /// # use async_std::task; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let session = Session::new(); /// let mut session = session.validate().unwrap(); /// session.expire_in(Duration::from_secs(1)); /// let session = session.validate().unwrap(); /// task::sleep(Duration::from_secs(2)).await; /// assert_eq!(None, session.validate()); /// # Ok(()) }) } /// ``` pub fn validate(self) -> Option<Self> { if self.is_expired() { None } else { Some(self) } } /// Checks if the data has been modified. This is based on the /// implementation of [`PartialEq`] for the inner data type. /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert!(!session.data_changed(), "new session is not changed"); /// session.insert("key", 1); /// assert!(session.data_changed()); /// /// session.reset_data_changed(); /// assert!(!session.data_changed()); /// session.remove("key"); /// assert!(session.data_changed()); /// # Ok(()) }) } /// ``` pub fn data_changed(&self) -> bool { self.data_changed.load(Ordering::Relaxed) } /// Resets `data_changed` dirty tracking. This is unnecessary for /// any session store that serializes the data to a string on /// storage. /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// assert!(!session.data_changed(), "new session is not changed"); /// session.insert("key", 1); /// assert!(session.data_changed()); /// /// session.reset_data_changed(); /// assert!(!session.data_changed()); /// session.remove("key"); /// assert!(session.data_changed()); /// # Ok(()) }) } /// ``` pub fn reset_data_changed(&self) { self.data_changed.store(false, Ordering::Relaxed); } /// Ensures that this session is not expired. Returns None if it is expired /// /// # Example /// /// ```rust /// # use async_session::Session; /// # use std::time::Duration; /// # use async_std::task; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// session.expire_in(Duration::from_secs(123)); /// let expires_in = session.expires_in().unwrap(); /// assert!(123 - expires_in.as_secs() < 2); /// # Ok(()) }) } /// ``` /// Duration from now to the expiry time of this session pub fn expires_in(&self) -> Option<std::time::Duration> { self.expiry?.signed_duration_since(Utc::now()).to_std().ok() } /// takes the cookie value and consume this session. /// this is generally only performed by the session store /// /// # Example /// /// ```rust /// # use async_session::Session; /// # fn main() -> async_session::Result { async_std::task::block_on(async { /// let mut session = Session::new(); /// session.set_cookie_value("hello".to_owned()); /// let cookie_value = session.into_cookie_value().unwrap(); /// assert_eq!(cookie_value, "hello".to_owned()); /// # Ok(()) }) } /// ``` pub fn into_cookie_value(mut self) -> Option<String> { self.cookie_value.take() } } impl PartialEq for Session { fn eq(&self, other: &Self) -> bool { other.id == self.id } }