Skip to main content

ApiKeyManager

Struct ApiKeyManager 

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

API key manager

Implementations§

Source§

impl ApiKeyManager

Source

pub fn new(config: ApiKeyConfig) -> Self

Create a new API key manager

Source

pub fn generate_key( &self, identity: Identity, name: String, scopes: Vec<String>, expires_in: Option<Duration>, rate_limit: Option<u32>, ) -> Result<(ApiKey, String), ApiKeyError>

Generate a new API key

Source

pub fn validate(&self, key: &str) -> Result<ApiKey, ApiKeyError>

Validate an API key

Source

pub fn validate_to_identity(&self, key: &str) -> Result<Identity, ApiKeyError>

Validate key and convert to identity

Source

pub fn validate_with_scopes( &self, key: &str, required_scopes: &[&str], ) -> Result<ApiKey, ApiKeyError>

Validate key with required scopes

Source

pub fn validate_with_ip( &self, key: &str, client_ip: &IpAddr, ) -> Result<ApiKey, ApiKeyError>

Validate key with IP check

Source

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

Revoke an API key

Source

pub fn delete(&self, key_id: &str) -> Result<(), ApiKeyError>

Delete an API key

Source

pub fn get(&self, key_id: &str) -> Option<ApiKey>

Get an API key by ID

Source

pub fn list_by_user(&self, user_id: &str) -> Vec<ApiKey>

List all API keys for a user

Source

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

List all active API keys

Source

pub fn update_metadata( &self, key_id: &str, metadata: HashMap<String, String>, ) -> Result<(), ApiKeyError>

Update API key metadata

Source

pub fn update_scopes( &self, key_id: &str, scopes: Vec<String>, ) -> Result<(), ApiKeyError>

Update API key scopes

Source

pub fn update_allowed_ips( &self, key_id: &str, ips: Vec<IpAddr>, ) -> Result<(), ApiKeyError>

Update API key allowed IPs

Source

pub fn rotate(&self, key_id: &str) -> Result<String, ApiKeyError>

Rotate an API key (generate new key value, same ID)

Source

pub fn stats(&self) -> ApiKeyStats

Get key statistics

Source

pub fn cleanup_expired(&self)

Cleanup expired keys

Source

pub fn key_prefix(&self) -> &str

Get the key prefix

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<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> 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.
Source§

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

Source§

fn vzip(self) -> V

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