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
use std::{collections::HashSet, sync::Arc};
use bon::Builder;
use serde::Serialize;
use crate::{
core::{
EndpointUrl, Error, ErrorKind,
client_auth::ClientAuthentication,
crypto::verifier::{JwsVerifier, JwsVerifierFactory, JwsVerifierPlatform},
dpop::{AuthorizationServerDPoP, NoDPoP},
http::HttpClient,
},
grant::{
authorization_code::jar::{Jar, NoJar},
core::OAuth2ExchangeGrant,
refresh,
},
};
/// The authorization code grant (RFC 6749 §4.1).
///
/// See the [module documentation][crate::grant::authorization_code] for a usage guide.
#[allow(clippy::struct_excessive_bools)] // independent protocol switches, not a state machine
#[derive(Clone)]
pub struct AuthorizationCodeGrant {
/// The client ID.
pub(super) client_id: String,
/// The HTTP client used for token and PAR requests.
pub(super) http_client: Arc<dyn HttpClient>,
/// The client authentication method.
pub(super) client_auth: Arc<dyn ClientAuthentication>,
/// The `DPoP` signer.
pub(super) dpop: Arc<dyn AuthorizationServerDPoP>,
/// The issuer for tokens created by the authorization server.
pub(super) issuer: Option<String>,
/// The URL of the token endpoint, as published in authorization server
/// metadata (before RFC 8705 §5 mTLS-alias resolution).
pub(super) token_endpoint: EndpointUrl,
/// The token endpoint used for token requests: the RFC 8705 §5 mTLS alias
/// when the HTTP client uses mTLS, the primary token endpoint otherwise.
pub(super) effective_token_endpoint: EndpointUrl,
/// Supported endpoint auth methods; used to auto-select basic or
/// form auth for client secrets.
pub(super) token_endpoint_auth_methods_supported: Option<Vec<String>>,
/// The JWS verifier to use when verifying JWS signatures.
///
/// This field is populated from the values of `jwks_uri`, `jws_verifier_platform`,
/// and `jws_verifier_factory` at build time.
pub(super) jws_verifier: Option<Arc<dyn JwsVerifier>>,
pub(super) jar: Arc<dyn Jar>,
/// The authorization endpoint (RFC 6749 §3.1).
pub(super) authorization_endpoint: EndpointUrl,
/// The pushed authorization request endpoint (RFC 9126 §5), resolved at
/// build time to the RFC 8705 §5 mTLS alias when the HTTP client uses mTLS.
pub(super) pushed_authorization_request_endpoint: Option<EndpointUrl>,
/// Set to true if the provider requires PAR requests only (RFC 9126 §5).
///
/// The value is usually set using authorization server metadata (RFC 8414).
/// The builder rejects setting this without a
/// `pushed_authorization_request_endpoint`, so when it is `true` an
/// endpoint is guaranteed to be present.
pub(super) require_pushed_authorization_requests: bool,
/// Set to true if the provider supports the `iss` parameter in the authorization code callback (RFC 9207).
pub(super) authorization_response_iss_parameter_supported: bool,
/// Contains the supported code challenge methods (RFC 8414 §2).
///
/// `S256` is used unless this advertises `plain` without `S256`. An empty
/// list (metadata that omits the optional field) still gets `S256`: PKCE
/// is required by current best practice (RFC 9700 §2.1.1) and servers
/// ignore unrecognized request parameters (RFC 6749 §3.1).
pub(super) code_challenge_methods_supported: Vec<String>,
// -- User-supplied grant-specific fields --
/// A redirect URL registered with the authorization server.
pub(super) redirect_uri: String,
/// Whether PKCE (RFC 7636) is disabled; see the `new` builder.
pub(super) disable_pkce: bool,
/// Whether to send the OIDC `nonce` parameter; `None` follows the request
/// scope (sent only when `openid` is requested). See the `new` builder.
pub(super) send_oidc_nonce: Option<bool>,
/// Set to true to prefer PAR when available.
pub(super) prefer_pushed_authorization_requests: bool,
/// If set, restricts accepted ID token signature algorithms; see the `new`
/// builder.
pub(super) allowed_id_token_signed_response_algs: Option<HashSet<String>>,
}
impl AuthorizationCodeGrant {
/// The OAuth 2.0 client identifier this grant authenticates as.
///
/// Exposed so callers can supply the `client_id` parameter for flows that
/// need it outside the grant itself — notably OIDC RP-Initiated Logout,
/// where it lets the OP identify the RP (and thus honor
/// `post_logout_redirect_uri`) when no `id_token_hint` is available.
#[must_use]
pub fn client_id(&self) -> &str {
&self.client_id
}
}
#[huskarl_macros::from_metadata(
metadata = crate::core::server_metadata::AuthorizationServerMetadata
)]
#[bon::bon]
impl AuthorizationCodeGrant {
/// Creates a new [`AuthorizationCodeGrant`] instance.
///
/// Callers use [`Self::builder()`], or [`Self::builder_from_metadata()`]
/// to pre-populate the endpoint fields from server metadata.
///
/// # Errors
///
/// Returns an error if a `jws_verifier_factory` is supplied without a
/// `jws_verifier_platform`, if building the JWS verifier from `jwks_uri`
/// fails, or if `require_pushed_authorization_requests` is set without a
/// `pushed_authorization_request_endpoint` (honoring the requirement would
/// be impossible, and ignoring it would silently downgrade PAR).
#[builder(on(String, into))]
pub async fn new(
/// The client ID.
client_id: String,
/// The HTTP client used for token and PAR requests.
#[builder(with = |client: impl HttpClient + 'static| Arc::new(client) as Arc<dyn HttpClient>)]
http_client: Arc<dyn HttpClient>,
/// The client authentication method.
#[builder(with = |auth: impl ClientAuthentication + 'static| Arc::new(auth) as Arc<dyn ClientAuthentication>)]
client_auth: Arc<dyn ClientAuthentication>,
/// The `DPoP` signer. Defaults to [`NoDPoP`] (no token sender-constraining).
#[builder(
with = |dpop: impl AuthorizationServerDPoP + 'static| Arc::new(dpop) as Arc<dyn AuthorizationServerDPoP>,
default = Arc::new(NoDPoP),
)]
dpop: Arc<dyn AuthorizationServerDPoP>,
/// The issuer for tokens created by the authorization server.
#[from_metadata(path = "issuer")]
issuer: Option<String>,
/// The URL of the token endpoint.
#[from_metadata(path = "token_endpoint")]
token_endpoint: EndpointUrl,
/// The mTLS alias for the token endpoint (RFC 8705 §5).
#[from_metadata(path = "mtls_endpoint_aliases?.token_endpoint?")]
mtls_token_endpoint: Option<EndpointUrl>,
/// Supported endpoint auth methods; used to auto-select basic or
/// form auth for client secrets.
#[from_metadata(path = "token_endpoint_auth_methods_supported")]
token_endpoint_auth_methods_supported: Option<Vec<String>>,
/// The [`Jar`] implementation used to JWT-secure the authorization
/// request (RFC 9101). Defaults to [`NoJar`] — no request object; see the
/// trait for what JAR provides and how to supply one.
#[builder(
with = |jar: impl Jar + 'static| Arc::new(jar) as Arc<dyn Jar>,
default = Arc::new(NoJar),
)]
jar: Arc<dyn Jar>,
#[from_metadata(path = "jwks_uri?")] jwks_uri: Option<EndpointUrl>,
#[from_metadata(path = "authorization_endpoint?")] authorization_endpoint: EndpointUrl,
#[from_metadata(path = "pushed_authorization_request_endpoint?")]
pushed_authorization_request_endpoint: Option<EndpointUrl>,
#[from_metadata(path = "mtls_endpoint_aliases?.pushed_authorization_request_endpoint?")]
mtls_pushed_authorization_request_endpoint: Option<EndpointUrl>,
#[from_metadata(path = "require_pushed_authorization_requests")]
#[builder(default)]
require_pushed_authorization_requests: bool,
#[from_metadata(path = "authorization_response_iss_parameter_supported")]
#[builder(default)]
authorization_response_iss_parameter_supported: bool,
#[from_metadata(path = "code_challenge_methods_supported")]
#[builder(default = vec!["S256".to_string()])]
code_challenge_methods_supported: Vec<String>,
redirect_uri: String,
/// Set to true to disable PKCE (RFC 7636) entirely.
///
/// PKCE is otherwise always applied, as required by current best practice
/// (RFC 9700 §2.1.1). Only disable it for an authorization server that
/// rejects requests containing PKCE parameters.
#[builder(default)]
disable_pkce: bool,
/// Controls whether the OIDC `nonce` parameter (OIDC Core 1.0 §3.1.2.1)
/// is sent in the authorization request.
///
/// `nonce` is an `OpenID` Connect parameter — it binds an ID token to the
/// request. By default (`None`) it is sent only when the request scope
/// contains `openid`, so OIDC flows get it and pure-OAuth servers (such
/// as those that strictly reject unknown parameters) do not. Set
/// `Some(true)`/`Some(false)` to force it on or off regardless of scope.
#[builder(required, default)]
send_oidc_nonce: Option<bool>,
#[builder(default = true)] prefer_pushed_authorization_requests: bool,
/// Restricts accepted ID token signature algorithms to this set: the
/// [`IdTokenValidator`](crate::token::id_token::IdTokenValidator) rejects
/// any ID token whose `alg` header is not listed. Use a single-element
/// set to pin one algorithm, or several to enforce a policy (e.g. the
/// FAPI 2.0 set: PS256, ES256, `EdDSA`).
///
/// [`builder_from_metadata`](Self::builder_from_metadata) seeds it from
/// the server's `id_token_signing_alg_values_supported` (OIDC Discovery
/// 1.0 §3), minus the insecure `none` (which is rejected unconditionally
/// regardless). The plain [`builder`](Self::builder) leaves it unset,
/// accepting any algorithm the verifier supports.
#[from_metadata(
with = |m: &crate::core::server_metadata::AuthorizationServerMetadata| m
.id_token_signing_alg_values_supported
.as_ref()
.map(|algs| {
algs.iter()
.filter(|a| *a != "none")
.cloned()
.collect::<HashSet<String>>()
})
.filter(|algs| !algs.is_empty()),
maybe
)]
allowed_id_token_signed_response_algs: Option<HashSet<String>>,
#[cfg(not(feature = "default-jws-verifier-platform"))] jws_verifier_platform: Option<
Arc<dyn JwsVerifierPlatform>,
>,
#[cfg(feature = "default-jws-verifier-platform")]
#[cfg_attr(feature = "default-jws-verifier-platform", builder(default = crate::DefaultJwsVerifierPlatform::default().into()))]
jws_verifier_platform: Arc<dyn JwsVerifierPlatform>,
jws_verifier_factory: Option<Arc<dyn JwsVerifierFactory>>,
) -> Result<Self, Error> {
#[cfg(feature = "default-jws-verifier-platform")]
let jws_verifier_platform = Some(jws_verifier_platform);
let jws_verifier = match (jws_verifier_platform.clone(), jws_verifier_factory.clone()) {
(Some(platform), Some(factory)) => {
Some(factory.build(jwks_uri.as_ref(), platform).await?)
}
(None, Some(_)) => {
return Err(Error::new(
ErrorKind::Config,
super::error::MissingJwsVerifierPlatformSnafu.build(),
));
}
(Some(_) | None, None) => None,
};
let effective_token_endpoint = crate::grant::core::resolve_mtls_alias(
http_client.as_ref(),
&token_endpoint,
mtls_token_endpoint.as_ref(),
);
let pushed_authorization_request_endpoint =
pushed_authorization_request_endpoint.map(|par| {
crate::grant::core::resolve_mtls_alias(
http_client.as_ref(),
&par,
mtls_pushed_authorization_request_endpoint.as_ref(),
)
});
// A grant that must use PAR (client policy, or AS metadata setting
// `require_pushed_authorization_requests`) but has no endpoint to push
// to could only ever proceed by silently downgrading to a plain
// authorization request — fail construction instead.
if require_pushed_authorization_requests && pushed_authorization_request_endpoint.is_none()
{
return Err(Error::new(
ErrorKind::Config,
super::error::RequiredParEndpointMissingSnafu.build(),
));
}
Ok(AuthorizationCodeGrant {
client_id,
http_client,
client_auth,
dpop,
issuer,
token_endpoint,
effective_token_endpoint,
token_endpoint_auth_methods_supported,
jws_verifier,
jar,
authorization_endpoint,
pushed_authorization_request_endpoint,
require_pushed_authorization_requests,
authorization_response_iss_parameter_supported,
code_challenge_methods_supported,
redirect_uri,
disable_pkce,
send_oidc_nonce,
prefer_pushed_authorization_requests,
allowed_id_token_signed_response_algs,
})
}
}
/// Parameters passed to each token request.
#[derive(Debug, Clone, Builder)]
#[builder(on(String, into))]
pub struct AuthorizationCodeGrantParameters {
/// The bound `DPoP` JWT thumbprint, if any has already been computed.
pub(super) dpop_jkt: Option<String>,
/// The temporary authorization code received from the redirect callback.
pub(super) code: String,
/// The PKCE verifier.
pub(super) pkce_verifier: Option<String>,
/// The target resource(s) for the access token.
pub(super) resource: Option<Vec<String>>,
}
/// Authorization code grant body.
#[derive(Debug, Serialize)]
pub struct AuthorizationCodeGrantForm<'a> {
grant_type: &'static str,
code: String,
redirect_uri: &'a str,
code_verifier: Option<String>,
resource: Option<Vec<String>>,
}
impl OAuth2ExchangeGrant for AuthorizationCodeGrant {
type Parameters = AuthorizationCodeGrantParameters;
type Form<'a> = AuthorizationCodeGrantForm<'a>;
fn client_id(&self) -> Option<&str> {
Some(&self.client_id)
}
fn issuer(&self) -> Option<&str> {
self.issuer.as_deref()
}
fn client_auth(&self) -> Option<&dyn ClientAuthentication> {
Some(self.client_auth.as_ref())
}
fn token_endpoint(&self) -> &EndpointUrl {
&self.token_endpoint
}
fn effective_token_endpoint(&self) -> &EndpointUrl {
&self.effective_token_endpoint
}
fn dpop(&self) -> &dyn AuthorizationServerDPoP {
self.dpop.as_ref()
}
fn http_client(&self) -> &dyn HttpClient {
self.http_client.as_ref()
}
fn allowed_auth_methods(&self) -> Option<&[String]> {
self.token_endpoint_auth_methods_supported.as_deref()
}
fn bound_dpop_jkt(params: &Self::Parameters) -> Option<&str> {
params.dpop_jkt.as_deref()
}
fn to_refresh_grant(&self) -> refresh::RefreshGrant {
refresh::RefreshGrant::builder()
.client_id(self.client_id.clone())
.maybe_issuer(self.issuer.clone())
.http_client(self.http_client.clone())
.client_auth(self.client_auth.clone())
.dpop(self.dpop.clone())
.token_endpoint(self.effective_token_endpoint.clone())
.maybe_token_endpoint_auth_methods_supported(
self.token_endpoint_auth_methods_supported.clone(),
)
.build()
}
fn build_form(&self, params: Self::Parameters) -> Self::Form<'_> {
Self::Form {
grant_type: "authorization_code",
code: params.code,
redirect_uri: &self.redirect_uri,
code_verifier: params.pkce_verifier,
resource: params.resource,
}
}
}