jose 0.0.2

A JSON Object Signing and Encryption implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

use alloc::string::String;

/// Errors that may occur while working [`JoseHeader`](super::JoseHeader)
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// Found a header parameter that must be protected in the unprotected
    /// `header` parameter
    #[error("found an unprotected header parameter, that must be proctected")]
    ExpectedProtected,
    /// The `protected` and (unprotected) `header` parameter share members with
    /// the same name
    #[error("the protected and unprotected header parameters share members with the same name")]
    NotDisjoint,
    /// Both the `protected` and (unprotected) `header` members in a JWS or JWE
    /// are empty.
    #[error("both the protected and unprotected header parameters are empty")]
    NoHeader,
    /// The `protected` or the (unprotected) `header` member is present but
    /// contains no members (it is an empty object `{}`)
    #[error("the protected or the unprotected header parameter is empty")]
    EmptyHeader,
    /// Found a header parameter name that is forbidden as per [section 4.1.11
    /// of RFC 7515]
    ///
    /// [section 4.1.11 of RFC 7515]: <https://www.rfc-editor.org/rfc/rfc7515.html#section-4.1.11>
    #[error("found a forbidden header parameter: {0}")]
    ForbiddenHeader(String),
    /// A REQUIRED header is missing (e.g. the `alg` header)
    #[error("a required header is missing: {0}")]
    MissingHeader(String),
    /// The `crit` header is present but an empty list (`[]`)
    #[error("the crit header is empty")]
    EmptyCriticalHeaders,
    /// A JSON deserialization error, see [`serde_json::Error`] for details.
    #[error(transparent)]
    JsonError(#[from] serde_json::Error),
}