Enum SignatureVerificationError

#[non_exhaustive]
pub enum SignatureVerificationError {
    AmbiguousKeyId(String),
    CryptoError(String),
    DisallowedAlg(String),
    InvalidKey(String),
    NoMatchingKey,
    UnsupportedAlg(String),
    Other(String),
}

Error verifying claims signature.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AmbiguousKeyId(String)

More than one key matches the supplied key constraints (e.g., key ID).

CryptoError(String)

Invalid signature for the supplied claims and signing key.

DisallowedAlg(String)

The supplied signature algorithm is disallowed by the verifier.

InvalidKey(String)

The supplied key cannot be used in this context. This may occur if the key type does not match the signature type (e.g., an RSA key used to validate an HMAC) or the JWK usage disallows signatures.

NoMatchingKey

The signing key needed for verifying the JSON Web Token’s signature/MAC could not be found. This error can occur if the key ID (kid) specified in the JWT’s JOSE header does not match the ID of any key in the OpenID Connect provider’s JSON Web Key Set (JWKS), typically retrieved from the provider’s JWKS document. To support rotation of asymmetric signing keys, client applications should consider refreshing the JWKS document (via JsonWebKeySet::fetch).

This error can also occur if the identified JSON Web Key is of the wrong type (e.g., an RSA key when the JOSE header specifies an ECDSA algorithm) or does not support signing.

UnsupportedAlg(String)

Unsupported signature algorithm.

Other(String)

An unexpected error occurred.

Trait Implementations

impl Clone for SignatureVerificationError

fn clone(&self) -> SignatureVerificationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignatureVerificationError

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

Formats the value using the given formatter.

impl Display for SignatureVerificationError

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

Formats the value using the given formatter.

impl Error for SignatureVerificationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for SignatureVerificationError

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SignatureVerificationError