✨ (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:
parent
f04bcd505b
commit
56b8725a52
10 changed files with 124 additions and 7 deletions
1
Cargo.lock
generated
1
Cargo.lock
generated
|
|
@ -2187,6 +2187,7 @@ dependencies = [
|
||||||
"tracing-appender",
|
"tracing-appender",
|
||||||
"tracing-subscriber",
|
"tracing-subscriber",
|
||||||
"unic-langid",
|
"unic-langid",
|
||||||
|
"zeroize",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
|
||||||
|
|
@ -71,6 +71,7 @@ unicode-ident = "1.0"
|
||||||
unicode-normalization = "0.1"
|
unicode-normalization = "0.1"
|
||||||
unicode-security = "0.1"
|
unicode-security = "0.1"
|
||||||
url = "2.5"
|
url = "2.5"
|
||||||
|
zeroize = "1.8"
|
||||||
# Helpers
|
# Helpers
|
||||||
pagetop-build = { version = "0.3", path = "helpers/pagetop-build" }
|
pagetop-build = { version = "0.3", path = "helpers/pagetop-build" }
|
||||||
pagetop-macros = { version = "0.3", path = "helpers/pagetop-macros" }
|
pagetop-macros = { version = "0.3", path = "helpers/pagetop-macros" }
|
||||||
|
|
@ -144,6 +145,7 @@ tracing.workspace = true
|
||||||
tracing-appender.workspace = true
|
tracing-appender.workspace = true
|
||||||
tracing-subscriber.workspace = true
|
tracing-subscriber.workspace = true
|
||||||
unic-langid.workspace = true
|
unic-langid.workspace = true
|
||||||
|
zeroize.workspace = true
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
pagetop-aliner.workspace = true
|
pagetop-aliner.workspace = true
|
||||||
|
|
|
||||||
|
|
@ -154,7 +154,7 @@ pub struct SmtpSettings {
|
||||||
pub username: Option<String>,
|
pub username: Option<String>,
|
||||||
/// Contraseña del usuario. Conviene guardarla en `config/local.toml`, que no se versiona, o
|
/// 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`.
|
/// pasarla con la variable de entorno `PAGETOP_MAIL__SMTP__PASSWORD`.
|
||||||
pub password: Option<String>,
|
pub password: Option<util::SecretStr>,
|
||||||
/// Nombre con el que se presenta la aplicación al servidor (`EHLO`). Sin valor, el nombre del
|
/// Nombre con el que se presenta la aplicación al servidor (`EHLO`). Sin valor, el nombre del
|
||||||
/// equipo.
|
/// equipo.
|
||||||
pub hello_name: Option<String>,
|
pub hello_name: Option<String>,
|
||||||
|
|
|
||||||
|
|
@ -431,7 +431,10 @@ fn smtp_transport(smtp: &SmtpSettings) -> Result<SmtpTransport, MailError> {
|
||||||
if let Some(username) = smtp.username.as_deref().and_then(util::non_blank) {
|
if let Some(username) = smtp.username.as_deref().and_then(util::non_blank) {
|
||||||
builder = builder.credentials(Credentials::new(
|
builder = builder.credentials(Credentials::new(
|
||||||
username.to_owned(),
|
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) {
|
if let Some(name) = smtp.hello_name.as_deref().and_then(util::non_blank) {
|
||||||
|
|
|
||||||
|
|
@ -46,7 +46,7 @@ pub struct DatabaseSettings {
|
||||||
/// Usuario de conexión a la base de datos (para mysql/postgres).
|
/// Usuario de conexión a la base de datos (para mysql/postgres).
|
||||||
pub db_user: String,
|
pub db_user: String,
|
||||||
/// Contraseña para la conexión a la base de datos (para mysql/postgres).
|
/// 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).
|
/// Servidor de conexión a la base de datos (para mysql/postgres).
|
||||||
#[default = "localhost"]
|
#[default = "localhost"]
|
||||||
pub db_host: String,
|
pub db_host: String,
|
||||||
|
|
|
||||||
|
|
@ -264,7 +264,7 @@ async fn connect() -> Result<DatabaseConnection, DbError> {
|
||||||
uri.set_username(&settings.db_user)
|
uri.set_username(&settings.db_user)
|
||||||
.map_err(|()| DbError::InvalidUrl)?;
|
.map_err(|()| DbError::InvalidUrl)?;
|
||||||
// https://github.com/launchbadge/sqlx/issues/1624
|
// 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)?;
|
.map_err(|()| DbError::InvalidUrl)?;
|
||||||
if let Some(port) = settings.db_port {
|
if let Some(port) = settings.db_port {
|
||||||
uri.set_port(Some(port)).map_err(|()| DbError::InvalidUrl)?;
|
uri.set_port(Some(port)).map_err(|()| DbError::InvalidUrl)?;
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
//! Macros y funciones útiles.
|
//! Macros, tipos y funciones útiles.
|
||||||
|
|
||||||
use crate::trace;
|
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
|
// 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.
|
// no la define y la de `pagetop_minimal` no se hereda automáticamente.
|
||||||
|
|
||||||
|
// **< TIPOS ÚTILES >*******************************************************************************
|
||||||
|
|
||||||
|
mod secret;
|
||||||
|
pub use secret::SecretStr;
|
||||||
|
|
||||||
// **< FUNCIONES ÚTILES >***************************************************************************
|
// **< FUNCIONES ÚTILES >***************************************************************************
|
||||||
|
|
||||||
/// Código requerido por las macros [`pagetop::main`](crate::main) y [`pagetop::test`](crate::test).
|
/// Código requerido por las macros [`pagetop::main`](crate::main) y [`pagetop::test`](crate::test).
|
||||||
|
|
|
||||||
69
src/util/secret.rs
Normal file
69
src/util/secret.rs
Normal 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)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -331,8 +331,13 @@ impl<S: Send + Sync> FromRequestParts<S> for HttpRequest {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl HttpRequest {
|
impl HttpRequest {
|
||||||
// También la usa el *middleware* que comprueba el acceso de las rutas, antes del *handler*.
|
/// Crea la petición a partir de las partes de una petición de Axum, para usarla en un
|
||||||
pub(crate) fn from_parts(parts: &http::request::Parts) -> Self {
|
/// *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 {
|
HttpRequest(Arc::new(RequestParts {
|
||||||
method: parts.method.clone(),
|
method: parts.method.clone(),
|
||||||
uri: parts.uri.clone(),
|
uri: parts.uri.clone(),
|
||||||
|
|
|
||||||
|
|
@ -354,3 +354,35 @@ mod windows {
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// **< Testing SecretStr >**************************************************************************
|
||||||
|
|
||||||
|
#[derive(Debug, serde::Deserialize)]
|
||||||
|
struct WithSecret {
|
||||||
|
password: util::SecretStr,
|
||||||
|
optional: Option<util::SecretStr>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[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}");
|
||||||
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue