Struct SecurePassword 

pub struct SecurePassword(/* private fields */);

A wrapper for sensitive password data that clears itself on drop.

SecurePassword provides a secure container for password strings that automatically clears the password from memory when the wrapper is dropped. This prevents passwords from lingering in memory where they could be extracted by memory inspection attacks.

Security Properties

• Zeroization: Password bytes are overwritten with zeros on drop
• Debug Safety: Debug output shows [REDACTED] instead of the password
• Clone Safety: Cloning creates a new secure copy (both are zeroized independently)

Thread Safety

SecurePassword is Send and can be moved between threads. It is also Clone, creating independent copies that are each zeroized on drop.

Example

use vanguards_rs::SecurePassword;

// Create a secure password
let password = SecurePassword::new("my_secret_password".to_string());

// Access the password when needed
assert_eq!(password.as_str(), "my_secret_password");

// Debug output is safe
let debug = format!("{:?}", password);
assert!(debug.contains("REDACTED"));
assert!(!debug.contains("my_secret"));

// Password is automatically cleared when dropped
drop(password);

See Also

• Vanguards::from_config - Uses SecurePassword internally
• zeroize - The underlying zeroization library

Implementations

impl SecurePassword

pub fn new(password: String) -> Self

Creates a new secure password wrapper.

Arguments

• password - The password string to wrap securely

Example

use vanguards_rs::SecurePassword;

let password = SecurePassword::new("secret123".to_string());

pub fn as_str(&self) -> &str

Returns a reference to the password string.

Security Note

The returned reference is valid only while the SecurePassword exists. Avoid storing this reference or converting it to an owned String, as that would defeat the purpose of secure password handling.

Example

use vanguards_rs::SecurePassword;

let password = SecurePassword::new("secret123".to_string());
assert_eq!(password.as_str(), "secret123");

Trait Implementations

impl Clone for SecurePassword

fn clone(&self) -> SecurePassword

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecurePassword

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for SecurePassword

fn drop(&mut self)

Executes the destructor for this type.