JwtProvider

Struct JwtProvider 

Source
pub struct JwtProvider {
    pub name: String,
    pub jwks_url: String,
    pub trusted_ca_file: Option<String>,
    pub issuer: Option<String>,
    pub audience: Option<String>,
    pub algorithms: Vec<String>,
    pub refresh_secs: u64,
    pub leeway_secs: u64,
    pub consumer: Option<String>,
    pub retired_key_grace_secs: Option<u64>,
    pub stale_on_error_secs: Option<u64>,
}
Expand description

One JWT verification provider (DW-019).

Fields§

§name: String§jwks_url: String

JWKS endpoint (http:// or https://). Keys are fetched lazily on the first Bearer request, refreshed after refresh_secs, and re-fetched on an unknown kid (key rotation mid-flight).

§trusted_ca_file: Option<String>

Path to a PEM file of CA certificates the JWKS fetcher trusts for its https:// connection INSTEAD of the default public (webpki) root set (#121): for JWKS endpoints served over TLS by a private CA. The file may carry several certificates (a typical CA bundle). Only meaningful with an https:// jwks_url — no TLS is negotiated toward an http:// endpoint, so validation rejects that combination. The file must exist and be readable at config compile time; validation names this field otherwise.

§issuer: Option<String>

Required token issuer (iss claim). Absent: any issuer accepted.

§audience: Option<String>

Required audience (aud claim). Audience is validated ONLY when this is configured (#124, maintainer decision): a provider without an audience ACCEPTS tokens that carry any (or no) aud claim — aud is not interpreted unless the provider names one. All other validations (exp, nbf, iss when configured, the algorithm allowlist) are identical either way.

§algorithms: Vec<String>

Allowed signature algorithms (default ["RS256", "ES256"]). none and HMAC (HS*) algorithms are never allowed implicitly — they must not appear in this list; validation rejects them (asymmetric verification only: the gateway holds no shared secrets with issuers).

§refresh_secs: u64

JWKS cache staleness bound in seconds (default 300): a cached key set older than this is refreshed before use.

§leeway_secs: u64

exp/nbf clock-skew leeway in seconds (default 30).

§consumer: Option<String>

Consumer this provider’s tokens authenticate. Absent: the token’s iss claim is matched against consumers’ jwt credentials.

§retired_key_grace_secs: Option<u64>

How long a key REMOVED from a fresh JWKS fetch keeps verifying (DW-046), in seconds (default 86400 = 24 h; 0 disables). The dual-validity window for JWKS rotation: issuers drop the old key from their JWKS the moment the new one appears, while previously-issued tokens still carry the old kid — during this grace the gateway honors the immediately-previous key set for kids the fresh set no longer carries. Only ONE previous set is retained (rotation is one step at a time). Validation caps the value at 7 days (604800).

§stale_on_error_secs: Option<u64>

How long to serve stale (cached) keys after a JWKS fetch failure (SEC-12, #215), in seconds (default: same as refresh_secs, capped at 300). When a JWKS fetch fails, the cached key set keeps serving for this duration before a new fetch is attempted, so a transient JWKS provider outage does not cascade into auth failures. 0 disables stale-on-error (a fetch failure surfaces immediately when the cache is empty; when the cache is non-empty the existing degraded-mode behavior applies).

Implementations§

Source§

impl JwtProvider

Source

pub fn retired_key_grace_secs(&self) -> u64

retired_key_grace_secs resolved to its effective value (default 86 400; the DW-046 dual-validity window).

Source

pub fn stale_on_error_secs(&self) -> u64

stale_on_error_secs resolved to its effective value (SEC-12, #215): the default is min(refresh_secs, 300) — a failed fetch backs off for at most one refresh interval (capped at 5 min) so a down JWKS endpoint does not chain every Bearer request through a doomed fetch attempt.

Trait Implementations§

Source§

impl Clone for JwtProvider

Source§

fn clone(&self) -> JwtProvider

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JwtProvider

Source§

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

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

impl<'de> Deserialize<'de> for JwtProvider

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for JwtProvider

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for JwtProvider

Source§

fn eq(&self, other: &JwtProvider) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for JwtProvider

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for JwtProvider

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
§

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

§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
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
§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

§

fn coerce_box_to(self: Box<X>) -> Box<T>

§

fn coerce_ref_to(&self) -> &T

§

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

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. 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> TryIntoValue for T
where T: Serialize,

§

type Error = SerializationError

§

fn try_into_value(self) -> Result<Value, <T as TryIntoValue>::Error>

§

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,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

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