Struct ApiKey

pub struct ApiKey {
    pub id: String,
    pub name: String,
    pub key: String,
    pub secret_hash: Option<String>,
    pub salt: Option<Salt>,
    pub role: Role,
    pub created_at: DateTime<Utc>,
    pub expires_at: Option<DateTime<Utc>>,
    pub last_used: Option<DateTime<Utc>>,
    pub ip_whitelist: Vec<String>,
    pub active: bool,
    pub usage_count: u64,
}

API key for authentication with comprehensive metadata

Fields

id: String

Unique key identifier (format: lmcp_{role}{timestamp}{random})

name: String

Human-readable name/description

key: String

The actual secret token used for authentication

secret_hash: Option<String>

Secure hash of the secret token (for storage)

salt: Option<Salt>

Salt used for hashing the secret token

role: Role

Role-based permissions

created_at: DateTime<Utc>

Creation timestamp

expires_at: Option<DateTime<Utc>>

Optional expiration timestamp

last_used: Option<DateTime<Utc>>

Last time this key was used

ip_whitelist: Vec<String>

IP address whitelist (empty = all IPs allowed)

active: bool

Is the key currently active

usage_count: u64

Usage count

Implementations

impl ApiKey

pub fn new( name: String, role: Role, expires_at: Option<DateTime<Utc>>, ip_whitelist: Vec<String>, ) -> Self

Create a new API key with secure random generation

pub fn is_expired(&self) -> bool

Check if the key is expired

pub fn is_valid(&self) -> bool

Check if the key is valid for use

pub fn mark_used(&mut self)

Update last used timestamp

pub fn verify_key(&self, provided_key: &str) -> Result<bool, HashingError>

Verify if the provided key matches the stored hash

pub fn to_secure_storage(&self) -> SecureApiKey

Convert to secure storage format (without plain text key)

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.