From 56b8725a52bee53d267dc27a4ec5934664ef9224 Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Thu, 12 Nov 2026 19:52:38 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20(util):=20A=C3=B1ade=20SecretStr=20?= =?UTF-8?q?para=20contrase=C3=B1as?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit SecretStr guarda un secreto que no se muestra con Debug y se borra de la memoria al descartarse. Lo usan las contraseñas de los ajustes de pagetop-seaorm (db_pass) y pagetop-mail (smtp.password). HttpRequest::from_parts() pasa a ser pública, para crear la petición en un middleware antes de que llegue al handler. --- Cargo.lock | 1 + Cargo.toml | 2 + extensions/pagetop-mail/src/config.rs | 2 +- extensions/pagetop-mail/src/transport.rs | 5 +- extensions/pagetop-seaorm/src/config.rs | 2 +- extensions/pagetop-seaorm/src/lib.rs | 2 +- src/util.rs | 7 ++- src/util/secret.rs | 69 ++++++++++++++++++++++++ src/web.rs | 9 +++- tests/util.rs | 32 +++++++++++ 10 files changed, 124 insertions(+), 7 deletions(-) create mode 100644 src/util/secret.rs diff --git a/Cargo.lock b/Cargo.lock index 67b1a195..6c4db6dc 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2187,6 +2187,7 @@ dependencies = [ "tracing-appender", "tracing-subscriber", "unic-langid", + "zeroize", ] [[package]] diff --git a/Cargo.toml b/Cargo.toml index b5b3d83a..1f4fd6ed 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -71,6 +71,7 @@ unicode-ident = "1.0" unicode-normalization = "0.1" unicode-security = "0.1" url = "2.5" +zeroize = "1.8" # Helpers pagetop-build = { version = "0.3", path = "helpers/pagetop-build" } pagetop-macros = { version = "0.3", path = "helpers/pagetop-macros" } @@ -144,6 +145,7 @@ tracing.workspace = true tracing-appender.workspace = true tracing-subscriber.workspace = true unic-langid.workspace = true +zeroize.workspace = true [dev-dependencies] pagetop-aliner.workspace = true diff --git a/extensions/pagetop-mail/src/config.rs b/extensions/pagetop-mail/src/config.rs index b08b11f9..1e38078e 100644 --- a/extensions/pagetop-mail/src/config.rs +++ b/extensions/pagetop-mail/src/config.rs @@ -154,7 +154,7 @@ pub struct SmtpSettings { pub username: Option, /// Contraseña del usuario. Conviene guardarla en `config/local.toml`, que no se versiona, o /// pasarla con la variable de entorno `PAGETOP_MAIL__SMTP__PASSWORD`. - pub password: Option, + pub password: Option, /// Nombre con el que se presenta la aplicación al servidor (`EHLO`). Sin valor, el nombre del /// equipo. pub hello_name: Option, diff --git a/extensions/pagetop-mail/src/transport.rs b/extensions/pagetop-mail/src/transport.rs index 3537c969..6182b48e 100644 --- a/extensions/pagetop-mail/src/transport.rs +++ b/extensions/pagetop-mail/src/transport.rs @@ -431,7 +431,10 @@ fn smtp_transport(smtp: &SmtpSettings) -> Result { if let Some(username) = smtp.username.as_deref().and_then(util::non_blank) { builder = builder.credentials(Credentials::new( username.to_owned(), - smtp.password.clone().unwrap_or_default(), + smtp.password + .as_ref() + .map_or("", util::SecretStr::expose) + .to_owned(), )); } if let Some(name) = smtp.hello_name.as_deref().and_then(util::non_blank) { diff --git a/extensions/pagetop-seaorm/src/config.rs b/extensions/pagetop-seaorm/src/config.rs index 0dbde0de..b5b82eb4 100644 --- a/extensions/pagetop-seaorm/src/config.rs +++ b/extensions/pagetop-seaorm/src/config.rs @@ -46,7 +46,7 @@ pub struct DatabaseSettings { /// Usuario de conexión a la base de datos (para mysql/postgres). pub db_user: String, /// Contraseña para la conexión a la base de datos (para mysql/postgres). - pub db_pass: String, + pub db_pass: util::SecretStr, /// Servidor de conexión a la base de datos (para mysql/postgres). #[default = "localhost"] pub db_host: String, diff --git a/extensions/pagetop-seaorm/src/lib.rs b/extensions/pagetop-seaorm/src/lib.rs index 7a6ec261..8b0bf1ce 100644 --- a/extensions/pagetop-seaorm/src/lib.rs +++ b/extensions/pagetop-seaorm/src/lib.rs @@ -264,7 +264,7 @@ async fn connect() -> Result { uri.set_username(&settings.db_user) .map_err(|()| DbError::InvalidUrl)?; // https://github.com/launchbadge/sqlx/issues/1624 - uri.set_password(Some(&settings.db_pass)) + uri.set_password(Some(settings.db_pass.expose())) .map_err(|()| DbError::InvalidUrl)?; if let Some(port) = settings.db_port { uri.set_port(Some(port)).map_err(|()| DbError::InvalidUrl)?; diff --git a/src/util.rs b/src/util.rs index 4b3a86b4..80cc2ea3 100644 --- a/src/util.rs +++ b/src/util.rs @@ -1,4 +1,4 @@ -//! Macros y funciones útiles. +//! Macros, tipos y funciones útiles. use crate::trace; @@ -24,6 +24,11 @@ pub use pagetop_minimal::paste; // La documentación anterior está copiada de `pagetop_minimal::paste!` porque el *crate* original // no la define y la de `pagetop_minimal` no se hereda automáticamente. +// **< TIPOS ÚTILES >******************************************************************************* + +mod secret; +pub use secret::SecretStr; + // **< FUNCIONES ÚTILES >*************************************************************************** /// Código requerido por las macros [`pagetop::main`](crate::main) y [`pagetop::test`](crate::test). diff --git a/src/util/secret.rs b/src/util/secret.rs new file mode 100644 index 00000000..6ae102a5 --- /dev/null +++ b/src/util/secret.rs @@ -0,0 +1,69 @@ +use serde::{Deserialize, Deserializer}; +use zeroize::Zeroize; + +use std::fmt; + +/// Un secreto, como una contraseña, que no se puede imprimir por descuido. +/// +/// Sirve tanto para un valor de la configuración (la contraseña de la base de datos o del servidor +/// de correo) como para uno tecleado por el usuario en un formulario. No implementa `Display`, y +/// `Debug` escribe `***`, así que no puede acabar en una traza, un mensaje de error o un `{:?}` de +/// los ajustes. +/// +/// El valor sólo se lee de forma explícita, con [`expose()`](Self::expose), y se borra de la +/// memoria al descartarse. +/// +/// Eso sí, sólo se borra el valor que guarda el tipo. Las copias que se hicieron antes de crearlo +/// (al leer el archivo de configuración o el cuerpo de la petición, por ejemplo) quedan fuera de su +/// alcance. +/// +/// # Ejemplo +/// +/// ```rust +/// # use pagetop::prelude::*; +/// let secret = util::SecretStr::new("hunter2"); +/// assert_eq!(format!("{secret:?}"), "***"); +/// assert_eq!(secret.expose(), "hunter2"); +/// ``` +#[derive(Clone, Default)] +pub struct SecretStr(String); + +impl SecretStr { + /// Crea el secreto a partir de su valor en claro. + pub fn new(value: impl Into) -> Self { + SecretStr(value.into()) + } + + /// Devuelve el valor en claro, para usarlo donde hace falta. + pub fn expose(&self) -> &str { + &self.0 + } + + /// Devuelve si está vacío. + pub fn is_empty(&self) -> bool { + self.0.is_empty() + } + + /// Longitud en bytes. + pub fn len(&self) -> usize { + self.0.len() + } +} + +impl fmt::Debug for SecretStr { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.write_str("***") + } +} + +impl Drop for SecretStr { + fn drop(&mut self) { + self.0.zeroize(); + } +} + +impl<'de> Deserialize<'de> for SecretStr { + fn deserialize>(deserializer: D) -> Result { + String::deserialize(deserializer).map(SecretStr) + } +} diff --git a/src/web.rs b/src/web.rs index ef76e03e..21ce42c9 100644 --- a/src/web.rs +++ b/src/web.rs @@ -331,8 +331,13 @@ impl FromRequestParts for HttpRequest { } impl HttpRequest { - // También la usa el *middleware* que comprueba el acceso de las rutas, antes del *handler*. - pub(crate) fn from_parts(parts: &http::request::Parts) -> Self { + /// Crea la petición a partir de las partes de una petición de Axum, para usarla en un + /// *middleware* antes de que llegue al *handler*. Es lo mismo que hace el extractor con el que + /// la recibe un *handler*. + /// + /// Copia las cabeceras y las extensiones que haya en ese momento: lo que se inserte después en + /// `parts` no aparecerá en la `HttpRequest` creada. + pub fn from_parts(parts: &http::request::Parts) -> Self { HttpRequest(Arc::new(RequestParts { method: parts.method.clone(), uri: parts.uri.clone(), diff --git a/tests/util.rs b/tests/util.rs index 4ed69e01..5ece0acb 100644 --- a/tests/util.rs +++ b/tests/util.rs @@ -354,3 +354,35 @@ mod windows { Ok(()) } } + +// **< Testing SecretStr >************************************************************************** + +#[derive(Debug, serde::Deserialize)] +struct WithSecret { + password: util::SecretStr, + optional: Option, +} + +#[pagetop::test] +async fn secret_str_debug_never_shows_the_value() { + let secret = util::SecretStr::new("hunter2"); + assert_eq!(format!("{secret:?}"), "***"); + assert_eq!(format!("{:?}", Some(&secret)), "Some(***)"); + assert_eq!(secret.expose(), "hunter2"); + assert_eq!(secret.len(), 7); + assert!(util::SecretStr::default().is_empty()); +} + +#[pagetop::test] +async fn secret_str_is_hidden_in_deserialized_settings() { + let settings: WithSecret = + serde_json::from_str(r#"{ "password": "db-s3cr3t", "optional": "smtp-s3cr3t" }"#).unwrap(); + assert_eq!(settings.password.expose(), "db-s3cr3t"); + assert_eq!( + settings.optional.as_ref().map(|s| s.expose()), + Some("smtp-s3cr3t") + ); + + let shown = format!("{settings:?}"); + assert!(!shown.contains("s3cr3t"), "secret printed: {shown}"); +}