qm-keycloak 0.0.2

Keycloak helper functions
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use std::collections::HashSet;
use std::sync::Arc;

use jsonwebtoken::{decode, Algorithm, DecodingKey, Validation};
use serde::{Deserialize, Serialize};

#[derive(Debug, Serialize, Deserialize)]
pub struct ResourceAccess {
    pub account: RealmAccess,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct RealmAccess {
    pub roles: Vec<Arc<str>>,
}

#[derive(Serialize, Deserialize, Default)]
pub struct PartialClaims {
    pub iss: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct Claims {
    pub exp: i64,
    pub iat: i64,
    pub auth_time: Option<i64>,
    pub jti: String,
    pub iss: String,
    pub aud: serde_json::Value,
    pub sub: Arc<str>,
    pub typ: String,
    pub azp: String,
    pub session_state: String,
    pub acr: String,
    #[serde(rename = "allowed-origins")]
    pub allowed_origins: Vec<Arc<str>>,
    pub realm_access: RealmAccess,
    pub resource_access: ResourceAccess,
    #[serde(default)]
    pub scope: String,
    #[serde(default)]
    pub sid: String,
    pub email_verified: bool,
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub preferred_username: String,
    pub given_name: String,
    #[serde(default)]
    pub family_name: String,
    #[serde(default)]
    pub email: String,
    #[serde(skip)]
    pub is_api_test: bool,
}

impl Default for Claims {
    fn default() -> Self {
        Self {
            exp: 0,
            iat: 0,
            auth_time: None,
            jti: "".to_string(),
            iss: "".to_string(),
            is_api_test: true,
            sub: Arc::from("user-id"),
            typ: "".to_string(),
            azp: "".to_string(),
            session_state: "".to_string(),
            acr: "".to_string(),
            allowed_origins: vec![],
            realm_access: RealmAccess { roles: vec![] },
            resource_access: ResourceAccess {
                account: RealmAccess { roles: vec![] },
            },
            scope: "".to_string(),
            sid: "".to_string(),
            email_verified: false,
            name: "".to_string(),
            preferred_username: "".to_string(),
            given_name: "".to_string(),
            family_name: "".to_string(),
            aud: Default::default(),
            email: "".to_string(),
        }
    }
}

#[derive(Debug, Serialize, Deserialize)]
pub struct LogoutClaims {
    pub iat: i64,
    pub jti: String,
    pub iss: String,
    pub aud: serde_json::Value,
    pub sub: String,
    pub typ: String,
    pub sid: String,
}

#[derive(Clone)]
pub struct Jwt {
    pub kid: String,
    validation: Validation,
    logout_validation: Validation,
    decoding_key: DecodingKey,
}

impl Jwt {
    pub fn new(alg: Algorithm, kid: String, public_key: &str) -> anyhow::Result<Self> {
        let mut validation = Validation::new(alg);
        validation.set_audience(&["spa", "account"]);
        // needed workaround to validate logout tokens (they contain no exp field)
        let mut logout_validation = Validation::new(alg);
        logout_validation.validate_exp = false;
        logout_validation.required_spec_claims = HashSet::new();
        logout_validation
            .required_spec_claims
            .insert("sub".to_string());
        logout_validation
            .required_spec_claims
            .insert("iss".to_string());
        logout_validation
            .required_spec_claims
            .insert("aud".to_string());
        Ok(Self {
            kid,
            validation,
            logout_validation,
            decoding_key: DecodingKey::from_rsa_pem(
                format!("-----BEGIN PUBLIC KEY-----\n{public_key}\n-----END PUBLIC KEY-----")
                    .as_bytes(),
            )?,
        })
    }

    pub fn decode(&self, token: &str) -> anyhow::Result<Claims> {
        let result = decode::<Claims>(token, &self.decoding_key, &self.validation)?;
        Ok(result.claims)
    }

    pub fn decode_logout_token(&self, token: &str) -> anyhow::Result<LogoutClaims> {
        let result = decode::<LogoutClaims>(token, &self.decoding_key, &self.logout_validation)?;
        Ok(result.claims)
    }
}