pub struct ApiKeyAuthConfig {
pub enabled: bool,
pub keys: Vec<String>,
pub header_name: String,
}Expand description
Per-route API key authentication requirement.
Mirrors spikard_http::ApiKeyConfig for the same reason JwtAuthConfig mirrors
spikard_http::JwtConfig: spikard-core cannot depend on spikard-http. ~keep
Fields§
§enabled: boolWhether this per-route API key auth requirement is active. Present on 10/10 api_key_auth
fixture payloads in the corpus; defaults to true for the same reason as
JwtAuthConfig::enabled. ~keep
keys: Vec<String>Valid API keys. Defaults to empty (rather than being a required field) so that
fixtures/server_config.json’s server_jwt_and_api_key_auth_combined payload
({"enabled": true, "header": "X-API-Key"}, no keys at all) deserializes instead of
hard-failing with “missing field keys”. An empty list is NOT “allow everyone”: a later
enforcement phase MUST treat an empty keys list as a hard misconfiguration error, never
as an open gate. ~keep
header_name: StringHeader name to check (e.g., “X-API-Key”)
Trait Implementations§
Source§impl Clone for ApiKeyAuthConfig
impl Clone for ApiKeyAuthConfig
Source§impl Debug for ApiKeyAuthConfig
impl Debug for ApiKeyAuthConfig
Source§impl<'de> Deserialize<'de> for ApiKeyAuthConfig
impl<'de> Deserialize<'de> for ApiKeyAuthConfig
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
impl Eq for ApiKeyAuthConfig
Source§impl PartialEq for ApiKeyAuthConfig
impl PartialEq for ApiKeyAuthConfig
Source§impl Serialize for ApiKeyAuthConfig
impl Serialize for ApiKeyAuthConfig
impl StructuralPartialEq for ApiKeyAuthConfig
Auto Trait Implementations§
impl Freeze for ApiKeyAuthConfig
impl RefUnwindSafe for ApiKeyAuthConfig
impl Send for ApiKeyAuthConfig
impl Sync for ApiKeyAuthConfig
impl Unpin for ApiKeyAuthConfig
impl UnsafeUnpin for ApiKeyAuthConfig
impl UnwindSafe for ApiKeyAuthConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.