✨ (util): Añade SecretStr para contraseñas

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.
This commit is contained in:
Manuel Cillero 2026-11-12 19:52:38 +01:00
parent f04bcd505b
commit 56b8725a52
10 changed files with 124 additions and 7 deletions

View file

@ -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).

69
src/util/secret.rs Normal file
View file

@ -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<String>) -> 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<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
String::deserialize(deserializer).map(SecretStr)
}
}

View file

@ -331,8 +331,13 @@ impl<S: Send + Sync> FromRequestParts<S> 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(),