Struct ApiKeyStore

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

In-memory API key store. Persists to JSON.

Implementations§

Source§

impl ApiKeyStore

Source

pub fn new() -> Self

Source

pub fn load_from_file(path: impl AsRef<Path>) -> Result<Self>

Load from a JSON file. Missing file → empty store.

Source

pub fn reload_from_file(&self, path: impl AsRef<Path>) -> Result<()>

Atomically replace the in-memory key set from a complete persisted snapshot. A parse or I/O failure leaves the currently active set untouched, so a partial secret projection cannot erase valid keys.

Source

pub fn save_to_file(&self, path: impl AsRef<Path>) -> Result<()>

Save to a JSON file.

Source

pub fn create( &self, prefix: impl Into<String>, scopes: Vec<String>, ttl: Option<Duration>, ) -> Result<(ApiKey, String)>

Create a new key. Returns the key record and the raw secret string (the caller must surface it to the user once; we never store the raw).

§Errors

Returns AuthError::Other if Argon2 fails (extremely rare; only happens on out-of-memory).

§Examples
use agentguard_auth::ApiKeyStore;
use std::time::Duration;
let store = ApiKeyStore::new();
let (key, raw) = store.create("ag_live", vec!["read".into()], Some(Duration::from_secs(3600))).unwrap();
assert_eq!(key.prefix, "ag_live");
// Surface `raw` to the user once. It looks like: ag_live_<uuid>_<base64>
Source

pub fn create_bound( &self, prefix: impl Into<String>, scopes: Vec<String>, ttl: Option<Duration>, identity: ApiKeyIdentity, ) -> Result<(ApiKey, String)>

Create a key bound to one Cedar subject and optional tenant. Decision routes accept only identity-bound keys and require the authorize scope (or *).

Source

pub fn verify(&self, raw: &str) -> Result<ApiKey>

Verify a raw API key string. Returns a cloned ApiKey on success.

Format: <prefix>:<id>:<base64url-secret>. The : separator ensures the parse is unambiguous even when the prefix or secret contain _ (which is in the base64url alphabet).

Source

pub fn revoke(&self, id: &str) -> Result<()>

Revoke a key by id.

Source

pub fn list(&self) -> Vec<ApiKey>

List all keys (no secrets).

Trait Implementations§

Source§

impl Debug for ApiKeyStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ApiKeyStore

Source§

fn default() -> ApiKeyStore

Returns the “default value” for a type. Read more

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.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,