Struct AuthConfig 

#[non_exhaustive]
pub struct AuthConfig {
    pub enabled: bool,
    pub api_keys: Vec<ApiKeyEntry>,
    pub mtls: Option<MtlsConfig>,
    pub rate_limit: Option<RateLimitConfig>,
    pub oauth: Option<OAuthConfig>,
}

Authentication configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Master switch - when false, all requests are allowed through.

api_keys: Vec<ApiKeyEntry>

Bearer token API keys.

mtls: Option<MtlsConfig>

mTLS client certificate authentication.

rate_limit: Option<RateLimitConfig>

Rate limiting for auth attempts.

oauth: Option<OAuthConfig>

OAuth 2.1 JWT bearer token authentication.

Implementations

impl AuthConfig

pub fn with_keys(keys: Vec<ApiKeyEntry>) -> Self

Create an enabled auth config with the given API keys.

pub fn with_rate_limit(self, rate_limit: RateLimitConfig) -> Self

Set rate limiting on this auth config.

pub fn check_oauth_feature(&self) -> Result<(), RmcpServerKitError>

Reject an [auth.oauth] table in a build compiled without the oauth cargo feature.

Fails closed on purpose. Ignoring the table would start the server with OAuth silently disabled while the operator’s configuration says it is on – for a bearer-token deployment that is an unauthenticated server.

Errors

Returns RmcpServerKitError::Config when auth.oauth is present and the oauth feature is disabled. Always Ok when the feature is enabled, where the table is parsed into oauth::OAuthConfig instead.

pub fn validate_api_key_names(&self) -> Result<(), RmcpServerKitError>

Reject any configured API key whose name is blank (empty or whitespace-only).

The key name is the session-binding fingerprint’s stable id for bearer auth, so two blank-named keys hash identically and one key’s session becomes usable by the other (CWE-384). The first offending index is named so an operator can locate the entry in their key list.

Errors

Returns RmcpServerKitError::Config naming the first API-key index whose name is blank.

impl AuthConfig

pub fn summary(&self) -> AuthConfigSummary

Produce a hash-free summary of the auth config for admin endpoints.

Trait Implementations

impl Clone for AuthConfig

fn clone(&self) -> AuthConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthConfig

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

Formats the value using the given formatter.

impl Default for AuthConfig

fn default() -> AuthConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AuthConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.