Skip to main content

ApiKeyStore

Struct ApiKeyStore 

Source
pub struct ApiKeyStore { /* private fields */ }
Expand description

In-memory store of API key entries loaded from a JSON file.

Implementations§

Source§

impl ApiKeyStore

Source

pub fn from_entries(entries: Vec<ApiKeyEntry>) -> Self

Build a store directly from in-memory entries.

Used by the local single-process entrypoint (AAASM-3369), which seeds a single admin key from the environment (or a generated one) without a keys-on-disk file.

Source

pub fn load(path: &Path) -> Result<Self, ApiKeyError>

Load API key entries from a JSON file.

Returns an empty store if the file does not exist.

Source

pub fn revoke(&self, key_id: &str)

Mark a key ID as revoked; subsequent validate_detailed calls for that key will return Err(KeyNotValid::Revoked).

Source

pub fn validate_detailed( &self, raw_key: &str, ) -> Result<&ApiKeyEntry, KeyNotValid>

Validate a raw API key and distinguish revoked from not-found.

Returns Ok(&ApiKeyEntry) on success, Err(KeyNotValid::Revoked) if the key exists but has been revoked, or Err(KeyNotValid::NotFound) for any other failure (parse error, wrong hash, unknown key).

Source

pub fn validate(&self, raw_key: &str) -> Option<&ApiKeyEntry>

Validate a raw API key string against stored entries.

Returns the matching entry if the key is valid, or None if no match. Use validate_detailed when the caller needs to distinguish revoked keys from unknown keys.

Source

pub fn len(&self) -> usize

Return the number of stored entries.

Source

pub fn is_empty(&self) -> bool

Check if the store is empty.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more