advanced.adoc 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. [[webflux-oauth2-login-advanced]]
  2. = Advanced Configuration
  3. The OAuth 2.0 Authorization Framework defines the https://tools.ietf.org/html/rfc6749#section-3[Protocol Endpoints] as follows:
  4. The authorization process utilizes two authorization server endpoints (HTTP resources):
  5. * Authorization Endpoint: Used by the client to obtain authorization from the resource owner via user-agent redirection.
  6. * Token Endpoint: Used by the client to exchange an authorization grant for an access token, typically with client authentication.
  7. As well as one client endpoint:
  8. * Redirection Endpoint: Used by the authorization server to return responses containing authorization credentials to the client via the resource owner user-agent.
  9. The OpenID Connect Core 1.0 specification defines the https://openid.net/specs/openid-connect-core-1_0.html#UserInfo[UserInfo Endpoint] as follows:
  10. The UserInfo Endpoint is an OAuth 2.0 Protected Resource that returns claims about the authenticated end-user.
  11. To obtain the requested claims about the end-user, the client makes a request to the UserInfo Endpoint by using an access token obtained through OpenID Connect Authentication.
  12. These claims are normally represented by a JSON object that contains a collection of name-value pairs for the claims.
  13. `ServerHttpSecurity.oauth2Login()` provides a number of configuration options for customizing OAuth 2.0 Login.
  14. The following code shows the complete configuration options available for the `oauth2Login()` DSL:
  15. .OAuth2 Login Configuration Options
  16. ====
  17. .Java
  18. [source,java,role="primary"]
  19. ----
  20. @EnableWebFluxSecurity
  21. public class OAuth2LoginSecurityConfig {
  22. @Bean
  23. SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
  24. http
  25. .oauth2Login(oauth2 -> oauth2
  26. .authenticationConverter(this.authenticationConverter())
  27. .authenticationMatcher(this.authenticationMatcher())
  28. .authenticationManager(this.authenticationManager())
  29. .authenticationSuccessHandler(this.authenticationSuccessHandler())
  30. .authenticationFailureHandler(this.authenticationFailureHandler())
  31. .clientRegistrationRepository(this.clientRegistrationRepository())
  32. .authorizedClientRepository(this.authorizedClientRepository())
  33. .authorizedClientService(this.authorizedClientService())
  34. .authorizationRequestResolver(this.authorizationRequestResolver())
  35. .authorizationRequestRepository(this.authorizationRequestRepository())
  36. .securityContextRepository(this.securityContextRepository())
  37. );
  38. return http.build();
  39. }
  40. }
  41. ----
  42. .Kotlin
  43. [source,kotlin,role="secondary"]
  44. ----
  45. @EnableWebFluxSecurity
  46. class OAuth2LoginSecurityConfig {
  47. @Bean
  48. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  49. return http {
  50. oauth2Login {
  51. authenticationConverter = authenticationConverter()
  52. authenticationMatcher = authenticationMatcher()
  53. authenticationManager = authenticationManager()
  54. authenticationSuccessHandler = authenticationSuccessHandler()
  55. authenticationFailureHandler = authenticationFailureHandler()
  56. clientRegistrationRepository = clientRegistrationRepository()
  57. authorizedClientRepository = authorizedClientRepository()
  58. authorizedClientService = authorizedClientService()
  59. authorizationRequestResolver = authorizationRequestResolver()
  60. authorizationRequestRepository = authorizationRequestRepository()
  61. securityContextRepository = securityContextRepository()
  62. }
  63. }
  64. }
  65. }
  66. ----
  67. ====
  68. The following sections go into more detail on each of the configuration options available:
  69. * <<webflux-oauth2-login-advanced-login-page, OAuth 2.0 Login Page>>
  70. * <<webflux-oauth2-login-advanced-redirection-endpoint, Redirection Endpoint>>
  71. * <<webflux-oauth2-login-advanced-userinfo-endpoint, UserInfo Endpoint>>
  72. * <<webflux-oauth2-login-advanced-idtoken-verify, ID Token Signature Verification>>
  73. * <<webflux-oauth2-login-advanced-oidc-logout, OpenID Connect 1.0 Logout>>
  74. [[webflux-oauth2-login-advanced-login-page]]
  75. == OAuth 2.0 Login Page
  76. By default, the OAuth 2.0 Login Page is auto-generated by the `LoginPageGeneratingWebFilter`.
  77. The default login page shows each configured OAuth Client with its `ClientRegistration.clientName` as a link, which is capable of initiating the Authorization Request (or OAuth 2.0 Login).
  78. [NOTE]
  79. In order for `LoginPageGeneratingWebFilter` to show links for configured OAuth Clients, the registered `ReactiveClientRegistrationRepository` needs to also implement `Iterable<ClientRegistration>`.
  80. See `InMemoryReactiveClientRegistrationRepository` for reference.
  81. The link's destination for each OAuth Client defaults to the following:
  82. `+"/oauth2/authorization/{registrationId}"+`
  83. The following line shows an example:
  84. [source,html]
  85. ----
  86. <a href="/oauth2/authorization/google">Google</a>
  87. ----
  88. To override the default login page, configure the `exceptionHandling().authenticationEntryPoint()` and (optionally) `oauth2Login().authorizationRequestResolver()`.
  89. The following listing shows an example:
  90. .OAuth2 Login Page Configuration
  91. ====
  92. .Java
  93. [source,java,role="primary"]
  94. ----
  95. @EnableWebFluxSecurity
  96. public class OAuth2LoginSecurityConfig {
  97. @Bean
  98. public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
  99. http
  100. .exceptionHandling(exceptionHandling -> exceptionHandling
  101. .authenticationEntryPoint(new RedirectServerAuthenticationEntryPoint("/login/oauth2"))
  102. )
  103. .oauth2Login(oauth2 -> oauth2
  104. .authorizationRequestResolver(this.authorizationRequestResolver())
  105. );
  106. return http.build();
  107. }
  108. private ServerOAuth2AuthorizationRequestResolver authorizationRequestResolver() {
  109. ServerWebExchangeMatcher authorizationRequestMatcher =
  110. new PathPatternParserServerWebExchangeMatcher(
  111. "/login/oauth2/authorization/{registrationId}");
  112. return new DefaultServerOAuth2AuthorizationRequestResolver(
  113. this.clientRegistrationRepository(), authorizationRequestMatcher);
  114. }
  115. ...
  116. }
  117. ----
  118. .Kotlin
  119. [source,kotlin,role="secondary"]
  120. ----
  121. @EnableWebFluxSecurity
  122. class OAuth2LoginSecurityConfig {
  123. @Bean
  124. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  125. return http {
  126. exceptionHandling {
  127. authenticationEntryPoint = RedirectServerAuthenticationEntryPoint("/login/oauth2")
  128. }
  129. oauth2Login {
  130. authorizationRequestResolver = authorizationRequestResolver()
  131. }
  132. }
  133. }
  134. private fun authorizationRequestResolver(): ServerOAuth2AuthorizationRequestResolver {
  135. val authorizationRequestMatcher: ServerWebExchangeMatcher = PathPatternParserServerWebExchangeMatcher(
  136. "/login/oauth2/authorization/{registrationId}"
  137. )
  138. return DefaultServerOAuth2AuthorizationRequestResolver(
  139. clientRegistrationRepository(), authorizationRequestMatcher
  140. )
  141. }
  142. ...
  143. }
  144. ----
  145. ====
  146. [IMPORTANT]
  147. You need to provide a `@Controller` with a `@RequestMapping("/login/oauth2")` that is capable of rendering the custom login page.
  148. [TIP]
  149. ====
  150. As noted earlier, configuring `oauth2Login().authorizationRequestResolver()` is optional.
  151. However, if you choose to customize it, ensure the link to each OAuth Client matches the pattern provided through the `ServerWebExchangeMatcher`.
  152. The following line shows an example:
  153. [source,html]
  154. ----
  155. <a href="/login/oauth2/authorization/google">Google</a>
  156. ----
  157. ====
  158. [[webflux-oauth2-login-advanced-redirection-endpoint]]
  159. == Redirection Endpoint
  160. The Redirection Endpoint is used by the Authorization Server for returning the Authorization Response (which contains the authorization credentials) to the client via the Resource Owner user-agent.
  161. [TIP]
  162. OAuth 2.0 Login leverages the Authorization Code Grant.
  163. Therefore, the authorization credential is the authorization code.
  164. The default Authorization Response redirection endpoint is `/login/oauth2/code/{registrationId}`.
  165. If you would like to customize the Authorization Response redirection endpoint, configure it as shown in the following example:
  166. .Redirection Endpoint Configuration
  167. ====
  168. .Java
  169. [source,java,role="primary"]
  170. ----
  171. @EnableWebFluxSecurity
  172. public class OAuth2LoginSecurityConfig {
  173. @Bean
  174. public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
  175. http
  176. .oauth2Login(oauth2 -> oauth2
  177. .authenticationMatcher(new PathPatternParserServerWebExchangeMatcher("/login/oauth2/callback/{registrationId}"))
  178. );
  179. return http.build();
  180. }
  181. }
  182. ----
  183. .Kotlin
  184. [source,kotlin,role="secondary"]
  185. ----
  186. @EnableWebFluxSecurity
  187. class OAuth2LoginSecurityConfig {
  188. @Bean
  189. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  190. return http {
  191. oauth2Login {
  192. authenticationMatcher = PathPatternParserServerWebExchangeMatcher("/login/oauth2/callback/{registrationId}")
  193. }
  194. }
  195. }
  196. }
  197. ----
  198. ====
  199. [IMPORTANT]
  200. ====
  201. You also need to ensure the `ClientRegistration.redirectUri` matches the custom Authorization Response redirection endpoint.
  202. The following listing shows an example:
  203. .Java
  204. [source,java,role="primary",attrs="-attributes"]
  205. ----
  206. return CommonOAuth2Provider.GOOGLE.getBuilder("google")
  207. .clientId("google-client-id")
  208. .clientSecret("google-client-secret")
  209. .redirectUri("{baseUrl}/login/oauth2/callback/{registrationId}")
  210. .build();
  211. ----
  212. .Kotlin
  213. [source,kotlin,role="secondary",attrs="-attributes"]
  214. ----
  215. return CommonOAuth2Provider.GOOGLE.getBuilder("google")
  216. .clientId("google-client-id")
  217. .clientSecret("google-client-secret")
  218. .redirectUri("{baseUrl}/login/oauth2/callback/{registrationId}")
  219. .build()
  220. ----
  221. ====
  222. [[webflux-oauth2-login-advanced-userinfo-endpoint]]
  223. == UserInfo Endpoint
  224. The UserInfo Endpoint includes a number of configuration options, as described in the following sub-sections:
  225. * <<webflux-oauth2-login-advanced-map-authorities, Mapping User Authorities>>
  226. * <<webflux-oauth2-login-advanced-oauth2-user-service, OAuth 2.0 UserService>>
  227. * <<webflux-oauth2-login-advanced-oidc-user-service, OpenID Connect 1.0 UserService>>
  228. [[webflux-oauth2-login-advanced-map-authorities]]
  229. === Mapping User Authorities
  230. After the user successfully authenticates with the OAuth 2.0 Provider, the `OAuth2User.getAuthorities()` (or `OidcUser.getAuthorities()`) may be mapped to a new set of `GrantedAuthority` instances, which will be supplied to `OAuth2AuthenticationToken` when completing the authentication.
  231. [TIP]
  232. `OAuth2AuthenticationToken.getAuthorities()` is used for authorizing requests, such as in `hasRole('USER')` or `hasRole('ADMIN')`.
  233. There are a couple of options to choose from when mapping user authorities:
  234. * <<webflux-oauth2-login-advanced-map-authorities-grantedauthoritiesmapper, Using a GrantedAuthoritiesMapper>>
  235. * <<webflux-oauth2-login-advanced-map-authorities-reactiveoauth2userservice, Delegation-based strategy with ReactiveOAuth2UserService>>
  236. [[webflux-oauth2-login-advanced-map-authorities-grantedauthoritiesmapper]]
  237. ==== Using a GrantedAuthoritiesMapper
  238. Register a `GrantedAuthoritiesMapper` `@Bean` to have it automatically applied to the configuration, as shown in the following example:
  239. .Granted Authorities Mapper Configuration
  240. ====
  241. .Java
  242. [source,java,role="primary"]
  243. ----
  244. @EnableWebFluxSecurity
  245. public class OAuth2LoginSecurityConfig {
  246. @Bean
  247. public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
  248. http
  249. ...
  250. .oauth2Login(withDefaults());
  251. return http.build();
  252. }
  253. @Bean
  254. public GrantedAuthoritiesMapper userAuthoritiesMapper() {
  255. return (authorities) -> {
  256. Set<GrantedAuthority> mappedAuthorities = new HashSet<>();
  257. authorities.forEach(authority -> {
  258. if (OidcUserAuthority.class.isInstance(authority)) {
  259. OidcUserAuthority oidcUserAuthority = (OidcUserAuthority)authority;
  260. OidcIdToken idToken = oidcUserAuthority.getIdToken();
  261. OidcUserInfo userInfo = oidcUserAuthority.getUserInfo();
  262. // Map the claims found in idToken and/or userInfo
  263. // to one or more GrantedAuthority's and add it to mappedAuthorities
  264. } else if (OAuth2UserAuthority.class.isInstance(authority)) {
  265. OAuth2UserAuthority oauth2UserAuthority = (OAuth2UserAuthority)authority;
  266. Map<String, Object> userAttributes = oauth2UserAuthority.getAttributes();
  267. // Map the attributes found in userAttributes
  268. // to one or more GrantedAuthority's and add it to mappedAuthorities
  269. }
  270. });
  271. return mappedAuthorities;
  272. };
  273. }
  274. }
  275. ----
  276. .Kotlin
  277. [source,kotlin,role="secondary"]
  278. ----
  279. @EnableWebFluxSecurity
  280. class OAuth2LoginSecurityConfig {
  281. @Bean
  282. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  283. return http {
  284. oauth2Login { }
  285. }
  286. }
  287. @Bean
  288. fun userAuthoritiesMapper(): GrantedAuthoritiesMapper = GrantedAuthoritiesMapper { authorities: Collection<GrantedAuthority> ->
  289. val mappedAuthorities = emptySet<GrantedAuthority>()
  290. authorities.forEach { authority ->
  291. if (authority is OidcUserAuthority) {
  292. val idToken = authority.idToken
  293. val userInfo = authority.userInfo
  294. // Map the claims found in idToken and/or userInfo
  295. // to one or more GrantedAuthority's and add it to mappedAuthorities
  296. } else if (authority is OAuth2UserAuthority) {
  297. val userAttributes = authority.attributes
  298. // Map the attributes found in userAttributes
  299. // to one or more GrantedAuthority's and add it to mappedAuthorities
  300. }
  301. }
  302. mappedAuthorities
  303. }
  304. }
  305. ----
  306. ====
  307. [[webflux-oauth2-login-advanced-map-authorities-reactiveoauth2userservice]]
  308. ==== Delegation-based strategy with ReactiveOAuth2UserService
  309. This strategy is advanced compared to using a `GrantedAuthoritiesMapper`, however, it's also more flexible as it gives you access to the `OAuth2UserRequest` and `OAuth2User` (when using an OAuth 2.0 UserService) or `OidcUserRequest` and `OidcUser` (when using an OpenID Connect 1.0 UserService).
  310. The `OAuth2UserRequest` (and `OidcUserRequest`) provides you access to the associated `OAuth2AccessToken`, which is very useful in the cases where the _delegator_ needs to fetch authority information from a protected resource before it can map the custom authorities for the user.
  311. The following example shows how to implement and configure a delegation-based strategy using an OpenID Connect 1.0 UserService:
  312. .ReactiveOAuth2UserService Configuration
  313. ====
  314. .Java
  315. [source,java,role="primary"]
  316. ----
  317. @EnableWebFluxSecurity
  318. public class OAuth2LoginSecurityConfig {
  319. @Bean
  320. public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
  321. http
  322. ...
  323. .oauth2Login(withDefaults());
  324. return http.build();
  325. }
  326. @Bean
  327. public ReactiveOAuth2UserService<OidcUserRequest, OidcUser> oidcUserService() {
  328. final OidcReactiveOAuth2UserService delegate = new OidcReactiveOAuth2UserService();
  329. return (userRequest) -> {
  330. // Delegate to the default implementation for loading a user
  331. return delegate.loadUser(userRequest)
  332. .flatMap((oidcUser) -> {
  333. OAuth2AccessToken accessToken = userRequest.getAccessToken();
  334. Set<GrantedAuthority> mappedAuthorities = new HashSet<>();
  335. // TODO
  336. // 1) Fetch the authority information from the protected resource using accessToken
  337. // 2) Map the authority information to one or more GrantedAuthority's and add it to mappedAuthorities
  338. // 3) Create a copy of oidcUser but use the mappedAuthorities instead
  339. oidcUser = new DefaultOidcUser(mappedAuthorities, oidcUser.getIdToken(), oidcUser.getUserInfo());
  340. return Mono.just(oidcUser);
  341. });
  342. };
  343. }
  344. }
  345. ----
  346. .Kotlin
  347. [source,kotlin,role="secondary"]
  348. ----
  349. @EnableWebFluxSecurity
  350. class OAuth2LoginSecurityConfig {
  351. @Bean
  352. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  353. return http {
  354. oauth2Login { }
  355. }
  356. }
  357. @Bean
  358. fun oidcUserService(): ReactiveOAuth2UserService<OidcUserRequest, OidcUser> {
  359. val delegate = OidcReactiveOAuth2UserService()
  360. return ReactiveOAuth2UserService { userRequest ->
  361. // Delegate to the default implementation for loading a user
  362. delegate.loadUser(userRequest)
  363. .flatMap { oidcUser ->
  364. val accessToken = userRequest.accessToken
  365. val mappedAuthorities = mutableSetOf<GrantedAuthority>()
  366. // TODO
  367. // 1) Fetch the authority information from the protected resource using accessToken
  368. // 2) Map the authority information to one or more GrantedAuthority's and add it to mappedAuthorities
  369. // 3) Create a copy of oidcUser but use the mappedAuthorities instead
  370. val mappedOidcUser = DefaultOidcUser(mappedAuthorities, oidcUser.idToken, oidcUser.userInfo)
  371. Mono.just(mappedOidcUser)
  372. }
  373. }
  374. }
  375. }
  376. ----
  377. ====
  378. [[webflux-oauth2-login-advanced-oauth2-user-service]]
  379. === OAuth 2.0 UserService
  380. `DefaultReactiveOAuth2UserService` is an implementation of a `ReactiveOAuth2UserService` that supports standard OAuth 2.0 Provider's.
  381. [NOTE]
  382. `ReactiveOAuth2UserService` obtains the user attributes of the end-user (the resource owner) from the UserInfo Endpoint (by using the access token granted to the client during the authorization flow) and returns an `AuthenticatedPrincipal` in the form of an `OAuth2User`.
  383. `DefaultReactiveOAuth2UserService` uses a `WebClient` when requesting the user attributes at the UserInfo Endpoint.
  384. If you need to customize the pre-processing of the UserInfo Request and/or the post-handling of the UserInfo Response, you will need to provide `DefaultReactiveOAuth2UserService.setWebClient()` with a custom configured `WebClient`.
  385. Whether you customize `DefaultReactiveOAuth2UserService` or provide your own implementation of `ReactiveOAuth2UserService`, you'll need to configure it as shown in the following example:
  386. ====
  387. .Java
  388. [source,java,role="primary"]
  389. ----
  390. @EnableWebFluxSecurity
  391. public class OAuth2LoginSecurityConfig {
  392. @Bean
  393. public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
  394. http
  395. ...
  396. .oauth2Login(withDefaults());
  397. return http.build();
  398. }
  399. @Bean
  400. public ReactiveOAuth2UserService<OAuth2UserRequest, OAuth2User> oauth2UserService() {
  401. ...
  402. }
  403. }
  404. ----
  405. .Kotlin
  406. [source,kotlin,role="secondary"]
  407. ----
  408. @EnableWebFluxSecurity
  409. class OAuth2LoginSecurityConfig {
  410. @Bean
  411. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  412. return http {
  413. oauth2Login { }
  414. }
  415. }
  416. @Bean
  417. fun oauth2UserService(): ReactiveOAuth2UserService<OAuth2UserRequest, OAuth2User> {
  418. // ...
  419. }
  420. }
  421. ----
  422. ====
  423. [[webflux-oauth2-login-advanced-oidc-user-service]]
  424. === OpenID Connect 1.0 UserService
  425. `OidcReactiveOAuth2UserService` is an implementation of a `ReactiveOAuth2UserService` that supports OpenID Connect 1.0 Provider's.
  426. The `OidcReactiveOAuth2UserService` leverages the `DefaultReactiveOAuth2UserService` when requesting the user attributes at the UserInfo Endpoint.
  427. If you need to customize the pre-processing of the UserInfo Request and/or the post-handling of the UserInfo Response, you will need to provide `OidcReactiveOAuth2UserService.setOauth2UserService()` with a custom configured `ReactiveOAuth2UserService`.
  428. Whether you customize `OidcReactiveOAuth2UserService` or provide your own implementation of `ReactiveOAuth2UserService` for OpenID Connect 1.0 Provider's, you'll need to configure it as shown in the following example:
  429. ====
  430. .Java
  431. [source,java,role="primary"]
  432. ----
  433. @EnableWebFluxSecurity
  434. public class OAuth2LoginSecurityConfig {
  435. @Bean
  436. public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
  437. http
  438. ...
  439. .oauth2Login(withDefaults());
  440. return http.build();
  441. }
  442. @Bean
  443. public ReactiveOAuth2UserService<OidcUserRequest, OidcUser> oidcUserService() {
  444. ...
  445. }
  446. }
  447. ----
  448. .Kotlin
  449. [source,kotlin,role="secondary"]
  450. ----
  451. @EnableWebFluxSecurity
  452. class OAuth2LoginSecurityConfig {
  453. @Bean
  454. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  455. return http {
  456. oauth2Login { }
  457. }
  458. }
  459. @Bean
  460. fun oidcUserService(): ReactiveOAuth2UserService<OidcUserRequest, OidcUser> {
  461. // ...
  462. }
  463. }
  464. ----
  465. ====
  466. [[webflux-oauth2-login-advanced-idtoken-verify]]
  467. == ID Token Signature Verification
  468. OpenID Connect 1.0 Authentication introduces the https://openid.net/specs/openid-connect-core-1_0.html#IDToken[ID Token], which is a security token that contains Claims about the Authentication of an End-User by an Authorization Server when used by a Client.
  469. The ID Token is represented as a https://tools.ietf.org/html/rfc7519[JSON Web Token] (JWT) and MUST be signed using https://tools.ietf.org/html/rfc7515[JSON Web Signature] (JWS).
  470. The `ReactiveOidcIdTokenDecoderFactory` provides a `ReactiveJwtDecoder` used for `OidcIdToken` signature verification. The default algorithm is `RS256` but may be different when assigned during client registration.
  471. For these cases, a resolver may be configured to return the expected JWS algorithm assigned for a specific client.
  472. The JWS algorithm resolver is a `Function` that accepts a `ClientRegistration` and returns the expected `JwsAlgorithm` for the client, eg. `SignatureAlgorithm.RS256` or `MacAlgorithm.HS256`
  473. The following code shows how to configure the `OidcIdTokenDecoderFactory` `@Bean` to default to `MacAlgorithm.HS256` for all `ClientRegistration`:
  474. ====
  475. .Java
  476. [source,java,role="primary"]
  477. ----
  478. @Bean
  479. public ReactiveJwtDecoderFactory<ClientRegistration> idTokenDecoderFactory() {
  480. ReactiveOidcIdTokenDecoderFactory idTokenDecoderFactory = new ReactiveOidcIdTokenDecoderFactory();
  481. idTokenDecoderFactory.setJwsAlgorithmResolver(clientRegistration -> MacAlgorithm.HS256);
  482. return idTokenDecoderFactory;
  483. }
  484. ----
  485. .Kotlin
  486. [source,kotlin,role="secondary"]
  487. ----
  488. @Bean
  489. fun idTokenDecoderFactory(): ReactiveJwtDecoderFactory<ClientRegistration> {
  490. val idTokenDecoderFactory = ReactiveOidcIdTokenDecoderFactory()
  491. idTokenDecoderFactory.setJwsAlgorithmResolver { MacAlgorithm.HS256 }
  492. return idTokenDecoderFactory
  493. }
  494. ----
  495. ====
  496. [NOTE]
  497. For MAC based algorithms such as `HS256`, `HS384` or `HS512`, the `client-secret` corresponding to the `client-id` is used as the symmetric key for signature verification.
  498. [TIP]
  499. If more than one `ClientRegistration` is configured for OpenID Connect 1.0 Authentication, the JWS algorithm resolver may evaluate the provided `ClientRegistration` to determine which algorithm to return.
  500. [[webflux-oauth2-login-advanced-oidc-logout]]
  501. == OpenID Connect 1.0 Logout
  502. OpenID Connect Session Management 1.0 allows the ability to log out the End-User at the Provider using the Client.
  503. One of the strategies available is https://openid.net/specs/openid-connect-rpinitiated-1_0.html[RP-Initiated Logout].
  504. If the OpenID Provider supports both Session Management and https://openid.net/specs/openid-connect-discovery-1_0.html[Discovery], the client may obtain the `end_session_endpoint` `URL` from the OpenID Provider's https://openid.net/specs/openid-connect-session-1_0.html#OPMetadata[Discovery Metadata].
  505. This can be achieved by configuring the `ClientRegistration` with the `issuer-uri`, as in the following example:
  506. [source,yaml]
  507. ----
  508. spring:
  509. security:
  510. oauth2:
  511. client:
  512. registration:
  513. okta:
  514. client-id: okta-client-id
  515. client-secret: okta-client-secret
  516. ...
  517. provider:
  518. okta:
  519. issuer-uri: https://dev-1234.oktapreview.com
  520. ----
  521. ...and the `OidcClientInitiatedServerLogoutSuccessHandler`, which implements RP-Initiated Logout, may be configured as follows:
  522. ====
  523. .Java
  524. [source,java,role="primary"]
  525. ----
  526. @EnableWebFluxSecurity
  527. public class OAuth2LoginSecurityConfig {
  528. @Autowired
  529. private ReactiveClientRegistrationRepository clientRegistrationRepository;
  530. @Bean
  531. public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
  532. http
  533. .authorizeExchange(authorize -> authorize
  534. .anyExchange().authenticated()
  535. )
  536. .oauth2Login(withDefaults())
  537. .logout(logout -> logout
  538. .logoutSuccessHandler(oidcLogoutSuccessHandler())
  539. );
  540. return http.build();
  541. }
  542. private ServerLogoutSuccessHandler oidcLogoutSuccessHandler() {
  543. OidcClientInitiatedServerLogoutSuccessHandler oidcLogoutSuccessHandler =
  544. new OidcClientInitiatedServerLogoutSuccessHandler(this.clientRegistrationRepository);
  545. // Sets the location that the End-User's User Agent will be redirected to
  546. // after the logout has been performed at the Provider
  547. oidcLogoutSuccessHandler.setPostLogoutRedirectUri("{baseUrl}");
  548. return oidcLogoutSuccessHandler;
  549. }
  550. }
  551. ----
  552. .Kotlin
  553. [source,kotlin,role="secondary"]
  554. ----
  555. @EnableWebFluxSecurity
  556. class OAuth2LoginSecurityConfig {
  557. @Autowired
  558. private lateinit var clientRegistrationRepository: ReactiveClientRegistrationRepository
  559. @Bean
  560. fun securityWebFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
  561. return http {
  562. authorizeExchange {
  563. authorize(anyExchange, authenticated)
  564. }
  565. oauth2Login { }
  566. logout {
  567. logoutSuccessHandler = oidcLogoutSuccessHandler()
  568. }
  569. }
  570. }
  571. private fun oidcLogoutSuccessHandler(): ServerLogoutSuccessHandler {
  572. val oidcLogoutSuccessHandler = OidcClientInitiatedServerLogoutSuccessHandler(clientRegistrationRepository)
  573. // Sets the location that the End-User's User Agent will be redirected to
  574. // after the logout has been performed at the Provider
  575. oidcLogoutSuccessHandler.setPostLogoutRedirectUri("{baseUrl}")
  576. return oidcLogoutSuccessHandler
  577. }
  578. }
  579. ----
  580. ====
  581. NOTE: `OidcClientInitiatedServerLogoutSuccessHandler` supports the `{baseUrl}` placeholder.
  582. If used, the application's base URL, like `https://app.example.org`, will replace it at request time.