jwt-service 0.2.2

A high-performance async library for JWT (JSON Web Token) authentication and authorization. Supports token generation, validation, and custom claims with optimized memory usage, ideal for HTTP clients/servers and web applications.
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
79
80
81
82
83

use crate::*;

/// JWT configuration struct containing secret key, expiration time, and issuer.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct JwtConfig {
    /// The secret key used for signing JWT tokens.
    pub(super) secret: String,
    /// Token expiration time in seconds.
    pub(super) expiration_seconds: u64,
    /// The issuer of the JWT token.
    pub(super) issuer: String,
}

/// Standard JWT claims struct with common fields.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct JwtExtraJwtClaims {
    /// The subject (user identifier) of the token.
    pub(super) sub: String,
    /// The issuer of the token.
    pub(super) iss: String,
    /// Expiration time as a Unix timestamp.
    pub(super) exp: usize,
    /// Issued at time as a Unix timestamp.
    pub(super) iat: usize,
    /// Not before time as a Unix timestamp.
    pub(super) nbf: usize,
}

/// JWT token response struct containing the token and metadata.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct JwtToken {
    /// The encoded JWT token string.
    pub(super) token: String,
    /// The token type (typically "Bearer").
    pub(super) token_type: String,
    /// Token expiration time in seconds.
    pub(super) expires_in: u64,
}

/// JWT service struct providing token generation and validation functionality.
#[derive(Clone, Debug)]
pub struct JwtService {
    /// The JWT configuration.
    pub(super) config: JwtConfig,
    /// The encoding key for signing tokens.
    pub(super) encoding_key: EncodingKey,
    /// The decoding key for verifying tokens.
    pub(super) decoding_key: DecodingKey,
    /// The validation settings for token verification.
    pub(super) validation: Validation,
}

/// Generic JWT claims struct that supports custom payload data.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct CustomExtraJwtClaims<T: Default> {
    /// The custom payload data.
    #[serde(flatten)]
    pub(super) custom: T,
    /// The subject (user identifier) of the token.
    pub(super) sub: String,
    /// The issuer of the token.
    pub(super) iss: String,
    /// Expiration time as a Unix timestamp.
    pub(super) exp: usize,
    /// Issued at time as a Unix timestamp.
    pub(super) iat: usize,
}

/// Extended JWT claims struct with support for custom extra fields.
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct ExtraJwtClaims {
    /// The subject (user identifier) of the token.
    pub(super) sub: String,
    /// The issuer of the token.
    pub(super) iss: String,
    /// Expiration time as a Unix timestamp.
    pub(super) exp: usize,
    /// Issued at time as a Unix timestamp.
    pub(super) iat: usize,
    /// Additional custom claims.
    #[serde(flatten)]
    pub(super) extra: HashMap<String, Value>,
}