Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidPem(String),
    UnexpectedPemLabel(String, &'static str),
    InvalidPkcs8(String),
    UnsupportedAlgorithm(String),
    UnsupportedRsaSize(u32),
    Crypto(&'static str),
    KeyGeneration(&'static str),
    InvalidBase64(Error),
    InvalidMultibase(Error),
    InvalidMultikeyPrefix,
    InvalidMultikeyLength {
        expected: usize,
        actual: usize,
    },
    MissingHeader(&'static str),
    InvalidHeader {
        name: &'static str,
        reason: String,
    },
    MalformedSignatureHeader(String),
    VerificationFailed,
    KeyResolution(String),
    DigestMismatch,
    UnsupportedDigestAlgorithm(String),
    RequiredHeaderAbsent(String),
    MissingSignatureParameter(&'static str),
    TimestampMissing,
    TimestampTooOld {
        timestamp: DateTime<Utc>,
        now: DateTime<Utc>,
    },
    TimestampInFuture {
        timestamp: DateTime<Utc>,
        now: DateTime<Utc>,
    },
    TimestampExpired {
        expires: DateTime<Utc>,
        now: DateTime<Utc>,
    },
}

Enumeration of every failure mode that this crate can surface.

The enum is non-exhaustive so that additional signature schemes or cryptographic algorithms can be added in minor releases without breaking downstream code.

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.

InvalidPem(String)

The provided PEM document could not be parsed.

UnexpectedPemLabel(String, &'static str)

The PEM document had an unexpected -----BEGIN <LABEL>----- line.

InvalidPkcs8(String)

A PKCS#8 DER blob could not be decoded.

UnsupportedAlgorithm(String)

The key’s algorithm identifier was not supported.

UnsupportedRsaSize(u32)

The RSA key size was outside the supported range.

The bounds mirror aws-lc-rs’s RSA_PKCS1_2048_8192_SHA256 verification profile: any modulus width between 2048 and 8192 bits (inclusive) whose byte count is whole (i.e. divisible by 8) is accepted.

Crypto(&'static str)

An underlying aws-lc-rs primitive failed.

KeyGeneration(&'static str)

Generation of a new key failed at the RNG layer.

InvalidBase64(Error)

A signature’s Base64 encoding was malformed.

InvalidMultibase(Error)

Multibase decoding of a FEP-521a publicKeyMultibase failed.

InvalidMultikeyPrefix

The multicodec prefix on a Multikey was unrecognised or truncated.

InvalidMultikeyLength

The raw key material following the multicodec prefix had the wrong length.

Fields

expected: usize

Expected number of key bytes.

actual: usize

Actual number of key bytes.

MissingHeader(&'static str)

A required HTTP header is missing.

InvalidHeader

An HTTP header’s value was not valid UTF-8 or otherwise unparseable.

Fields

name: &'static str

Header name that could not be parsed.

reason: String

Human-readable reason.

MalformedSignatureHeader(String)

The Signature header’s parameter list was malformed.

VerificationFailed

The signature did not verify against the provided key.

KeyResolution(String)

The resolver closure returned an error while fetching the signer’s key.

DigestMismatch

The Digest / Content-Digest header did not match the body.

UnsupportedDigestAlgorithm(String)

The requested digest algorithm is not supported.

RequiredHeaderAbsent(String)

The signature-base string includes a header that the request does not carry.

MissingSignatureParameter(&'static str)

A signature parameter required by the standard is missing.

TimestampMissing

The signature carried no created parameter and no Date header, and the active VerifyPolicy requires one.

TimestampTooOld

The signature is older than the policy’s max_age.

Fields

timestamp: DateTime<Utc>

The signed timestamp, either from created or the Date header.

now: DateTime<Utc>

The verifier’s current wall-clock time.

TimestampInFuture

The signature claims to have been produced further in the future than the policy’s max_clock_skew_future tolerance allows.

Fields

timestamp: DateTime<Utc>

The signed timestamp.

now: DateTime<Utc>

The verifier’s current wall-clock time.

TimestampExpired

The signature’s expires parameter indicates it has lapsed.

Fields

expires: DateTime<Utc>

The expires parameter interpreted as a UTC timestamp.

now: DateTime<Utc>

The verifier’s current wall-clock time.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.