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
use secure::ring::aead::{seal_in_place, open_in_place, Algorithm, AES_256_GCM}; use secure::ring::aead::{OpeningKey, SealingKey}; use secure::ring::rand::{SecureRandom, SystemRandom}; use secure::{base64, Key}; use {Cookie, CookieJar}; // Keep these in sync, and keep the key len synced with the `private` docs as // well as the `KEYS_INFO` const in secure::Key. static ALGO: &'static Algorithm = &AES_256_GCM; const NONCE_LEN: usize = 12; pub const KEY_LEN: usize = 32; /// A child cookie jar that provides authenticated encryption for its cookies. /// /// A _private_ child jar signs and encrypts all the cookies added to it and /// verifies and decrypts cookies retrieved from it. Any cookies stored in a /// `PrivateJar` are simultaneously assured confidentiality, integrity, and /// authenticity. In other words, clients cannot discover nor tamper with the /// contents of a cookie, nor can they fabricate cookie data. /// /// This type is only available when the `secure` feature is enabled. pub struct PrivateJar<'a> { parent: &'a mut CookieJar, key: [u8; KEY_LEN] } impl<'a> PrivateJar<'a> { /// Creates a new child `PrivateJar` 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) -> PrivateJar<'a> { let mut key_array = [0u8; KEY_LEN]; key_array.copy_from_slice(key.encryption()); PrivateJar { parent: parent, key: key_array } } /// Given a sealed value `str` and a key name `name`, where the nonce is /// prepended to the original value and then both are Base64 encoded, /// verifies and decrypts the sealed value and returns it. If there's a /// problem, returns an `Err` with a string describing the issue. fn unseal(&self, name: &str, value: &str) -> Result<String, &'static str> { let mut data = base64::decode(value).map_err(|_| "bad base64 value")?; if data.len() <= NONCE_LEN { return Err("length of decoded data is <= NONCE_LEN"); } let ad = name.as_bytes(); let key = OpeningKey::new(ALGO, &self.key).expect("opening key"); let (nonce, sealed) = data.split_at_mut(NONCE_LEN); let unsealed = open_in_place(&key, nonce, ad, 0, sealed) .map_err(|_| "invalid key/nonce/value: bad seal")?; ::std::str::from_utf8(unsealed) .map(|s| s.to_string()) .map_err(|_| "bad unsealed utf8") } /// Returns a reference to the `Cookie` inside this jar with the name `name` /// and authenticates and decrypts the cookie's value, returning a `Cookie` /// with the decrypted value. If the cookie cannot be found, or the cookie /// fails to authenticate or decrypt, `None` is returned. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie, Key}; /// /// let key = Key::generate(); /// let mut jar = CookieJar::new(); /// let mut private_jar = jar.private(&key); /// assert!(private_jar.get("name").is_none()); /// /// private_jar.add(Cookie::new("name", "value")); /// assert_eq!(private_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.unseal(name, cookie.value()) { cookie.set_value(value); return Some(cookie); } } None } /// Adds `cookie` to the parent jar. The cookie's value is encrypted with /// authenticated encryption assuring confidentiality, integrity, and /// authenticity. /// /// # Example /// /// ```rust /// use cookie::{CookieJar, Cookie, Key}; /// /// let key = Key::generate(); /// let mut jar = CookieJar::new(); /// jar.private(&key).add(Cookie::new("name", "value")); /// /// assert_ne!(jar.get("name").unwrap().value(), "value"); /// assert_eq!(jar.private(&key).get("name").unwrap().value(), "value"); /// ``` pub fn add(&mut self, mut cookie: Cookie<'static>) { let mut data; let output_len = { // Create the `SealingKey` structure. let key = SealingKey::new(ALGO, &self.key).expect("sealing key creation"); // Create a vec to hold the [nonce | cookie value | overhead]. let overhead = ALGO.tag_len(); let cookie_val = cookie.value().as_bytes(); data = vec![0; NONCE_LEN + cookie_val.len() + overhead]; // Randomly generate the nonce, then copy the cookie value as input. let (nonce, in_out) = data.split_at_mut(NONCE_LEN); SystemRandom::new().fill(nonce).expect("couldn't random fill nonce"); in_out[..cookie_val.len()].copy_from_slice(cookie_val); // Use cookie's name as associated data to prevent value swapping. let ad = cookie.name().as_bytes(); // Perform the actual sealing operation and get the output length. seal_in_place(&key, nonce, ad, in_out, overhead).expect("in-place seal") }; // Base64 encode the nonce and encrypted value. let sealed_value = base64::encode(&data[..(NONCE_LEN + output_len)]); cookie.set_value(sealed_value); // Add the sealed cookie to the parent. 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 private_jar = jar.private(&key); /// /// private_jar.add(Cookie::new("name", "value")); /// assert!(private_jar.get("name").is_some()); /// /// private_jar.remove(Cookie::named("name")); /// assert!(private_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.private(&key)); } #[test] fn private() { let key = Key::generate(); let mut jar = CookieJar::new(); assert_secure_behaviour!(jar, jar.private(&key)); } }