Enum ClaimsError 

#[non_exhaustive]
pub enum ClaimsError {
    Malformed,
    WrongType,
    Unverified,
    Resolver(CratestackError),
    Signer(CratestackError),
    Misuse(&'static str),
}

A failure of sign_claims or open_claims.

The variants a verifier can reach carry nothing about the bytes it was given, so a caller that forwards the error to the peer leaks nothing beyond the variant (Unverified covers an unknown kid and a bad signature alike). into_error maps them onto the envelope’s 401 / 500 split.

#[non_exhaustive]: match with a wildcard arm.

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.

Malformed

Not a canonical, tagged COSE_Sign1 of the claim-object profile: a wrong tag, a non-minimal or indefinite encoding, an unknown or out-of-order header label, a non-empty unprotected header, a detached payload, a missing typ, a MAC algorithm, trailing bytes, and so on. A transport envelope presented here ends up in this variant.

WrongType

A well-formed claim object whose typ is not the one expected.

Unverified

No key the resolver returned verified the signature. An unknown kid is this too: the two are deliberately not told apart.

Resolver(CratestackError)

The key resolver failed (an outage, not a verdict on the object).

Signer(CratestackError)

The signer failed (an outage, not a verdict on the inputs).

Misuse(&'static str)

The caller’s inputs or signer are wrong, whatever the message: a MAC signer, a kid that is not 8 bytes, an empty or oversized typ, aud or cti, or a signature of the wrong length.

Implementations

impl ClaimsError

pub fn into_error(self) -> CratestackError

The envelope’s mapping (ADR 0006 §10): a verdict on the object is Unauthorized carrying the one fixed message, a backend failure or local misuse is Internal. A method, not a From impl: a second From<_> for CratestackError in a graph makes inference ambiguous (see crate::error).

Trait Implementations

impl Debug for ClaimsError

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

Formats the value using the given formatter.

impl Display for ClaimsError

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

Formats the value using the given formatter.

impl Error for ClaimsError

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.