configuration-model.adoc 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. [[configuration-model]]
  2. = Configuration Model
  3. [[default-configuration]]
  4. == Default configuration
  5. `OAuth2AuthorizationServerConfiguration` is a `@Configuration` that provides the minimal default configuration for an OAuth2 authorization server.
  6. `OAuth2AuthorizationServerConfiguration` uses xref:configuration-model.adoc#customizing-the-configuration[`OAuth2AuthorizationServerConfigurer`] to apply the default configuration and registers a `SecurityFilterChain` `@Bean` composed of all the infrastructure components supporting an OAuth2 authorization server.
  7. The OAuth2 authorization server `SecurityFilterChain` `@Bean` is configured with the following default protocol endpoints:
  8. * xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[OAuth2 Authorization endpoint]
  9. * xref:protocol-endpoints.adoc#oauth2-device-authorization-endpoint[OAuth2 Device Authorization Endpoint]
  10. * xref:protocol-endpoints.adoc#oauth2-device-verification-endpoint[OAuth2 Device Verification Endpoint]
  11. * xref:protocol-endpoints.adoc#oauth2-token-endpoint[OAuth2 Token endpoint]
  12. * xref:protocol-endpoints.adoc#oauth2-token-introspection-endpoint[OAuth2 Token Introspection endpoint]
  13. * xref:protocol-endpoints.adoc#oauth2-token-revocation-endpoint[OAuth2 Token Revocation endpoint]
  14. * xref:protocol-endpoints.adoc#oauth2-authorization-server-metadata-endpoint[OAuth2 Authorization Server Metadata endpoint]
  15. * xref:protocol-endpoints.adoc#jwk-set-endpoint[JWK Set endpoint]
  16. [NOTE]
  17. The JWK Set endpoint is configured *only* if a `JWKSource<SecurityContext>` `@Bean` is registered.
  18. The following example shows how to use `OAuth2AuthorizationServerConfiguration` to apply the minimal default configuration:
  19. [source,java]
  20. ----
  21. @Configuration
  22. @Import(OAuth2AuthorizationServerConfiguration.class)
  23. public class AuthorizationServerConfig {
  24. @Bean
  25. public RegisteredClientRepository registeredClientRepository() {
  26. List<RegisteredClient> registrations = ...
  27. return new InMemoryRegisteredClientRepository(registrations);
  28. }
  29. @Bean
  30. public JWKSource<SecurityContext> jwkSource() {
  31. RSAKey rsaKey = ...
  32. JWKSet jwkSet = new JWKSet(rsaKey);
  33. return (jwkSelector, securityContext) -> jwkSelector.select(jwkSet);
  34. }
  35. }
  36. ----
  37. [IMPORTANT]
  38. The https://datatracker.ietf.org/doc/html/rfc6749#section-4.1[authorization_code grant] requires the resource owner to be authenticated. Therefore, a user authentication mechanism *must* be configured in addition to the default OAuth2 security configuration.
  39. https://openid.net/specs/openid-connect-core-1_0.html[OpenID Connect 1.0] is disabled in the default configuration. The following example shows how to enable OpenID Connect 1.0 by initializing the `OidcConfigurer`:
  40. [source,java]
  41. ----
  42. @Bean
  43. public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http) throws Exception {
  44. OAuth2AuthorizationServerConfigurer authorizationServerConfigurer =
  45. OAuth2AuthorizationServerConfigurer.authorizationServer();
  46. http
  47. .securityMatcher(authorizationServerConfigurer.getEndpointsMatcher())
  48. .with(authorizationServerConfigurer, (authorizationServer) ->
  49. authorizationServer
  50. .oidc(Customizer.withDefaults()) // Initialize `OidcConfigurer`
  51. );
  52. return http.build();
  53. }
  54. ----
  55. In addition to the default protocol endpoints, the OAuth2 authorization server `SecurityFilterChain` `@Bean` is configured with the following OpenID Connect 1.0 protocol endpoints:
  56. * xref:protocol-endpoints.adoc#oidc-provider-configuration-endpoint[OpenID Connect 1.0 Provider Configuration endpoint]
  57. * xref:protocol-endpoints.adoc#oidc-logout-endpoint[OpenID Connect 1.0 Logout endpoint]
  58. * xref:protocol-endpoints.adoc#oidc-user-info-endpoint[OpenID Connect 1.0 UserInfo endpoint]
  59. [NOTE]
  60. The xref:protocol-endpoints.adoc#oidc-client-registration-endpoint[OpenID Connect 1.0 Client Registration endpoint] is disabled by default because many deployments do not require dynamic client registration.
  61. [TIP]
  62. `OAuth2AuthorizationServerConfiguration.jwtDecoder(JWKSource<SecurityContext>)` is a convenience (`static`) utility method that can be used to register a `JwtDecoder` `@Bean`, which is *REQUIRED* for the xref:protocol-endpoints.adoc#oidc-user-info-endpoint[OpenID Connect 1.0 UserInfo endpoint] and the xref:protocol-endpoints.adoc#oidc-client-registration-endpoint[OpenID Connect 1.0 Client Registration endpoint].
  63. The following example shows how to register a `JwtDecoder` `@Bean`:
  64. [source,java]
  65. ----
  66. @Bean
  67. public JwtDecoder jwtDecoder(JWKSource<SecurityContext> jwkSource) {
  68. return OAuth2AuthorizationServerConfiguration.jwtDecoder(jwkSource);
  69. }
  70. ----
  71. The main intent of `OAuth2AuthorizationServerConfiguration` is to provide a convenient method to apply the minimal default configuration for an OAuth2 authorization server. However, in most cases, customizing the configuration will be required.
  72. [[customizing-the-configuration]]
  73. == Customizing the configuration
  74. `OAuth2AuthorizationServerConfigurer` provides the ability to fully customize the security configuration for an OAuth2 authorization server.
  75. It lets you specify the core components to use - for example, xref:core-model-components.adoc#registered-client-repository[`RegisteredClientRepository`], xref:core-model-components.adoc#oauth2-authorization-service[`OAuth2AuthorizationService`], xref:core-model-components.adoc#oauth2-token-generator[`OAuth2TokenGenerator`], and others.
  76. Furthermore, it lets you customize the request processing logic for the protocol endpoints – for example, xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[authorization endpoint], xref:protocol-endpoints.adoc#oauth2-device-authorization-endpoint[device authorization endpoint], xref:protocol-endpoints.adoc#oauth2-device-verification-endpoint[device verification endpoint], xref:protocol-endpoints.adoc#oauth2-token-endpoint[token endpoint], xref:protocol-endpoints.adoc#oauth2-token-introspection-endpoint[token introspection endpoint], and others.
  77. `OAuth2AuthorizationServerConfigurer` provides the following configuration options:
  78. [source,java]
  79. ----
  80. @Bean
  81. public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http) throws Exception {
  82. OAuth2AuthorizationServerConfigurer authorizationServerConfigurer =
  83. OAuth2AuthorizationServerConfigurer.authorizationServer();
  84. http
  85. .securityMatcher(authorizationServerConfigurer.getEndpointsMatcher())
  86. .with(authorizationServerConfigurer, (authorizationServer) ->
  87. authorizationServer
  88. .registeredClientRepository(registeredClientRepository) <1>
  89. .authorizationService(authorizationService) <2>
  90. .authorizationConsentService(authorizationConsentService) <3>
  91. .authorizationServerSettings(authorizationServerSettings) <4>
  92. .tokenGenerator(tokenGenerator) <5>
  93. .clientAuthentication(clientAuthentication -> { }) <6>
  94. .authorizationEndpoint(authorizationEndpoint -> { }) <7>
  95. .pushedAuthorizationRequestEndpoint(pushedAuthorizationRequestEndpoint -> { }) <8>
  96. .deviceAuthorizationEndpoint(deviceAuthorizationEndpoint -> { }) <9>
  97. .deviceVerificationEndpoint(deviceVerificationEndpoint -> { }) <10>
  98. .tokenEndpoint(tokenEndpoint -> { }) <11>
  99. .tokenIntrospectionEndpoint(tokenIntrospectionEndpoint -> { }) <12>
  100. .tokenRevocationEndpoint(tokenRevocationEndpoint -> { }) <13>
  101. .authorizationServerMetadataEndpoint(authorizationServerMetadataEndpoint -> { }) <14>
  102. .oidc(oidc -> oidc
  103. .providerConfigurationEndpoint(providerConfigurationEndpoint -> { }) <15>
  104. .logoutEndpoint(logoutEndpoint -> { }) <16>
  105. .userInfoEndpoint(userInfoEndpoint -> { }) <17>
  106. .clientRegistrationEndpoint(clientRegistrationEndpoint -> { }) <18>
  107. )
  108. );
  109. return http.build();
  110. }
  111. ----
  112. <1> `registeredClientRepository()`: The xref:core-model-components.adoc#registered-client-repository[`RegisteredClientRepository`] (*REQUIRED*) for managing new and existing clients.
  113. <2> `authorizationService()`: The xref:core-model-components.adoc#oauth2-authorization-service[`OAuth2AuthorizationService`] for managing new and existing authorizations.
  114. <3> `authorizationConsentService()`: The xref:core-model-components.adoc#oauth2-authorization-consent-service[`OAuth2AuthorizationConsentService`] for managing new and existing authorization consents.
  115. <4> `authorizationServerSettings()`: The xref:configuration-model.adoc#configuring-authorization-server-settings[`AuthorizationServerSettings`] (*REQUIRED*) for customizing configuration settings for the OAuth2 authorization server.
  116. <5> `tokenGenerator()`: The xref:core-model-components.adoc#oauth2-token-generator[`OAuth2TokenGenerator`] for generating tokens supported by the OAuth2 authorization server.
  117. <6> `clientAuthentication()`: The configurer for xref:configuration-model.adoc#configuring-client-authentication[OAuth2 Client Authentication].
  118. <7> `authorizationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-authorization-endpoint[OAuth2 Authorization endpoint].
  119. <8> `pushedAuthorizationRequestEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-pushed-authorization-request-endpoint[OAuth2 Pushed Authorization Request endpoint].
  120. <9> `deviceAuthorizationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-device-authorization-endpoint[OAuth2 Device Authorization endpoint].
  121. <10> `deviceVerificationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-device-verification-endpoint[OAuth2 Device Verification endpoint].
  122. <11> `tokenEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-token-endpoint[OAuth2 Token endpoint].
  123. <12> `tokenIntrospectionEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-token-introspection-endpoint[OAuth2 Token Introspection endpoint].
  124. <13> `tokenRevocationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-token-revocation-endpoint[OAuth2 Token Revocation endpoint].
  125. <14> `authorizationServerMetadataEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oauth2-authorization-server-metadata-endpoint[OAuth2 Authorization Server Metadata endpoint].
  126. <15> `providerConfigurationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oidc-provider-configuration-endpoint[OpenID Connect 1.0 Provider Configuration endpoint].
  127. <16> `logoutEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oidc-logout-endpoint[OpenID Connect 1.0 Logout endpoint].
  128. <17> `userInfoEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oidc-user-info-endpoint[OpenID Connect 1.0 UserInfo endpoint].
  129. <18> `clientRegistrationEndpoint()`: The configurer for the xref:protocol-endpoints.adoc#oidc-client-registration-endpoint[OpenID Connect 1.0 Client Registration endpoint].
  130. [[configuring-authorization-server-settings]]
  131. == Configuring Authorization Server Settings
  132. `AuthorizationServerSettings` contains the configuration settings for the OAuth2 authorization server.
  133. It specifies the `URI` for the protocol endpoints as well as the https://datatracker.ietf.org/doc/html/rfc8414#section-2[issuer identifier].
  134. The default `URI` for the protocol endpoints are as follows:
  135. [source,java]
  136. ----
  137. public final class AuthorizationServerSettings extends AbstractSettings {
  138. ...
  139. public static Builder builder() {
  140. return new Builder()
  141. .authorizationEndpoint("/oauth2/authorize")
  142. .pushedAuthorizationRequestEndpoint("/oauth2/par")
  143. .deviceAuthorizationEndpoint("/oauth2/device_authorization")
  144. .deviceVerificationEndpoint("/oauth2/device_verification")
  145. .tokenEndpoint("/oauth2/token")
  146. .tokenIntrospectionEndpoint("/oauth2/introspect")
  147. .tokenRevocationEndpoint("/oauth2/revoke")
  148. .jwkSetEndpoint("/oauth2/jwks")
  149. .oidcLogoutEndpoint("/connect/logout")
  150. .oidcUserInfoEndpoint("/userinfo")
  151. .oidcClientRegistrationEndpoint("/connect/register");
  152. }
  153. ...
  154. }
  155. ----
  156. [NOTE]
  157. `AuthorizationServerSettings` is a *REQUIRED* component.
  158. [TIP]
  159. xref:configuration-model.adoc#default-configuration[`@Import(OAuth2AuthorizationServerConfiguration.class)`] automatically registers an `AuthorizationServerSettings` `@Bean`, if not already provided.
  160. The following example shows how to customize the configuration settings and register an `AuthorizationServerSettings` `@Bean`:
  161. [source,java]
  162. ----
  163. @Bean
  164. public AuthorizationServerSettings authorizationServerSettings() {
  165. return AuthorizationServerSettings.builder()
  166. .issuer("https://example.com")
  167. .authorizationEndpoint("/oauth2/v1/authorize")
  168. .pushedAuthorizationRequestEndpoint("/oauth2/v1/par")
  169. .deviceAuthorizationEndpoint("/oauth2/v1/device_authorization")
  170. .deviceVerificationEndpoint("/oauth2/v1/device_verification")
  171. .tokenEndpoint("/oauth2/v1/token")
  172. .tokenIntrospectionEndpoint("/oauth2/v1/introspect")
  173. .tokenRevocationEndpoint("/oauth2/v1/revoke")
  174. .jwkSetEndpoint("/oauth2/v1/jwks")
  175. .oidcLogoutEndpoint("/connect/v1/logout")
  176. .oidcUserInfoEndpoint("/connect/v1/userinfo")
  177. .oidcClientRegistrationEndpoint("/connect/v1/register")
  178. .build();
  179. }
  180. ----
  181. The `AuthorizationServerContext` is a context object that holds information of the Authorization Server runtime environment.
  182. It provides access to the `AuthorizationServerSettings` and the "`current`" issuer identifier.
  183. [NOTE]
  184. If the issuer identifier is not configured in `AuthorizationServerSettings.builder().issuer(String)`, it is resolved from the current request.
  185. [NOTE]
  186. The `AuthorizationServerContext` is accessible through the `AuthorizationServerContextHolder`, which associates it with the current request thread by using a `ThreadLocal`.
  187. [[configuring-client-authentication]]
  188. == Configuring Client Authentication
  189. `OAuth2ClientAuthenticationConfigurer` provides the ability to customize https://datatracker.ietf.org/doc/html/rfc6749#section-2.3[OAuth2 client authentication].
  190. It defines extension points that let you customize the pre-processing, main processing, and post-processing logic for client authentication requests.
  191. `OAuth2ClientAuthenticationConfigurer` provides the following configuration options:
  192. [source,java]
  193. ----
  194. @Bean
  195. public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http) throws Exception {
  196. OAuth2AuthorizationServerConfigurer authorizationServerConfigurer =
  197. OAuth2AuthorizationServerConfigurer.authorizationServer();
  198. http
  199. .securityMatcher(authorizationServerConfigurer.getEndpointsMatcher())
  200. .with(authorizationServerConfigurer, (authorizationServer) ->
  201. authorizationServer
  202. .clientAuthentication(clientAuthentication ->
  203. clientAuthentication
  204. .authenticationConverter(authenticationConverter) <1>
  205. .authenticationConverters(authenticationConvertersConsumer) <2>
  206. .authenticationProvider(authenticationProvider) <3>
  207. .authenticationProviders(authenticationProvidersConsumer) <4>
  208. .authenticationSuccessHandler(authenticationSuccessHandler) <5>
  209. .errorResponseHandler(errorResponseHandler) <6>
  210. )
  211. );
  212. return http.build();
  213. }
  214. ----
  215. <1> `authenticationConverter()`: Adds an `AuthenticationConverter` (_pre-processor_) used when attempting to extract client credentials from `HttpServletRequest` to an instance of `OAuth2ClientAuthenticationToken`.
  216. <2> `authenticationConverters()`: Sets the `Consumer` providing access to the `List` of default and (optionally) added ``AuthenticationConverter``'s allowing the ability to add, remove, or customize a specific `AuthenticationConverter`.
  217. <3> `authenticationProvider()`: Adds an `AuthenticationProvider` (_main processor_) used for authenticating the `OAuth2ClientAuthenticationToken`.
  218. <4> `authenticationProviders()`: Sets the `Consumer` providing access to the `List` of default and (optionally) added ``AuthenticationProvider``'s allowing the ability to add, remove, or customize a specific `AuthenticationProvider`.
  219. <5> `authenticationSuccessHandler()`: The `AuthenticationSuccessHandler` (_post-processor_) used for handling a successful client authentication and associating the `OAuth2ClientAuthenticationToken` to the `SecurityContext`.
  220. <6> `errorResponseHandler()`: The `AuthenticationFailureHandler` (_post-processor_) used for handling a failed client authentication and returning the https://datatracker.ietf.org/doc/html/rfc6749#section-5.2[`OAuth2Error` response].
  221. `OAuth2ClientAuthenticationConfigurer` configures the `OAuth2ClientAuthenticationFilter` and registers it with the OAuth2 authorization server `SecurityFilterChain` `@Bean`.
  222. `OAuth2ClientAuthenticationFilter` is the `Filter` that processes client authentication requests.
  223. By default, client authentication is required for the xref:protocol-endpoints.adoc#oauth2-token-endpoint[OAuth2 Token endpoint], the xref:protocol-endpoints.adoc#oauth2-token-introspection-endpoint[OAuth2 Token Introspection endpoint], and the xref:protocol-endpoints.adoc#oauth2-token-revocation-endpoint[OAuth2 Token Revocation endpoint].
  224. The supported client authentication methods are `client_secret_basic`, `client_secret_post`, `private_key_jwt`, `client_secret_jwt`, `tls_client_auth`, `self_signed_tls_client_auth`, and `none` (public clients).
  225. `OAuth2ClientAuthenticationFilter` is configured with the following defaults:
  226. * `*AuthenticationConverter*` -- A `DelegatingAuthenticationConverter` composed of `JwtClientAssertionAuthenticationConverter`, `X509ClientCertificateAuthenticationConverter`, `ClientSecretBasicAuthenticationConverter`, `ClientSecretPostAuthenticationConverter`, and `PublicClientAuthenticationConverter`.
  227. * `*AuthenticationManager*` -- An `AuthenticationManager` composed of `JwtClientAssertionAuthenticationProvider`, `X509ClientCertificateAuthenticationProvider`, `ClientSecretAuthenticationProvider`, and `PublicClientAuthenticationProvider`.
  228. * `*AuthenticationSuccessHandler*` -- An internal implementation that associates the "`authenticated`" `OAuth2ClientAuthenticationToken` (current `Authentication`) to the `SecurityContext`.
  229. * `*AuthenticationFailureHandler*` -- An internal implementation that uses the `OAuth2Error` associated with the `OAuth2AuthenticationException` to return the OAuth2 error response.
  230. [[configuring-client-authentication-customizing-jwt-client-assertion-validation]]
  231. === Customizing Jwt Client Assertion Validation
  232. `JwtClientAssertionDecoderFactory.DEFAULT_JWT_VALIDATOR_FACTORY` is the default factory that provides an `OAuth2TokenValidator<Jwt>` for the specified `RegisteredClient` and is used for validating the `iss`, `sub`, `aud`, `exp` and `nbf` claims of the `Jwt` client assertion.
  233. `JwtClientAssertionDecoderFactory` provides the ability to override the default `Jwt` client assertion validation by supplying a custom factory of type `Function<RegisteredClient, OAuth2TokenValidator<Jwt>>` to `setJwtValidatorFactory()`.
  234. [NOTE]
  235. `JwtClientAssertionDecoderFactory` is the default `JwtDecoderFactory` used by `JwtClientAssertionAuthenticationProvider` that provides a `JwtDecoder` for the specified `RegisteredClient` and is used for authenticating a `Jwt` Bearer Token during OAuth2 client authentication.
  236. A common use case for customizing `JwtClientAssertionDecoderFactory` is to validate additional claims in the `Jwt` client assertion.
  237. The following example shows how to configure `JwtClientAssertionAuthenticationProvider` with a customized `JwtClientAssertionDecoderFactory` that validates an additional claim in the `Jwt` client assertion:
  238. [source,java]
  239. ----
  240. @Bean
  241. public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http) throws Exception {
  242. OAuth2AuthorizationServerConfigurer authorizationServerConfigurer =
  243. OAuth2AuthorizationServerConfigurer.authorizationServer();
  244. http
  245. .securityMatcher(authorizationServerConfigurer.getEndpointsMatcher())
  246. .with(authorizationServerConfigurer, (authorizationServer) ->
  247. authorizationServer
  248. .clientAuthentication(clientAuthentication ->
  249. clientAuthentication
  250. .authenticationProviders(configureJwtClientAssertionValidator())
  251. )
  252. );
  253. return http.build();
  254. }
  255. private Consumer<List<AuthenticationProvider>> configureJwtClientAssertionValidator() {
  256. return (authenticationProviders) ->
  257. authenticationProviders.forEach((authenticationProvider) -> {
  258. if (authenticationProvider instanceof JwtClientAssertionAuthenticationProvider) {
  259. // Customize JwtClientAssertionDecoderFactory
  260. JwtClientAssertionDecoderFactory jwtDecoderFactory = new JwtClientAssertionDecoderFactory();
  261. Function<RegisteredClient, OAuth2TokenValidator<Jwt>> jwtValidatorFactory = (registeredClient) ->
  262. new DelegatingOAuth2TokenValidator<>(
  263. // Use default validators
  264. JwtClientAssertionDecoderFactory.DEFAULT_JWT_VALIDATOR_FACTORY.apply(registeredClient),
  265. // Add custom validator
  266. new JwtClaimValidator<>("claim", "value"::equals));
  267. jwtDecoderFactory.setJwtValidatorFactory(jwtValidatorFactory);
  268. ((JwtClientAssertionAuthenticationProvider) authenticationProvider)
  269. .setJwtDecoderFactory(jwtDecoderFactory);
  270. }
  271. });
  272. }
  273. ----
  274. [[configuring-client-authentication-customizing-mutual-tls-client-authentication]]
  275. === Customizing Mutual-TLS Client Authentication
  276. `X509ClientCertificateAuthenticationProvider` is used for authenticating the client `X509Certificate` chain received when `ClientAuthenticationMethod.TLS_CLIENT_AUTH` or `ClientAuthenticationMethod.SELF_SIGNED_TLS_CLIENT_AUTH` method is used during OAuth2 client authentication.
  277. It is also composed with a _"Certificate Verifier"_, which is used to verify the contents of the client `X509Certificate` after the TLS handshake has successfully completed.
  278. [[customizing-mutual-tls-client-authentication-pki-mutual-tls-method]]
  279. ==== PKI Mutual-TLS Method
  280. For the PKI Mutual-TLS (`ClientAuthenticationMethod.TLS_CLIENT_AUTH`) method, the default implementation of the certificate verifier verifies the subject distinguished name of the client `X509Certificate` against the setting `RegisteredClient.getClientSettings.getX509CertificateSubjectDN()`.
  281. If you need to verify another attribute of the client `X509Certificate`, for example, a Subject Alternative Name (SAN) entry, the following example shows how to configure `X509ClientCertificateAuthenticationProvider` with a custom implementation of a certificate verifier:
  282. [source,java]
  283. ----
  284. @Bean
  285. public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http) throws Exception {
  286. OAuth2AuthorizationServerConfigurer authorizationServerConfigurer =
  287. OAuth2AuthorizationServerConfigurer.authorizationServer();
  288. http
  289. .securityMatcher(authorizationServerConfigurer.getEndpointsMatcher())
  290. .with(authorizationServerConfigurer, (authorizationServer) ->
  291. authorizationServer
  292. .clientAuthentication(clientAuthentication ->
  293. clientAuthentication
  294. .authenticationProviders(configureX509ClientCertificateVerifier())
  295. )
  296. );
  297. return http.build();
  298. }
  299. private Consumer<List<AuthenticationProvider>> configureX509ClientCertificateVerifier() {
  300. return (authenticationProviders) ->
  301. authenticationProviders.forEach((authenticationProvider) -> {
  302. if (authenticationProvider instanceof X509ClientCertificateAuthenticationProvider) {
  303. Consumer<OAuth2ClientAuthenticationContext> certificateVerifier = (clientAuthenticationContext) -> {
  304. OAuth2ClientAuthenticationToken clientAuthentication = clientAuthenticationContext.getAuthentication();
  305. RegisteredClient registeredClient = clientAuthenticationContext.getRegisteredClient();
  306. X509Certificate[] clientCertificateChain = (X509Certificate[]) clientAuthentication.getCredentials();
  307. X509Certificate clientCertificate = clientCertificateChain[0];
  308. // TODO Verify Subject Alternative Name (SAN) entry
  309. };
  310. ((X509ClientCertificateAuthenticationProvider) authenticationProvider)
  311. .setCertificateVerifier(certificateVerifier);
  312. }
  313. });
  314. }
  315. ----
  316. [[customizing-mutual-tls-client-authentication-self-signed-certificate-mutual-tls-method]]
  317. ==== Self-Signed Certificate Mutual-TLS Method
  318. For the Self-Signed Certificate Mutual-TLS (`ClientAuthenticationMethod.SELF_SIGNED_TLS_CLIENT_AUTH`) method, the default implementation of the certificate verifier will retrieve the client's JSON Web Key Set using the setting `RegisteredClient.getClientSettings.getJwkSetUrl()` and expect to find a match against the client `X509Certificate` received during the TLS handshake.
  319. [NOTE]
  320. The `RegisteredClient.getClientSettings.getJwkSetUrl()` setting is used to retrieve the client's certificates via a JSON Web Key (JWK) Set.
  321. A certificate is represented with the `x5c` parameter of an individual JWK within the set.
  322. [[customizing-mutual-tls-client-authentication-client-certificate-bound-access-tokens]]
  323. ==== Client Certificate-Bound Access Tokens
  324. When Mutual-TLS client authentication is used at the token endpoint, the authorization server is able to bind the issued access token to the client's `X509Certificate`.
  325. The binding is accomplished by computing the SHA-256 thumbprint of the client's `X509Certificate` and associating the thumbprint with the access token.
  326. For example, a JWT access token would include a `x5t#S256` claim, containing the `X509Certificate` thumbprint, within the top-level `cnf` (confirmation method) claim.
  327. Binding the access token to the client's `X509Certificate` provides the ability to implement a proof-of-possession mechanism during protected resource access.
  328. For example, the protected resource would obtain the client's `X509Certificate` used during Mutual-TLS authentication and then verify that the certificate thumbprint matches the `x5t#S256` claim associated with the access token.
  329. The following example shows how to enable certificate-bound access tokens for a client:
  330. [source,java]
  331. ----
  332. RegisteredClient mtlsClient = RegisteredClient.withId(UUID.randomUUID().toString())
  333. .clientId("mtls-client")
  334. .clientAuthenticationMethod(ClientAuthenticationMethod.TLS_CLIENT_AUTH)
  335. .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS)
  336. .scope("scope-a")
  337. .clientSettings(
  338. ClientSettings.builder()
  339. .x509CertificateSubjectDN("CN=mtls-client,OU=Spring Samples,O=Spring,C=US")
  340. .build()
  341. )
  342. .tokenSettings(
  343. TokenSettings.builder()
  344. .x509CertificateBoundAccessTokens(true)
  345. .build()
  346. )
  347. .build();
  348. ----