jsonwebtokens 1.2.0

A Json Web Token implementation for Rust
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

use std::error::Error as StdError;
use std::fmt;

#[derive(Debug)]
#[non_exhaustive]
pub struct ErrorDetails {
    desc: String,
    src: Option<Box<dyn StdError + Send + Sync + 'static>>,
}

impl ErrorDetails {
    pub fn new(desc: impl Into<String>) -> ErrorDetails {
        ErrorDetails {
            desc: desc.into(),
            src: None,
        }
    }

    pub fn map(
        desc: impl Into<String>,
        src: Box<dyn StdError + Send + Sync + 'static>,
    ) -> ErrorDetails {
        ErrorDetails {
            desc: desc.into(),
            src: Some(src),
        }
    }
}

impl From<String> for ErrorDetails {
    fn from(s: String) -> Self {
        ErrorDetails { desc: s, src: None }
    }
}

#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
    /// Any of: invalid key data, malformed data for encoding, base864/utf8 decode/encode errors
    InvalidInput(ErrorDetails),

    /// The alg found in the token header didn't match the given algorithm
    AlgorithmMismatch(),

    /// The token's signature was not validated
    InvalidSignature(),

    /// The token expired at this time (unix epoch timestamp)
    TokenExpiredAt(u64),

    /// Any of: header.payload.signature split error, json parser error, header or claim validation error
    MalformedToken(ErrorDetails),
}

impl StdError for Error {
    fn source(&self) -> Option<&(dyn StdError + 'static)> {
        match self {
            Error::InvalidInput(ErrorDetails { src: Some(s), .. }) => Some(s.as_ref()),
            Error::AlgorithmMismatch() => None,
            Error::InvalidSignature() => None,
            Error::TokenExpiredAt(_) => None,
            Error::MalformedToken(ErrorDetails { src: Some(s), .. }) => Some(s.as_ref()),
            _ => None,
        }
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::InvalidInput(details) => write!(f, "Invalid Input: {}", details.desc),
            Error::AlgorithmMismatch() => write!(f, "JWT Algorithm Mismatch"),
            Error::InvalidSignature() => write!(f, "JWT Signature Invalid"),
            Error::TokenExpiredAt(when) => write!(f, "JWT token expired at {when}"),
            Error::MalformedToken(details) => write!(f, "JWT claims invalid: {}", details.desc),
        }
    }
}