🔒️ Añade el ajuste secure_cookies para cookies
Las cookies de PageTop se montan con la nueva función `web::cookie_header()`, que añade `Secure` según `[server] secure_cookies`.
This commit is contained in:
parent
84eef9ec4f
commit
3096ed7bfd
9 changed files with 137 additions and 30 deletions
86
src/web/cookie.rs
Normal file
86
src/web/cookie.rs
Normal file
|
|
@ -0,0 +1,86 @@
|
|||
use crate::global;
|
||||
|
||||
use std::fmt::Write;
|
||||
|
||||
/// Devuelve el valor de una cabecera `Set-Cookie` con los atributos comunes de PageTop.
|
||||
///
|
||||
/// Toda *cookie* lleva `HttpOnly`, para que el código JavaScript de la página no pueda leerla, y
|
||||
/// `SameSite=Lax`, para que el navegador no la envíe en las peticiones que otros sitios hacen a la
|
||||
/// aplicación, salvo cuando llevan al usuario a una de sus páginas con `GET` (al seguir un enlace,
|
||||
/// por ejemplo). Lleva además `Secure` si está activado
|
||||
/// [`secure_cookies`](crate::global::ServerSettings::secure_cookies) en `[server]`.
|
||||
///
|
||||
/// - `name` y `value` sólo pueden contener caracteres válidos en una *cookie* (RFC 6265), y `path`
|
||||
/// no puede contener `;`. La función no los comprueba ni los codifica: un `;` añadiría atributos
|
||||
/// a la *cookie*.
|
||||
/// - `path` es la ruta a partir de la cual el navegador envía la *cookie*, `"/"` para toda la
|
||||
/// aplicación.
|
||||
/// - `max_age` son los segundos que dura. Con `None` es una *cookie* de sesión, que el navegador
|
||||
/// borra al cerrarse; con `Some(0)` borra la que tenga el navegador con el mismo nombre y ruta.
|
||||
///
|
||||
/// Es la función que usan las *cookies* de PageTop y de sus extensiones propias, para que todas
|
||||
/// sigan el mismo criterio. Cualquier *cookie* nueva debe cumplir además los criterios de
|
||||
/// [*Cookies*](crate::web#cookies) para no requerir la aceptación del usuario.
|
||||
///
|
||||
/// ```rust
|
||||
/// # use pagetop::prelude::*;
|
||||
/// let cookie = web::cookie_header("theme", "dark", "/", Some(3600));
|
||||
/// assert!(cookie.starts_with("theme=dark; Path=/; HttpOnly; SameSite=Lax"));
|
||||
/// assert!(cookie.ends_with("; Max-Age=3600"));
|
||||
/// ```
|
||||
pub fn cookie_header(name: &str, value: &str, path: &str, max_age: Option<u64>) -> String {
|
||||
build(
|
||||
name,
|
||||
value,
|
||||
path,
|
||||
max_age,
|
||||
global::SETTINGS.server.secure_cookies,
|
||||
)
|
||||
}
|
||||
|
||||
fn build(name: &str, value: &str, path: &str, max_age: Option<u64>, secure: bool) -> String {
|
||||
let mut cookie = String::with_capacity(name.len() + value.len() + path.len() + 64);
|
||||
cookie.push_str(name);
|
||||
cookie.push('=');
|
||||
cookie.push_str(value);
|
||||
cookie.push_str("; Path=");
|
||||
cookie.push_str(path);
|
||||
cookie.push_str("; HttpOnly; SameSite=Lax");
|
||||
if secure {
|
||||
cookie.push_str("; Secure");
|
||||
}
|
||||
if let Some(secs) = max_age {
|
||||
// Escribir en un `String` nunca falla.
|
||||
let _ = write!(cookie, "; Max-Age={secs}");
|
||||
}
|
||||
cookie
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn session_cookie_without_secure() {
|
||||
assert_eq!(
|
||||
build("pagetop_list_x", "q=a", "/items", None, false),
|
||||
"pagetop_list_x=q=a; Path=/items; HttpOnly; SameSite=Lax"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn secure_goes_before_max_age() {
|
||||
assert_eq!(
|
||||
build("pagetop", "sid", "/", Some(1_209_600), true),
|
||||
"pagetop=sid; Path=/; HttpOnly; SameSite=Lax; Secure; Max-Age=1209600"
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn expired_cookie_keeps_secure() {
|
||||
assert_eq!(
|
||||
build("pagetop_flash", "", "/", Some(0), true),
|
||||
"pagetop_flash=; Path=/; HttpOnly; SameSite=Lax; Secure; Max-Age=0"
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
use std::borrow::Cow;
|
||||
|
||||
use crate::web::http::{HeaderMap, HeaderName, HeaderValue, Method, StatusCode, header};
|
||||
use crate::web::{IntoResponse, MethodRouter, Request, Response};
|
||||
use crate::web::{IntoResponse, MethodRouter, Request, Response, cookie_header};
|
||||
|
||||
use axum::extract::OriginalUri;
|
||||
use axum::middleware::{self, Next};
|
||||
|
|
@ -14,9 +14,6 @@ const NAME_LEN: usize = COOKIE_PREFIX.len() + 16;
|
|||
|
||||
const SEC_FETCH_SITE: HeaderName = HeaderName::from_static("sec-fetch-site");
|
||||
|
||||
// Atributos comunes. Sin `Max-Age` es una *cookie* de sesión.
|
||||
const COOKIE_ATTRS: &str = "; HttpOnly; SameSite=Lax";
|
||||
|
||||
// Estado más largo que esto no se recuerda: un listado no necesita tanto y la *cookie* viaja en
|
||||
// cada petición a su ruta y a las que cuelgan de ella.
|
||||
const MAX_STATE_LEN: usize = 1024;
|
||||
|
|
@ -311,17 +308,12 @@ fn cookie_value<'a>(headers: &'a HeaderMap, name: &[u8]) -> Option<&'a [u8]> {
|
|||
}
|
||||
|
||||
fn set_cookie(response: &mut Response, name: &[u8], value: &str, path: &str, expired: bool) {
|
||||
let mut cookie = String::with_capacity(NAME_LEN + value.len() + path.len() + 40);
|
||||
// El nombre es ASCII: el prefijo y cifras hexadecimales.
|
||||
cookie.extend(name.iter().map(|&b| char::from(b)));
|
||||
cookie.push('=');
|
||||
cookie.push_str(value);
|
||||
cookie.push_str("; Path=");
|
||||
cookie.push_str(path);
|
||||
cookie.push_str(COOKIE_ATTRS);
|
||||
if expired {
|
||||
cookie.push_str("; Max-Age=0");
|
||||
}
|
||||
// El nombre es ASCII (el prefijo y cifras hexadecimales), así que siempre es UTF-8 válido.
|
||||
let Ok(name) = str::from_utf8(name) else {
|
||||
return;
|
||||
};
|
||||
// Sin `Max-Age` es una *cookie* de sesión.
|
||||
let cookie = cookie_header(name, value, path, expired.then_some(0));
|
||||
if let Ok(cookie) = HeaderValue::try_from(cookie) {
|
||||
response.headers_mut().append(header::SET_COOKIE, cookie);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue