Skip to main content

FileTokenProvider

Struct FileTokenProvider 

pub struct FileTokenProvider { /* private fields */ }
Expand description

Reads a bearer token from a file, caching the result for a configurable TTL.

Designed for Kubernetes projected service account tokens and Vault agent sidecars, where the platform writes a short-lived JWT to a known path and rotates it in place before expiry. The cache avoids a filesystem syscall on every call while still picking up rotated tokens within one TTL period.

§Token lifecycle

  • On the first get_token() call (or after the cache TTL expires), the file is read from disk and the result is cached.
  • Subsequent calls within the TTL return the cached string with no I/O.
  • The kubelet guarantees the file is rotated before the old token expires, so there is no window where the cached token is expired but the file has not yet been updated.

§Construction

use rust_auth_lib::{ConfigError, FileTokenProvider};
use std::time::Duration;

// From an explicit path (30 s default TTL):
let provider = FileTokenProvider::new("/var/run/secrets/tokens/my-token");

// From an explicit path with a custom TTL:
let provider = FileTokenProvider::with_ttl(
    "/var/run/secrets/tokens/my-token",
    Duration::from_secs(60),
);

// From environment variables:
let provider_result: Result<FileTokenProvider, ConfigError> =
    FileTokenProvider::from_env();

§Cloning

FileTokenProvider wraps an Arc internally. Cloning is cheap and all clones share the same cache.

Implementations§

§

impl FileTokenProvider

pub fn new(path: impl Into<PathBuf>) -> FileTokenProvider

Create a provider that reads from path with a 30-second cache TTL.

pub fn with_ttl( path: impl Into<PathBuf>, cache_ttl: Duration, ) -> FileTokenProvider

Create a provider that reads from path with an explicit cache TTL.

pub fn from_env() -> Result<FileTokenProvider, ConfigError>

Construct from environment variables.

Reads:

  • SERVICE_TOKEN_FILE (required) — path to the token file
  • SERVICE_TOKEN_CACHE_TTL_SECS (optional, default: 30) — cache TTL in seconds. If the variable is set but cannot be parsed as a u64, it silently falls back to 30.

Trait Implementations§

§

impl Clone for FileTokenProvider

§

fn clone(&self) -> FileTokenProvider

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl TokenProvider for FileTokenProvider

§

fn get_token(&self) -> Result<String, TokenError>

Return the current bearer token string. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

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

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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