use alloc::string::String;
use core::fmt;
#[must_use]
#[derive(Clone, Default)]
pub struct Secret(String);
impl Secret {
pub fn new(value: impl Into<String>) -> Self {
Self(value.into())
}
#[must_use]
pub(crate) fn as_bytes(&self) -> &[u8] {
self.0.as_bytes()
}
}
impl fmt::Debug for Secret {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("Secret(**redacted**)")
}
}
impl fmt::Display for Secret {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("Secret(**redacted**)")
}
}
#[cfg(test)]
mod tests {
use super::Secret;
#[test]
fn debug_and_display_are_redacted() {
let s = Secret::new("super-secret-hmac-key");
assert_eq!(format!("{s:?}"), "Secret(**redacted**)");
assert_eq!(s.to_string(), "Secret(**redacted**)");
assert!(!format!("{s:?}").contains("super"));
}
#[test]
fn debug_of_containing_struct_does_not_leak_via_derive_chain() {
let s = Secret::new("leak-me");
assert_eq!(format!("{s:?}"), "Secret(**redacted**)");
}
}