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
use std::collections::HashSet; use std::mem::replace; use time::{self, Duration}; #[cfg(feature = "secure")] use secure::{PrivateJar, SignedJar, Key}; use delta::DeltaCookie; use Cookie; /// A collection of cookies that tracks its modifications. /// /// A `CookieJar` provides storage for any number of cookies. Any changes made /// to the jar are tracked; the changes can be retrieved via the /// [delta](#method.delta) method which returns an interator over the changes. /// /// # Usage /// /// A jar's life begins via [new](#method.new) and calls to /// [`add_original`](#method.add_original): /// /// ```rust /// use cookie::{Cookie, CookieJar}; /// /// let mut jar = CookieJar::new(); /// jar.add_original(Cookie::new("name", "value")); /// jar.add_original(Cookie::new("second", "another")); /// ``` /// /// Cookies can be added via [add](#method.add) and removed via /// [remove](#method.remove). Finally, cookies can be looked up via /// [get](#method.get): /// /// ```rust /// # use cookie::{Cookie, CookieJar}; /// let mut jar = CookieJar::new(); /// jar.add(Cookie::new("a", "one")); /// jar.add(Cookie::new("b", "two")); /// /// assert_eq!(jar.get("a").map(|c| c.value()), Some("one")); /// assert_eq!(jar.get("b").map(|c| c.value()), Some("two")); /// /// jar.remove(Cookie::named("b")); /// assert!(jar.get("b").is_none()); /// ``` /// /// # Deltas /// /// A jar keeps track of any modifications made to it over time. The /// modifications are recorded as cookies. The modifications can be retrieved /// via [delta](#method.delta). Any new `Cookie` added to a jar via `add` /// results in the same `Cookie` appearing in the `delta`; cookies added via /// `add_original` do not count towards the delta. Any _original_ cookie that is /// removed from a jar results in a "removal" cookie appearing in the delta. A /// "removal" cookie is a cookie that a server sends so that the cookie is /// removed from the client's machine. /// /// Deltas are typically used to create `Set-Cookie` headers corresponding to /// the changes made to a cookie jar over a period of time. /// /// ```rust /// # use cookie::{Cookie, CookieJar}; /// let mut jar = CookieJar::new(); /// /// // original cookies don't affect the delta /// jar.add_original(Cookie::new("original", "value")); /// assert_eq!(jar.delta().count(), 0); /// /// // new cookies result in an equivalent `Cookie` in the delta /// jar.add(Cookie::new("a", "one")); /// jar.add(Cookie::new("b", "two")); /// assert_eq!(jar.delta().count(), 2); /// /// // removing an original cookie adds a "removal" cookie to the delta /// jar.remove(Cookie::named("original")); /// assert_eq!(jar.delta().count(), 3); /// /// // removing a new cookie that was added removes that `Cookie` from the delta /// jar.remove(Cookie::named("a")); /// assert_eq!(jar.delta().count(), 2); /// ``` #[derive(Default, Debug, Clone)] pub struct CookieJar { original_cookies: HashSet<DeltaCookie>, delta_cookies: HashSet<DeltaCookie>, } impl CookieJar { /// Creates an empty cookie jar. /// /// # Example /// /// ```rust /// use cookie::CookieJar; /// /// let jar = CookieJar::new(); /// assert_eq!(jar.iter().count(), 0); /// ``` pub fn new() -> CookieJar { CookieJar::default() } /// Returns a reference to the `Cookie` inside this jar with the name /// `name`. If no such cookie exists, returns `None`. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie}; /// /// let mut jar = CookieJar::new(); /// assert!(jar.get("name").is_none()); /// /// jar.add(Cookie::new("name", "value")); /// assert_eq!(jar.get("name").map(|c| c.value()), Some("value")); /// ``` pub fn get(&self, name: &str) -> Option<&Cookie<'static>> { self.delta_cookies .get(name) .or_else(|| self.original_cookies.get(name)) .and_then(|c| if !c.removed { Some(&c.cookie) } else { None }) } /// Adds an "original" `cookie` to this jar. Adding an original cookie does /// not affect the [delta](#method.delta) computation. This method is /// intended to be used to seed the cookie jar with cookies received from a /// client's HTTP message. /// /// For accurate `delta` computations, this method should not be called /// after calling `remove`. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie}; /// /// let mut jar = CookieJar::new(); /// jar.add_original(Cookie::new("name", "value")); /// jar.add_original(Cookie::new("second", "two")); /// /// assert_eq!(jar.get("name").map(|c| c.value()), Some("value")); /// assert_eq!(jar.get("second").map(|c| c.value()), Some("two")); /// assert_eq!(jar.iter().count(), 2); /// assert_eq!(jar.delta().count(), 0); /// ``` pub fn add_original(&mut self, cookie: Cookie<'static>) { self.original_cookies.replace(DeltaCookie::added(cookie)); } /// Adds `cookie` to this jar. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie}; /// /// let mut jar = CookieJar::new(); /// jar.add(Cookie::new("name", "value")); /// jar.add(Cookie::new("second", "two")); /// /// assert_eq!(jar.get("name").map(|c| c.value()), Some("value")); /// assert_eq!(jar.get("second").map(|c| c.value()), Some("two")); /// assert_eq!(jar.iter().count(), 2); /// assert_eq!(jar.delta().count(), 2); /// ``` pub fn add(&mut self, cookie: Cookie<'static>) { self.delta_cookies.replace(DeltaCookie::added(cookie)); } /// Removes `cookie` from this jar. If an _original_ cookie with the same /// name as `cookie` is present in the jar, a _removal_ cookie will be /// present in the `delta` computation. To properly generate the removal /// cookie, `cookie` must contain the same `path` and `domain` as the cookie /// that was initially set. /// /// A "removal" cookie is a cookie that has the same name as the original /// cookie but has an empty value, a max-age of 0, and an expiration date /// far in the past. /// /// # Example /// /// Removing an _original_ cookie results in a _removal_ cookie: /// /// ```rust /// # extern crate cookie; /// extern crate time; /// /// use cookie::{CookieJar, Cookie}; /// use time::Duration; /// /// # fn main() { /// let mut jar = CookieJar::new(); /// /// // Assume this cookie originally had a path of "/" and domain of "a.b". /// jar.add_original(Cookie::new("name", "value")); /// /// // If the path and domain were set, they must be provided to `remove`. /// jar.remove(Cookie::build("name", "").path("/").domain("a.b").finish()); /// /// // The delta will contain the removal cookie. /// let delta: Vec<_> = jar.delta().collect(); /// assert_eq!(delta.len(), 1); /// assert_eq!(delta[0].name(), "name"); /// assert_eq!(delta[0].max_age(), Some(Duration::seconds(0))); /// # } /// ``` /// /// Removing a new cookie does not result in a _removal_ cookie: /// /// ```rust /// use cookie::{CookieJar, Cookie}; /// /// let mut jar = CookieJar::new(); /// jar.add(Cookie::new("name", "value")); /// assert_eq!(jar.delta().count(), 1); /// /// jar.remove(Cookie::named("name")); /// assert_eq!(jar.delta().count(), 0); /// ``` pub fn remove(&mut self, mut cookie: Cookie<'static>) { if self.original_cookies.contains(cookie.name()) { cookie.set_value(""); cookie.set_max_age(Duration::seconds(0)); cookie.set_expires(time::now() - Duration::days(365)); self.delta_cookies.replace(DeltaCookie::removed(cookie)); } else { self.delta_cookies.remove(cookie.name()); } } /// Removes all cookies from this cookie jar. #[deprecated(since = "0.7.0", note = "calling this method may not remove \ all cookies since the path and domain are not specified; use \ `remove` instead")] pub fn clear(&mut self) { self.delta_cookies.clear(); for delta in replace(&mut self.original_cookies, HashSet::new()) { self.remove(delta.cookie); } } /// Returns an iterator over cookies that represent the changes to this jar /// over time. These cookies can be rendered directly as `Set-Cookie` header /// values to affect the changes made to this jar on the client. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie}; /// /// let mut jar = CookieJar::new(); /// jar.add_original(Cookie::new("name", "value")); /// jar.add_original(Cookie::new("second", "two")); /// /// // Add new cookies. /// jar.add(Cookie::new("new", "third")); /// jar.add(Cookie::new("another", "fourth")); /// jar.add(Cookie::new("yac", "fifth")); /// /// // Remove some cookies. /// jar.remove(Cookie::named("name")); /// jar.remove(Cookie::named("another")); /// /// // Delta contains two new cookies ("new", "yac") and a removal ("name"). /// assert_eq!(jar.delta().count(), 3); /// ``` pub fn delta(&self) -> Delta { Delta { iter: self.delta_cookies.iter() } } /// Returns an iterator over all of the cookies present in this jar. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie}; /// /// let mut jar = CookieJar::new(); /// /// jar.add_original(Cookie::new("name", "value")); /// jar.add_original(Cookie::new("second", "two")); /// /// jar.add(Cookie::new("new", "third")); /// jar.add(Cookie::new("another", "fourth")); /// jar.add(Cookie::new("yac", "fifth")); /// /// jar.remove(Cookie::named("name")); /// jar.remove(Cookie::named("another")); /// /// // There are three cookies in the jar: "second", "new", and "yac". /// # assert_eq!(jar.iter().count(), 3); /// for cookie in jar.iter() { /// match cookie.name() { /// "second" => assert_eq!(cookie.value(), "two"), /// "new" => assert_eq!(cookie.value(), "third"), /// "yac" => assert_eq!(cookie.value(), "fifth"), /// _ => unreachable!("there are only three cookies in the jar") /// } /// } /// ``` pub fn iter(&self) -> Iter { Iter { delta_cookies: self.delta_cookies.union(&self.original_cookies) } } /// Returns a `PrivateJar` with `self` as its parent jar using the key `key` /// to sign/encrypt and verify/decrypt cookies added/retrieved from the /// child jar. /// /// Any modifications to the child jar will be reflected on the parent jar, /// and any retrievals from the child jar will be made from the parent jar. /// /// This method is only available when the `secure` feature is enabled. /// /// # Example /// /// ```rust /// use cookie::{Cookie, CookieJar, Key}; /// /// // Generate a secure key. /// let key = Key::generate(); /// /// // Add a private (signed + encrypted) cookie. /// let mut jar = CookieJar::new(); /// jar.private(&key).add(Cookie::new("private", "text")); /// /// // The cookie's contents are encrypted. /// assert_ne!(jar.get("private").unwrap().value(), "text"); /// /// // They can be decrypted and verified through the child jar. /// assert_eq!(jar.private(&key).get("private").unwrap().value(), "text"); /// /// // A tampered with cookie does not validate but still exists. /// let mut cookie = jar.get("private").unwrap().clone(); /// jar.add(Cookie::new("private", cookie.value().to_string() + "!")); /// assert!(jar.private(&key).get("private").is_none()); /// assert!(jar.get("private").is_some()); /// ``` #[cfg(feature = "secure")] pub fn private(&mut self, key: &Key) -> PrivateJar { PrivateJar::new(self, key) } /// Returns a `SignedJar` with `self` as its parent jar using the key `key` /// to sign/verify cookies added/retrieved from the child jar. /// /// Any modifications to the child jar will be reflected on the parent jar, /// and any retrievals from the child jar will be made from the parent jar. /// /// This method is only available when the `secure` feature is enabled. /// /// # Example /// /// ```rust /// use cookie::{Cookie, CookieJar, Key}; /// /// // Generate a secure key. /// let key = Key::generate(); /// /// // Add a signed cookie. /// let mut jar = CookieJar::new(); /// jar.signed(&key).add(Cookie::new("signed", "text")); /// /// // The cookie's contents are signed but still in plaintext. /// assert_ne!(jar.get("signed").unwrap().value(), "text"); /// assert!(jar.get("signed").unwrap().value().contains("text")); /// /// // They can be verified through the child jar. /// assert_eq!(jar.signed(&key).get("signed").unwrap().value(), "text"); /// /// // A tampered with cookie does not validate but still exists. /// let mut cookie = jar.get("signed").unwrap().clone(); /// jar.add(Cookie::new("signed", cookie.value().to_string() + "!")); /// assert!(jar.signed(&key).get("signed").is_none()); /// assert!(jar.get("signed").is_some()); /// ``` #[cfg(feature = "secure")] pub fn signed(&mut self, key: &Key) -> SignedJar { SignedJar::new(self, key) } } use std::collections::hash_set::Iter as HashSetIter; /// Iterator over the changes to a cookie jar. pub struct Delta<'a> { iter: HashSetIter<'a, DeltaCookie>, } impl<'a> Iterator for Delta<'a> { type Item = &'a Cookie<'static>; fn next(&mut self) -> Option<&'a Cookie<'static>> { self.iter.next().map(|c| &c.cookie) } } use std::collections::hash_set::Union; use std::collections::hash_map::RandomState; /// Iterator over all of the cookies in a jar. pub struct Iter<'a> { delta_cookies: Union<'a, DeltaCookie, RandomState>, } impl<'a> Iterator for Iter<'a> { type Item = &'a Cookie<'static>; fn next(&mut self) -> Option<&'a Cookie<'static>> { for cookie in self.delta_cookies.by_ref() { if !cookie.removed { return Some(&*cookie); } } None } } #[cfg(test)] mod test { use super::CookieJar; use Cookie; #[test] #[allow(deprecated)] fn simple() { let mut c = CookieJar::new(); c.add(Cookie::new("test", "")); c.add(Cookie::new("test2", "")); c.remove(Cookie::named("test")); assert!(c.get("test").is_none()); assert!(c.get("test2").is_some()); c.add(Cookie::new("test3", "")); c.clear(); assert!(c.get("test").is_none()); assert!(c.get("test2").is_none()); assert!(c.get("test3").is_none()); } #[test] fn jar_is_send() { fn is_send<T: Send>(_: T) -> bool { true } assert!(is_send(CookieJar::new())) } #[test] #[cfg(feature = "secure")] fn iter() { let key = ::Key::generate(); let mut c = CookieJar::new(); c.add_original(Cookie::new("original", "original")); c.add(Cookie::new("test", "test")); c.add(Cookie::new("test2", "test2")); c.add(Cookie::new("test3", "test3")); assert_eq!(c.iter().count(), 4); c.signed(&key).add(Cookie::new("signed", "signed")); c.private(&key).add(Cookie::new("encrypted", "encrypted")); assert_eq!(c.iter().count(), 6); c.remove(Cookie::named("test")); assert_eq!(c.iter().count(), 5); c.remove(Cookie::named("signed")); c.remove(Cookie::named("test2")); assert_eq!(c.iter().count(), 3); c.add(Cookie::new("test2", "test2")); assert_eq!(c.iter().count(), 4); c.remove(Cookie::named("test2")); assert_eq!(c.iter().count(), 3); } #[test] #[cfg(feature = "secure")] fn delta() { use std::collections::HashMap; use time::Duration; let mut c = CookieJar::new(); c.add_original(Cookie::new("original", "original")); c.add_original(Cookie::new("original1", "original1")); c.add(Cookie::new("test", "test")); c.add(Cookie::new("test2", "test2")); c.add(Cookie::new("test3", "test3")); c.add(Cookie::new("test4", "test4")); c.remove(Cookie::named("test")); c.remove(Cookie::named("original")); assert_eq!(c.delta().count(), 4); let names: HashMap<_, _> = c.delta() .map(|c| (c.name(), c.max_age())) .collect(); assert!(names.get("test2").unwrap().is_none()); assert!(names.get("test3").unwrap().is_none()); assert!(names.get("test4").unwrap().is_none()); assert_eq!(names.get("original").unwrap(), &Some(Duration::seconds(0))); } #[test] fn replace_original() { let mut jar = CookieJar::new(); jar.add_original(Cookie::new("original_a", "a")); jar.add_original(Cookie::new("original_b", "b")); assert_eq!(jar.get("original_a").unwrap().value(), "a"); jar.add(Cookie::new("original_a", "av2")); assert_eq!(jar.get("original_a").unwrap().value(), "av2"); } #[test] fn empty_delta() { let mut jar = CookieJar::new(); jar.add(Cookie::new("name", "val")); assert_eq!(jar.delta().count(), 1); jar.remove(Cookie::named("name")); assert_eq!(jar.delta().count(), 0); jar.add_original(Cookie::new("name", "val")); assert_eq!(jar.delta().count(), 0); jar.remove(Cookie::named("name")); assert_eq!(jar.delta().count(), 1); jar.add(Cookie::new("name", "val")); assert_eq!(jar.delta().count(), 1); jar.remove(Cookie::named("name")); assert_eq!(jar.delta().count(), 1); } #[test] fn add_remove_add() { let mut jar = CookieJar::new(); jar.add_original(Cookie::new("name", "val")); assert_eq!(jar.delta().count(), 0); jar.remove(Cookie::named("name")); assert_eq!(jar.delta().filter(|c| c.value().is_empty()).count(), 1); assert_eq!(jar.delta().count(), 1); // The cookie's been deleted. Another original doesn't change that. jar.add_original(Cookie::new("name", "val")); assert_eq!(jar.delta().filter(|c| c.value().is_empty()).count(), 1); assert_eq!(jar.delta().count(), 1); jar.remove(Cookie::named("name")); assert_eq!(jar.delta().filter(|c| c.value().is_empty()).count(), 1); assert_eq!(jar.delta().count(), 1); jar.add(Cookie::new("name", "val")); assert_eq!(jar.delta().filter(|c| !c.value().is_empty()).count(), 1); assert_eq!(jar.delta().count(), 1); jar.remove(Cookie::named("name")); assert_eq!(jar.delta().filter(|c| c.value().is_empty()).count(), 1); assert_eq!(jar.delta().count(), 1); } #[test] fn replace_remove() { let mut jar = CookieJar::new(); jar.add_original(Cookie::new("name", "val")); assert_eq!(jar.delta().count(), 0); jar.add(Cookie::new("name", "val")); assert_eq!(jar.delta().count(), 1); assert_eq!(jar.delta().filter(|c| !c.value().is_empty()).count(), 1); jar.remove(Cookie::named("name")); assert_eq!(jar.delta().filter(|c| c.value().is_empty()).count(), 1); } #[test] fn remove_with_path() { let mut jar = CookieJar::new(); jar.add_original(Cookie::build("name", "val").finish()); assert_eq!(jar.iter().count(), 1); assert_eq!(jar.delta().count(), 0); assert_eq!(jar.iter().filter(|c| c.path().is_none()).count(), 1); jar.remove(Cookie::build("name", "").path("/").finish()); assert_eq!(jar.iter().count(), 0); assert_eq!(jar.delta().count(), 1); assert_eq!(jar.delta().filter(|c| c.value().is_empty()).count(), 1); assert_eq!(jar.delta().filter(|c| c.path() == Some("/")).count(), 1); } }