openid-client 1.0.0-alpha.7

OpenID client 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
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
use url::Url;

use crate::{
    config::{client_auth::ClientAuth, configuration_options::ConfigurationOptions},
    errors::{OidcReturn, OpenIdError},
    jwk::Jwk,
    types::{
        AuthMethods, AuthenticatedEndpoints, ClientMetadata, IssuerMetadata, OpenIdResponseType,
    },
};

/// Represents the complete OpenID Connect client configuration.
///
/// This struct bundles together all the key metadata and client authentication
/// details required to perform OpenID Connect flows.
#[derive(Debug, Clone)]
pub struct OpenIdClientConfiguration {
    /// Metadata describing the OpenID Connect issuer.
    pub issuer: IssuerMetadata,
    /// Issuer Jwks
    pub issuer_jwks: Vec<Jwk>,
    /// Metadata describing the client application.
    pub client: ClientMetadata,
    /// Client authentication method used to authenticate the client.
    pub auth: ClientAuth,
    /// Extra options to customize client behavior and configuration.
    pub options: ConfigurationOptions,
    /// Client's private keys used for request signing etc.
    pub client_jwks: Vec<Jwk>,
    /// Jwks used for json web encryption
    pub jwe_keys: Vec<Jwk>,
    /// Specifies the response type that is used for the authorization callback.
    /// See [OpenIdResponseType].
    pub response_type: OpenIdResponseType,
    /// Specifies if the client is a FAPI Client
    pub fapi: bool,
}

impl OpenIdClientConfiguration {
    /// Creates new [OpenIdClientConfiguration]. All the other options are set to default.
    pub fn new(
        issuer: IssuerMetadata,
        issuer_jwks: Vec<Jwk>,
        client: ClientMetadata,
        auth: ClientAuth,
    ) -> Self {
        Self {
            issuer,
            issuer_jwks,
            client,
            auth,
            options: ConfigurationOptions::default(),
            client_jwks: vec![],
            jwe_keys: vec![],
            response_type: OpenIdResponseType::Code,
            fapi: false,
        }
    }

    /// Creates new [OpenIdClientConfiguration] with all the provided options.
    #[allow(clippy::too_many_arguments)]
    pub fn new_all(
        issuer: IssuerMetadata,
        issuer_jwks: Vec<Jwk>,
        client: ClientMetadata,
        auth: ClientAuth,
        options: ConfigurationOptions,
        client_jwks: Vec<Jwk>,
        jwe_keys: Vec<Jwk>,
        response_type: OpenIdResponseType,
        fapi: bool,
    ) -> Self {
        Self {
            issuer,
            issuer_jwks,
            client,
            auth,
            options,
            client_jwks,
            jwe_keys,
            response_type,
            fapi,
        }
    }

