Extract the ID Token JwtDecoderFactory to enable user customization #6415
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| /* | ||
| * Copyright 2002-2019 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.springframework.security.oauth2.client.oidc.authentication; | ||
|
|
||
| import org.springframework.security.oauth2.client.registration.ClientRegistration; | ||
| import org.springframework.security.oauth2.core.OAuth2AuthenticationException; | ||
| import org.springframework.security.oauth2.core.OAuth2Error; | ||
| import org.springframework.security.oauth2.core.OAuth2TokenValidator; | ||
| import org.springframework.security.oauth2.jwt.Jwt; | ||
| import org.springframework.security.oauth2.jwt.JwtDecoder; | ||
| import org.springframework.security.oauth2.jwt.JwtDecoderFactory; | ||
| import org.springframework.security.oauth2.jwt.NimbusJwtDecoder; | ||
| import org.springframework.util.Assert; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.function.Function; | ||
|
|
||
| import static org.springframework.security.oauth2.jwt.JwtProcessors.withJwkSetUri; | ||
|
|
||
| /** | ||
| * Provides a default or custom implementation for {@link OAuth2TokenValidator} | ||
| * | ||
| * @author Joe Grandja | ||
| * @author Rafael Dominguez | ||
| * @since 5.2 | ||
| * | ||
| * @see OAuth2TokenValidator | ||
| * @see Jwt | ||
| */ | ||
| public final class OidcIdTokenDecoderFactory implements JwtDecoderFactory<ClientRegistration> { | ||
| private static final String MISSING_SIGNATURE_VERIFIER_ERROR_CODE = "missing_signature_verifier"; | ||
| private final Map<String, JwtDecoder> jwtDecoders = new ConcurrentHashMap<>(); | ||
| private Function<ClientRegistration, OAuth2TokenValidator<Jwt>> jwtValidatorFactory = OidcIdTokenValidator::new; | ||
|
|
||
| @Override | ||
| public JwtDecoder createDecoder(ClientRegistration clientRegistration) { | ||
| Assert.notNull(clientRegistration, "clientRegistration cannot be null."); | ||
| return this.jwtDecoders.computeIfAbsent(clientRegistration.getRegistrationId(), key -> { | ||
|
There was a problem hiding this comment. We should |
||
| if (!StringUtils.hasText(clientRegistration.getProviderDetails().getJwkSetUri())) { | ||
| OAuth2Error oauth2Error = new OAuth2Error( | ||
| MISSING_SIGNATURE_VERIFIER_ERROR_CODE, | ||
| "Failed to find a Signature Verifier for Client Registration: '" + | ||
| clientRegistration.getRegistrationId() + | ||
| "'. Check to ensure you have configured the JwkSet URI.", | ||
| null | ||
| ); | ||
| throw new OAuth2AuthenticationException(oauth2Error, oauth2Error.toString()); | ||
| } | ||
| String jwkSetUri = clientRegistration.getProviderDetails().getJwkSetUri(); | ||
| NimbusJwtDecoder jwtDecoder = new NimbusJwtDecoder(withJwkSetUri(jwkSetUri).build()); | ||
| OAuth2TokenValidator<Jwt> jwtValidator = jwtValidatorFactory.apply(clientRegistration); | ||
| jwtDecoder.setJwtValidator(jwtValidator); | ||
| return jwtDecoder; | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Allows user customization for the {@link OAuth2TokenValidator} | ||
| * | ||
| * @param jwtValidatorFactory | ||
| */ | ||
| public final void setJwtValidatorFactory(Function<ClientRegistration, OAuth2TokenValidator<Jwt>> jwtValidatorFactory) { | ||
| Assert.notNull(jwtValidatorFactory, "jwtValidatorFactory cannot be null."); | ||
| this.jwtValidatorFactory = jwtValidatorFactory; | ||
|
|
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| /* | ||
| * Copyright 2002-2019 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.springframework.security.oauth2.client.oidc.authentication; | ||
|
|
||
| import org.springframework.security.oauth2.client.registration.ClientRegistration; | ||
| import org.springframework.security.oauth2.core.OAuth2AuthenticationException; | ||
| import org.springframework.security.oauth2.core.OAuth2Error; | ||
| import org.springframework.security.oauth2.core.OAuth2TokenValidator; | ||
| import org.springframework.security.oauth2.jwt.Jwt; | ||
| import org.springframework.security.oauth2.jwt.NimbusReactiveJwtDecoder; | ||
| import org.springframework.security.oauth2.jwt.ReactiveJwtDecoder; | ||
| import org.springframework.security.oauth2.jwt.ReactiveJwtDecoderFactory; | ||
| import org.springframework.util.Assert; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.concurrent.ConcurrentHashMap; | ||
| import java.util.function.Function; | ||
|
|
||
| /** | ||
| * Provides a default or custom reactive implementation for {@link OAuth2TokenValidator} | ||
| * | ||
| * @author Joe Grandja | ||
| * @author Rafael Dominguez | ||
| * @since 5.2 | ||
| * | ||
| * @see OAuth2TokenValidator | ||
| * @see Jwt | ||
| */ | ||
| public final class ReactiveOidcIdTokenDecoderFactory implements ReactiveJwtDecoderFactory<ClientRegistration> { | ||
| private static final String MISSING_SIGNATURE_VERIFIER_ERROR_CODE = "missing_signature_verifier"; | ||
|
There was a problem hiding this comment. Let's move the |
||
| private final Map<String, ReactiveJwtDecoder> jwtDecoders = new ConcurrentHashMap<>(); | ||
| private Function<ClientRegistration, OAuth2TokenValidator<Jwt>> jwtValidatorFactory = OidcIdTokenValidator::new; | ||
|
|
||
| @Override | ||
| public ReactiveJwtDecoder createDecoder(ClientRegistration clientRegistration) { | ||
| Assert.notNull(clientRegistration, "clientRegistration cannot be null."); | ||
| return this.jwtDecoders.computeIfAbsent(clientRegistration.getRegistrationId(), key -> { | ||
|
There was a problem hiding this comment. We should |
||
| if (!StringUtils.hasText(clientRegistration.getProviderDetails().getJwkSetUri())) { | ||
| OAuth2Error oauth2Error = new OAuth2Error( | ||
| MISSING_SIGNATURE_VERIFIER_ERROR_CODE, | ||
| "Failed to find a Signature Verifier for Client Registration: '" + | ||
| clientRegistration.getRegistrationId() + | ||
| "'. Check to ensure you have configured the JwkSet URI.", | ||
| null | ||
| ); | ||
| throw new OAuth2AuthenticationException(oauth2Error, oauth2Error.toString()); | ||
| } | ||
| NimbusReactiveJwtDecoder jwtDecoder = new NimbusReactiveJwtDecoder( | ||
| clientRegistration.getProviderDetails().getJwkSetUri()); | ||
| OAuth2TokenValidator<Jwt> jwtValidator = jwtValidatorFactory.apply(clientRegistration); | ||
| jwtDecoder.setJwtValidator(jwtValidator); | ||
| return jwtDecoder; | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Allows user customization for the {@link OAuth2TokenValidator} | ||
| * | ||
| * @param jwtValidatorFactory | ||
| */ | ||
| public final void setJwtValidatorFactory(Function<ClientRegistration, OAuth2TokenValidator<Jwt>> jwtValidatorFactory) { | ||
| Assert.notNull(jwtValidatorFactory, "jwtValidatorFactory cannot be null."); | ||
| this.jwtValidatorFactory = jwtValidatorFactory; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's move the
staticmembers to top of declarations.