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
use secure::ring::digest::{SHA256, Algorithm}; use secure::ring::hmac::{SigningKey, sign, verify_with_own_key as verify}; use secure::{base64, Key}; use {Cookie, CookieJar}; // Keep these in sync, and keep the key len synced with the `signed` docs as // well as the `KEYS_INFO` const in secure::Key. static HMAC_DIGEST: &'static Algorithm = &SHA256; const BASE64_DIGEST_LEN: usize = 44; pub const KEY_LEN: usize = 32; /// A child cookie jar that authenticates its cookies. /// /// A _signed_ child jar signs all the cookies added to it and verifies cookies /// retrieved from it. Any cookies stored in a `SignedJar` are assured integrity /// and authenticity. In other words, clients cannot tamper with the contents of /// a cookie nor can they fabricate cookie values, but the data is visible in /// plaintext. /// /// This type is only available when the `secure` feature is enabled. pub struct SignedJar<'a> { parent: &'a mut CookieJar, key: SigningKey } impl<'a> SignedJar<'a> { /// Creates a new child `SignedJar` with parent `parent` and key `key`. This /// method is typically called indirectly via the `signed` method of /// `CookieJar`. #[doc(hidden)] pub fn new(parent: &'a mut CookieJar, key: &Key) -> SignedJar<'a> { SignedJar { parent: parent, key: SigningKey::new(HMAC_DIGEST, key.signing()) } } /// Given a signed value `str` where the signature is prepended to `value`, /// verifies the signed value and returns it. If there's a problem, returns /// an `Err` with a string describing the issue. fn verify(&self, cookie_value: &str) -> Result<String, &'static str> { if cookie_value.len() < BASE64_DIGEST_LEN { return Err("length of value is <= BASE64_DIGEST_LEN"); } let (digest_str, value) = cookie_value.split_at(BASE64_DIGEST_LEN); let sig = base64::decode(digest_str).map_err(|_| "bad base64 digest")?; verify(&self.key, value.as_bytes(), &sig) .map(|_| value.to_string()) .map_err(|_| "value did not verify") } /// Returns a reference to the `Cookie` inside this jar with the name `name` /// and verifies the authenticity and integrity of the cookie's value, /// returning a `Cookie` with the authenticated value. If the cookie cannot /// be found, or the cookie fails to verify, `None` is returned. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie, Key}; /// /// let key = Key::generate(); /// let mut jar = CookieJar::new(); /// let mut signed_jar = jar.signed(&key); /// assert!(signed_jar.get("name").is_none()); /// /// signed_jar.add(Cookie::new("name", "value")); /// assert_eq!(signed_jar.get("name").unwrap().value(), "value"); /// ``` pub fn get(&self, name: &str) -> Option<Cookie<'static>> { if let Some(cookie_ref) = self.parent.get(name) { let mut cookie = cookie_ref.clone(); if let Ok(value) = self.verify(cookie.value()) { cookie.set_value(value); return Some(cookie); } } None } /// Adds `cookie` to the parent jar. The cookie's value is signed assuring /// integrity and authenticity. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie, Key}; /// /// let key = Key::generate(); /// let mut jar = CookieJar::new(); /// jar.signed(&key).add(Cookie::new("name", "value")); /// /// assert_ne!(jar.get("name").unwrap().value(), "value"); /// assert!(jar.get("name").unwrap().value().contains("value")); /// assert_eq!(jar.signed(&key).get("name").unwrap().value(), "value"); /// ``` pub fn add(&mut self, mut cookie: Cookie<'static>) { let digest = sign(&self.key, cookie.value().as_bytes()); let mut new_value = base64::encode(digest.as_ref()); new_value.push_str(cookie.value()); cookie.set_value(new_value); self.parent.add(cookie); } /// Removes `cookie` from the parent jar. /// /// For correct removal, the passed in `cookie` must contain the same `path` /// and `domain` as the cookie that was initially set. /// /// See [CookieJar::remove](struct.CookieJar.html#method.remove) for more /// details. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie, Key}; /// /// let key = Key::generate(); /// let mut jar = CookieJar::new(); /// let mut signed_jar = jar.signed(&key); /// /// signed_jar.add(Cookie::new("name", "value")); /// assert!(signed_jar.get("name").is_some()); /// /// signed_jar.remove(Cookie::named("name")); /// assert!(signed_jar.get("name").is_none()); /// ``` pub fn remove(&mut self, cookie: Cookie<'static>) { self.parent.remove(cookie); } } #[cfg(test)] mod test { use {CookieJar, Cookie, Key}; #[test] fn simple() { let key = Key::generate(); let mut jar = CookieJar::new(); assert_simple_behaviour!(jar, jar.signed(&key)); } #[test] fn private() { let key = Key::generate(); let mut jar = CookieJar::new(); assert_secure_behaviour!(jar, jar.signed(&key)); } }