    /// Returns the parsed URL for the issuer's authorization endpoint.
    pub fn authorization_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .authorization_endpoint
            .as_ref()
            .map(|authorization_endpoint| Url::parse(authorization_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "authorization_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the issuer's end session or logout endpoint.
    pub fn end_session_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .end_session_endpoint
            .as_ref()
            .map(|end_session_endpoint| Url::parse(end_session_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "end_session_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the issuer's token endpoint.
    pub fn token_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .token_endpoint
            .as_ref()
            .map(|token_endpoint| Url::parse(token_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "token_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the MTLS-specific alias URL for the token endpoint.
    pub fn mtls_token_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .mtls_endpoint_aliases
            .as_ref()
            .and_then(|aliases| {
                aliases
                    .token_endpoint
                    .as_ref()
                    .map(|token_endpoint| Url::parse(token_endpoint))
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "mtls_token_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the Pushed Authorization Request (PAR) endpoint.
    pub fn par_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .pushed_authorization_request_endpoint
            .as_ref()
            .map(|par_endpoint| Url::parse(par_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "pushed_authorization_request_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the MTLS-specific alias URL for the PAR endpoint.
    pub fn mtls_par_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .mtls_endpoint_aliases
            .as_ref()
            .and_then(|aliases| {
                aliases
                    .pushed_authorization_request_endpoint
                    .as_ref()
                    .map(|par_endpoint| Url::parse(par_endpoint))
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "mtls_pushed_authorization_request_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the device authorization endpoint.
    pub fn device_authorization_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .device_authorization_endpoint
            .as_ref()
            .map(|device_authorization_endpoint| Url::parse(device_authorization_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "device_authorization_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the MTLS-specific alias URL for the device authorization endpoint.
    pub fn mtls_device_authorization_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .mtls_endpoint_aliases
            .as_ref()
            .and_then(|aliases| {
                aliases
                    .device_authorization_endpoint
                    .as_ref()
                    .map(|device_authorization_endpoint| Url::parse(device_authorization_endpoint))
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "mtls_device_authorization_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the backchannel (CIBA) authentication endpoint.
    pub fn backchannel_authentication_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .backchannel_authentication_endpoint
            .as_ref()
            .map(|backchannel_authentication_endpoint| {
                Url::parse(backchannel_authentication_endpoint)
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "backchannel_authentication_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the MTLS-specific alias URL for the backchannel authentication endpoint.
    pub fn mtls_backchannel_authentication_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .mtls_endpoint_aliases
            .as_ref()
            .and_then(|aliases| {
                aliases.backchannel_authentication_endpoint.as_ref().map(
                    |backchannel_authentication_endpoint| {
                        Url::parse(backchannel_authentication_endpoint)
                    },
                )
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "mtls_backchannel_authentication_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the issuer's userinfo endpoint.
    pub fn userinfo_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .userinfo_endpoint
            .as_ref()
            .map(|userinfo_endpoint| Url::parse(userinfo_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "userinfo_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the MTLS-specific alias URL for the userinfo endpoint.
    pub fn mtls_userinfo_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .mtls_endpoint_aliases
            .as_ref()
            .and_then(|aliases| {
                aliases
                    .userinfo_endpoint
                    .as_ref()
                    .map(|userinfo_endpoint| Url::parse(userinfo_endpoint))
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "mtls_userinfo_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the token revocation endpoint.
    pub fn revocation_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .revocation_endpoint
            .as_ref()
            .map(|revocation_endpoint| Url::parse(revocation_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "revocation_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the MTLS-specific alias URL for the token revocation endpoint.
    pub fn mtls_revocation_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .mtls_endpoint_aliases
            .as_ref()
            .and_then(|aliases| {
                aliases
                    .revocation_endpoint
                    .as_ref()
                    .map(|revocation_endpoint| Url::parse(revocation_endpoint))
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "mtls_revocation_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the token introspection endpoint.
    pub fn introspection_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .introspection_endpoint
            .as_ref()
            .map(|introspection_endpoint| Url::parse(introspection_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "introspection_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the MTLS-specific alias URL for the token introspection endpoint.
    pub fn mtls_introspection_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .mtls_endpoint_aliases
            .as_ref()
            .and_then(|aliases| {
                aliases
                    .introspection_endpoint
                    .as_ref()
                    .map(|introspection_endpoint| Url::parse(introspection_endpoint))
            }) {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "mtls_introspection_endpoint not found or incorrect format",
            )),
        }
    }

    /// Returns the parsed URL for the dynamic client registration endpoint.
    pub fn registration_endpoint(&self) -> OidcReturn<Url> {
        match self
            .issuer
            .registration_endpoint
            .as_ref()
            .map(|registration_endpoint| Url::parse(registration_endpoint))
        {
            Some(Ok(url)) => Ok(url),
            _ => Err(OpenIdError::new_error(
                "registration_endpoint not found or incorrect format",
            )),
        }
    }

    /// Verifies if the configured client authentication method is supported by the target endpoint.
    pub fn check_authentication_support(
        &self,
        endpoint: &AuthenticatedEndpoints,
    ) -> OidcReturn<()> {
        if self.options.skip_auth_checks {
            return Ok(());
        }

        let configured_authentication_method = self.auth.get_auth_method();

        let supported_authentication_methods = match endpoint {
            AuthenticatedEndpoints::Token
            | AuthenticatedEndpoints::PushedAuthorization
            | AuthenticatedEndpoints::DeviceAuthorization
            | AuthenticatedEndpoints::BackChannelAuthentication => {
                self.issuer.token_endpoint_auth_methods_supported.clone()
            }
            AuthenticatedEndpoints::Introspection => self
                .issuer
                .introspection_endpoint_auth_methods_supported
                .clone(),
            AuthenticatedEndpoints::Revocation => self
                .issuer
                .revocation_endpoint_auth_methods_supported
                .clone()
                .or(Some(vec![AuthMethods::ClientSecretBasic])),
        };

        match supported_authentication_methods {
            Some(supported_authentication_methods) => {
                let result =
                    supported_authentication_methods.contains(&configured_authentication_method);

                if !result {
                    return Err(OpenIdError::new_error(format!(
                        "{:?} does not support {:?}",
                        endpoint, configured_authentication_method
                    )));
                }

                Ok(())
            }
            None => Err(OpenIdError::new_error("Unsupported authentication method")),
        }
    }
}