Struct ApiKey 

pub struct ApiKey {
    pub key_id: String,
    pub secret_hash: String,
    pub service_account: String,
    pub description: Option<String>,
    pub created_at: SystemTime,
    pub expires_at: Option<SystemTime>,
    pub last_used_at: Option<SystemTime>,
    pub revoked: bool,
    pub allowed_ips: Vec<String>,
    pub permissions: Vec<String>,
}

API Key for service authentication

Security Note

This struct implements a custom Debug that redacts the secret_hash field to prevent accidental leakage to logs.

Fields

key_id: String

Key identifier (public, used for lookup)

secret_hash: String

Hashed secret (never store plaintext)

service_account: String

Service account this key belongs to

description: Option<String>

Human-readable description

created_at: SystemTime

When the key was created

expires_at: Option<SystemTime>

When the key expires (None = never)

last_used_at: Option<SystemTime>

When the key was last used

revoked: bool

Whether the key is revoked

allowed_ips: Vec<String>

IP allowlist (empty = all IPs allowed)

permissions: Vec<String>

Permissions granted to this key

Implementations

impl ApiKey

pub fn generate( service_account: &str, description: Option<&str>, expires_in: Option<Duration>, permissions: Vec<String>, ) -> ServiceAuthResult<(Self, String)>

Generate a new API key

pub fn parse_key(key: &str) -> ServiceAuthResult<(String, String)>

Parse an API key string and extract components

pub fn verify_secret(&self, secret: &str) -> bool

Verify a secret against this key

pub fn is_valid(&self) -> bool

Check if key is valid (not expired, not revoked)

pub fn is_ip_allowed(&self, ip: &str) -> bool

Check if IP is allowed

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.

impl<'de> Deserialize<'de> for ApiKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.