Skip to main content

KeySet

Struct KeySet 

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

A parsed set of verification keys.

Immutable once built. A set that has to change – a JWKS fetched again after its issuer rotated a key – is replaced whole through JwtKeys, so a request never sees half of one set and half of another.

Implementations§

Source§

impl KeySet

Source

pub fn from_secret( secret: &str, secret_is_base64: bool, ) -> Result<Self, JwtKeyError>

Read PGRST_JWT_SECRET.

Base64 is undone first when the configuration says the secret is base64, and what it decodes to is then read like any other secret – so a base64-encoded JWK is a JWK, as in PostgREST.

Source

pub fn from_jwk_json(json: &str) -> Result<Self, JwtKeyError>

Read a JWK, or a JWK Set ({"keys": [...]}), from its JSON.

Keys that cannot verify a signature – "use": "enc", key_ops without verify, an encryption alg, a key type or curve this server does not implement – are set aside with a warning rather than failing the whole set, because an identity provider’s JWKS routinely mixes them in with its signing keys. A set left with no key at all is an error.

A key that claims to be usable and is malformed fails the set: that is a mistake in the configuration, not a key meant for something else.

Source

pub fn len(&self) -> usize

How many keys the set holds.

Source

pub fn is_empty(&self) -> bool

Whether the set holds no keys. Never true of a set parsed from a secret; true of the set a JWKS URL starts with, before its first fetch.

Trait Implementations§

Source§

impl Debug for KeySet

Source§

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

The shape of the set, never the key material: a Debug of the configuration ends up in logs.

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> MaybeSendSync for T
where T: Send + Sync + ?Sized,

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