Struct SecureCredentials 

pub struct SecureCredentials { /* private fields */ }

Secure credentials with automatic zeroization on drop.

This type is only available when the zeroize feature is enabled. All sensitive fields are securely zeroed from memory when the credentials are dropped.

Example

use mssql_auth::SecureCredentials;

let creds = SecureCredentials::sql_server("user", "password");
// When `creds` goes out of scope, the password is securely zeroed

Implementations

impl SecureCredentials

pub fn sql_server( username: impl Into<String>, password: impl Into<String>, ) -> SecureCredentials

Create SQL Server credentials with secure password handling.

pub fn azure_token(token: impl Into<String>) -> SecureCredentials

Create Azure access token credentials with secure token handling.

pub fn is_sql_auth(&self) -> bool

Check if these credentials use SQL authentication.

pub fn is_azure_ad(&self) -> bool

Check if these credentials use Azure AD.

pub fn method_name(&self) -> &'static str

Get the authentication method name.

pub fn username(&self) -> Option<&str>

Get the username for SQL Server authentication.

Returns None for non-SQL authentication methods.

pub fn password(&self) -> Option<&str>

Get the password for SQL Server authentication.

Returns None for non-SQL authentication methods.

Security

Be careful with the returned reference - avoid logging or copying the value unnecessarily.

pub fn token(&self) -> Option<&str>

Get the token for Azure AD authentication.

Returns None for non-Azure AD authentication methods.

Security

Be careful with the returned reference - avoid logging or copying the value unnecessarily.

Trait Implementations

impl Clone for SecureCredentials

fn clone(&self) -> SecureCredentials

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecureCredentials

Available on crate feature zeroize only.

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

Formats the value using the given formatter.

impl Drop for SecureCredentials

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<Credentials> for SecureCredentials

Available on crate feature zeroize only.

Convert from non-secure credentials to secure credentials.

fn from(creds: Credentials) -> SecureCredentials

Converts to this type from the input type.

impl Zeroize for SecureCredentials

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.