Skip to main content

EnvKeyProvider

Struct EnvKeyProvider 

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

Key provider that reads from environment variables.

§Design Note

The environment variable is read on every call to current_key() rather than being cached at construction time. This is intentional: it allows key rotation by updating the env var (e.g. via a sidecar or init-container) without restarting the process. The overhead of std::env::var is negligible compared to the AES-GCM operations that follow.

§Cached Fallback

If the environment variable is temporarily unset (e.g. during key rotation), the provider falls back to the last successfully loaded key for up to grace_period (default 5 s). After the grace period expires, the missing-variable error is propagated.

§Hardening

  • Grace period reduced from 30 s → 5 s (configurable).
  • clear_cache lets operators explicitly discard the cached key once rotation is complete.
  • Every cache-fallback hit emits the chronix_auth_env_key_grace_hit counter so operators can detect prolonged rotation windows.

Implementations§

Source§

impl EnvKeyProvider

Source

pub fn new(env_var: &str, key_id: &str) -> Self

Create a key provider from an environment variable name.

The environment variable should contain a hex-encoded 256-bit key. The default grace period is 5 seconds.

Source

pub fn with_grace_period(self, duration: Duration) -> Self

Override the grace period for cached key fallback.

Source

pub fn clear_cache(&self)

Explicitly discard the cached key, e.g. after rotation is complete.

Trait Implementations§

Source§

impl Debug for EnvKeyProvider

Source§

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

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

impl KeyProvider for EnvKeyProvider

Source§

fn current_key(&self) -> Result<(SecretKey, String), AuthError>

Get the current (latest) encryption key and its ID.
Source§

fn key_by_id(&self, key_id: &str) -> Result<SecretKey, AuthError>

Get a key by its ID (for decrypting old data).
Source§

fn key_ids(&self) -> Vec<String>

List all available key IDs.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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 = !

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

fn try_from(value: U) -> Result<T, !>

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