Skip to main content

SigningKeys

Struct SigningKeys 

Source
pub struct SigningKeys {
    pub key_id: String,
    /* private fields */
}
Expand description

Local access-token signing keys.

Signs with a single active Ed25519 key (key_id / encoding_key) but verifies against every key in verifiers — the active key plus, after a Self::rotate, the immediately previous key. Publishing both in the JWKS and accepting tokens signed by either gives an overlap window so a key rotation does not instantly invalidate outstanding access tokens; the previous key ages out on the next rotation (its still-valid tokens bounded by the access-token TTL).

Fields§

§key_id: String

Implementations§

Source§

impl SigningKeys

Source

pub fn load_or_create(path: &Path) -> Result<Self, AuthError>

Load the active signing key from path (generating one on first run), plus the previous key from the sibling <path>.prev slot if a prior Self::rotate left one there.

Any key material that does not parse as an Ed25519 PKCS#8 DER key — notably a pre-migration RSA PEM key written by an older release — is quarantined to <path>.retired-<unix-ts> rather than reused, and a fresh Ed25519 key is generated in its place. The retired key is never promoted to a verifier: it is being retired precisely because its signing path is not the one we trust.

Source

pub fn rotate(path: &Path) -> Result<Self, AuthError>

Rotate the signing key while keeping the outgoing key valid for one overlap window.

Moves the current active key into the <path>.prev slot (replacing any older previous key) and generates a fresh active key at path. Access tokens signed by the now-previous key keep validating until their TTL expires, because the returned SigningKeys still carries the previous key as a verifier and advertises it in the JWKS. The caller is responsible for swapping the new value in (e.g. replacing the Arc<SigningKeys> in AuthState).

Source

pub fn issue_access_token( &self, claims: &AccessClaims, ) -> Result<String, AuthError>

Source

pub fn validate_access_token( &self, token: &str, expected_audience: &str, ) -> Result<AccessClaims, AuthError>

👎Deprecated:

Use validate_access_token_with_issuer for RFC 7519 §4.1.1 compliance

Validate access token signature, algorithm, and audience.

NOTE: this method does NOT enforce the iss claim. Callers that need RFC 7519 issuer validation MUST use Self::validate_access_token_with_issuer instead. This entry point is preserved for the lab consumer, which performs its own post-decode iss check. New consumers should always use the issuer-enforcing variant.

Source

pub fn validate_access_token_with_issuer( &self, token: &str, expected_audience: &str, expected_issuer: &str, ) -> Result<AccessClaims, AuthError>

Validate signature, algorithm, audience, AND issuer in a single pass — the issuer is enforced via Validation::set_issuer BEFORE decode (RFC 7519 §4.1.1 compliant) rather than via a manual claims.iss != expected check after decode.

The verification key is selected by the token’s kid header, so a token signed by the previous key during a rotation overlap still validates.

Source

pub const fn jwks(&self) -> &JwksDocument

Trait Implementations§

Source§

impl Clone for SigningKeys

Source§

fn clone(&self) -> SigningKeys

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

impl Debug for SigningKeys

Source§

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

Formats the value using the given formatter. 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> 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> 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.

§

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> 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<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,