Struct ApiKeyConfig 

pub struct ApiKeyConfig {
    pub enabled: bool,
    pub keys: Vec<String>,
    pub header_name: String,
    pub query_param_name: String,
    pub allow_query_param: bool,
    pub key_prefix: String,
}

API Key configuration

Fields

enabled: bool

Whether API key authentication is enabled

keys: Vec<String>

List of valid API key hashes in PHC format.

For backward compatibility, plain-text keys are also accepted and will be verified with a constant-time string comparison fallback. New deployments should store only hashed keys generated by ApiKeyConfig::generate_key().

header_name: String

Header name for API key (default: “X-API-Key”)

query_param_name: String

Query parameter name for API key (default: api_key)

allow_query_param: bool

Whether to allow API key in query parameters (less secure)

key_prefix: String

API key prefix used by generated keys (e.g., “sk”)

Implementations

impl ApiKeyConfig

pub fn validate(&self) -> Result<()>

Validate configuration

pub fn is_valid_key(&self, key: &str) -> bool

Check if a key is valid

pub fn generate_key(&self) -> Result<GeneratedApiKey>

Generate a new API key and corresponding hash using api-keys-simplified.

The returned plain-text key should be shown once and then discarded. Persist only the returned hash.

Errors

Returns an error if key generation fails

pub fn normalize_key_material(&self, key: &str) -> Result<String>

Normalize API key material for storage.

• Structured Argon2 hashes are kept as-is
• Legacy plain-text keys are converted to legacy:-prefixed Argon2 hashes
• Plain-text fallback remains supported for backward compatibility

Errors

Returns an error if hashing legacy key material fails.

Trait Implementations

impl Clone for ApiKeyConfig

fn clone(&self) -> ApiKeyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyConfig

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

Formats the value using the given formatter.

impl Default for ApiKeyConfig

Available on crate feature api-key only.

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiKeyConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiKeyConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.