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
//! A cookie manager middleware built on top of [tower].
//!
//! ## Example
//!
//! With [axum]:
//!
//! ```rust,no_run
//! use axum::{routing::get, Router};
//! use std::net::SocketAddr;
//! use tower_cookies::{Cookie, CookieManagerLayer, Cookies};
//!
//! # #[cfg(feature = "axum-core")]
//! #[tokio::main]
//! async fn main() {
//! let app = Router::new()
//! .route("/", get(handler))
//! .layer(CookieManagerLayer::new());
//!
//! let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
//! let listener = tokio::net::TcpListener::bind(&addr).await.unwrap();
//! axum::serve(listener, app.into_make_service())
//! .await
//! .unwrap();
//! }
//! # #[cfg(not(feature = "axum-core"))]
//! # fn main() {}
//!
//! async fn handler(cookies: Cookies) -> &'static str {
//! cookies.add(Cookie::new("hello_world", "hello_world"));
//!
//! "Check your cookies."
//! }
//! ```
//!
//! A complete CRUD cookie example in [examples/counter.rs][example]
//!
//! [axum]: https://crates.io/crates/axum
//! [tower]: https://crates.io/crates/tower
//! [example]: https://github.com/imbolc/tower-cookies/blob/main/examples/counter.rs
#![warn(clippy::all, missing_docs, nonstandard_style, future_incompatible)]
#![forbid(unsafe_code)]
#![cfg_attr(docsrs, feature(doc_cfg))]
use cookie::CookieJar;
use http::HeaderValue;
use parking_lot::Mutex;
use std::sync::Arc;
#[doc(inline)]
pub use self::service::{CookieManager, CookieManagerLayer};
#[cfg(feature = "signed")]
pub use self::signed::SignedCookies;
#[cfg(feature = "private")]
pub use self::private::PrivateCookies;
#[cfg(any(feature = "signed", feature = "private"))]
pub use cookie::Key;
pub use cookie::Cookie;
#[doc(inline)]
pub use cookie;
#[cfg(feature = "axum-core")]
#[cfg_attr(docsrs, doc(cfg(feature = "axum-core")))]
mod extract;
#[cfg(feature = "signed")]
mod signed;
#[cfg(feature = "private")]
mod private;
pub mod service;
/// A parsed on-demand cookie jar.
#[derive(Clone, Debug, Default)]
pub struct Cookies {
inner: Arc<Mutex<Inner>>,
}
impl Cookies {
fn new(headers: Vec<HeaderValue>) -> Self {
let inner = Inner {
headers,
..Default::default()
};
Self {
inner: Arc::new(Mutex::new(inner)),
}
}
/// Adds [`Cookie`] to this jar. If a [`Cookie`] with the same name already exists, it is
/// replaced with provided cookie.
pub fn add(&self, cookie: Cookie<'static>) {
let mut inner = self.inner.lock();
inner.changed = true;
inner.jar().add(cookie);
}
/// Returns the [`Cookie`] with the given name. Returns [`None`] if it doesn't exist.
pub fn get(&self, name: &str) -> Option<Cookie> {
let mut inner = self.inner.lock();
inner.jar().get(name).cloned()
}
/// Removes [`Cookie`] from this jar.
pub fn remove(&self, cookie: Cookie<'static>) {
let mut inner = self.inner.lock();
inner.changed = true;
inner.jar().remove(cookie);
}
/// Returns all the [`Cookie`]s present in this jar.
///
/// This method collects [`Cookie`]s into a vector instead of iterating through them to
/// minimize the mutex locking time.
pub fn list(&self) -> Vec<Cookie> {
let mut inner = self.inner.lock();
inner.jar().iter().cloned().collect()
}
/// Returns a child [`SignedCookies`] jar for interations with signed by the `key` cookies.
///
/// # Example:
/// ```
/// use cookie::{Cookie, Key};
/// use tower_cookies::Cookies;
///
/// let cookies = Cookies::default();
/// let key = Key::generate();
/// let signed = cookies.signed(&key);
///
/// let foo = Cookie::new("foo", "bar");
/// signed.add(foo.clone());
///
/// assert_eq!(signed.get("foo"), Some(foo.clone()));
/// assert_ne!(cookies.get("foo"), Some(foo));
/// ```
#[cfg(feature = "signed")]
pub fn signed<'a>(&self, key: &'a cookie::Key) -> SignedCookies<'a> {
SignedCookies::new(self, key)
}
/// Returns a child [`PrivateCookies`] jar for encrypting and decrypting cookies.
///
/// # Example:
/// ```
/// use cookie::{Cookie, Key};
/// use tower_cookies::Cookies;
///
/// let cookies = Cookies::default();
/// let key = Key::generate();
/// let private = cookies.private(&key);
///
/// let foo = Cookie::new("foo", "bar");
/// private.add(foo.clone());
///
/// assert_eq!(private.get("foo"), Some(foo.clone()));
/// assert_ne!(cookies.get("foo"), Some(foo));
/// ```
#[cfg(feature = "private")]
pub fn private<'a>(&self, key: &'a cookie::Key) -> PrivateCookies<'a> {
PrivateCookies::new(self, key)
}
}
#[derive(Debug, Default)]
struct Inner {
headers: Vec<HeaderValue>,
jar: Option<CookieJar>,
changed: bool,
}
impl Inner {
fn jar(&mut self) -> &mut CookieJar {
if self.jar.is_none() {
let mut jar = CookieJar::new();
for header in &self.headers {
if let Ok(header_str) = std::str::from_utf8(header.as_bytes()) {
for cookie_str in header_str.split(';') {
if let Ok(cookie) = cookie::Cookie::parse_encoded(cookie_str.to_owned()) {
jar.add_original(cookie);
}
}
}
}
self.jar = Some(jar);
}
self.jar.as_mut().unwrap()
}
}
#[cfg(all(test, feature = "axum-core"))]
mod tests {
use crate::{CookieManagerLayer, Cookies};
use axum::{body::Body, routing::get, Router};
use cookie::Cookie;
use http::{header, Request};
use http_body_util::BodyExt;
use tower::ServiceExt;
fn app() -> Router {
Router::new()
.route(
"/list",
get(|cookies: Cookies| async move {
let mut items = cookies
.list()
.iter()
.map(|c| format!("{}={}", c.name(), c.value()))
.collect::<Vec<_>>();
items.sort();
items.join(", ")
}),
)
.route(
"/add",
get(|cookies: Cookies| async move {
cookies.add(Cookie::new("baz", "3"));
cookies.add(Cookie::new("spam", "4"));
}),
)
.route(
"/remove",
get(|cookies: Cookies| async move {
cookies.remove(Cookie::new("foo", ""));
}),
)
.layer(CookieManagerLayer::new())
}
async fn body_string(body: Body) -> String {
let bytes = body.collect().await.unwrap().to_bytes();
String::from_utf8_lossy(&bytes).into()
}
#[tokio::test]
async fn read_cookies() {
let req = Request::builder()
.uri("/list")
.header(header::COOKIE, "foo=1; bar=2")
.body(Body::empty())
.unwrap();
let res = app().oneshot(req).await.unwrap();
assert_eq!(body_string(res.into_body()).await, "bar=2, foo=1");
}
#[tokio::test]
async fn read_multi_header_cookies() {
let req = Request::builder()
.uri("/list")
.header(header::COOKIE, "foo=1")
.header(header::COOKIE, "bar=2")
.body(Body::empty())
.unwrap();
let res = app().oneshot(req).await.unwrap();
assert_eq!(body_string(res.into_body()).await, "bar=2, foo=1");
}
#[tokio::test]
async fn add_cookies() {
let req = Request::builder()
.uri("/add")
.header(header::COOKIE, "foo=1; bar=2")
.body(Body::empty())
.unwrap();
let res = app().oneshot(req).await.unwrap();
let mut hdrs: Vec<_> = res.headers().get_all(header::SET_COOKIE).iter().collect();
hdrs.sort();
assert_eq!(hdrs, ["baz=3", "spam=4"]);
}
#[tokio::test]
async fn remove_cookies() {
let req = Request::builder()
.uri("/remove")
.header(header::COOKIE, "foo=1; bar=2")
.body(Body::empty())
.unwrap();
let res = app().oneshot(req).await.unwrap();
let mut hdrs = res.headers().get_all(header::SET_COOKIE).iter();
let hdr = hdrs.next().unwrap().to_str().unwrap();
assert!(hdr.starts_with("foo=; Max-Age=0"));
assert_eq!(hdrs.next(), None);
}
}