Struct ApiKey 

pub struct ApiKey { /* private fields */ }

Represents a generated API key with its hash.

The key field is stored in a SecureString which automatically zeros its memory on drop, preventing potential memory disclosure.

Implementations

impl ApiKey

pub fn generate( prefix: impl Into<String>, environment: impl Into<Environment>, config: KeyConfig, ) -> Result<Self>

pub fn generate_default( prefix: impl Into<String>, environment: impl Into<Environment>, ) -> Result<Self>

pub fn generate_high_security( prefix: impl Into<String>, environment: impl Into<Environment>, ) -> Result<Self>

pub fn verify( provided_key: impl AsRef<str>, stored_hash: impl AsRef<str>, ) -> Result<bool>

pub fn verify_checksum(key: impl AsRef<str>) -> Result<bool>

pub fn key(&self) -> &SecureString

Returns a reference to the secure API key.

To access the underlying string, use .as_ref() on the returned SecureString:

let key_str: &str = api_key.key().as_ref();

Security Note

The key is stored in secure memory that is automatically zeroed on drop. Be careful NOT to clone or log the value unnecessarily.

pub fn hash(&self) -> &str

pub fn parse_prefix(key: &SecureString, separator: Separator) -> Result<String>

pub fn parse_environment( key: &SecureString, separator: Separator, ) -> Result<String>

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.