-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Adds ability to inject custom metadata at client registration #1326
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
ddubson
wants to merge
1
commit into
spring-projects:main
from
ddubson:dcr-customize-client-reg-metadata-1172
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
126 changes: 126 additions & 0 deletions
126
.../server/authorization/oidc/converter/OidcClientRegistrationRegisteredClientConverter.java
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,126 @@ | ||
| /* | ||
| * Copyright 2020-2023 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 | ||
| * | ||
| * https://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.server.authorization.oidc.converter; | ||
|
|
||
| import org.springframework.core.convert.converter.Converter; | ||
| import org.springframework.security.crypto.keygen.Base64StringKeyGenerator; | ||
| import org.springframework.security.crypto.keygen.StringKeyGenerator; | ||
| import org.springframework.security.oauth2.core.AuthorizationGrantType; | ||
| import org.springframework.security.oauth2.core.ClientAuthenticationMethod; | ||
| import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationResponseType; | ||
| import org.springframework.security.oauth2.jose.jws.MacAlgorithm; | ||
| import org.springframework.security.oauth2.jose.jws.SignatureAlgorithm; | ||
| import org.springframework.security.oauth2.server.authorization.client.RegisteredClient; | ||
| import org.springframework.security.oauth2.server.authorization.oidc.OidcClientRegistration; | ||
| import org.springframework.security.oauth2.server.authorization.settings.ClientSettings; | ||
| import org.springframework.security.oauth2.server.authorization.settings.TokenSettings; | ||
| import org.springframework.util.CollectionUtils; | ||
|
|
||
| import java.time.Instant; | ||
| import java.util.Base64; | ||
| import java.util.UUID; | ||
|
|
||
| /** | ||
| * @author Joe Grandja | ||
| * @author Dmitriy Dubson | ||
| * @since 1.2.0 | ||
| */ | ||
| public final class OidcClientRegistrationRegisteredClientConverter implements Converter<OidcClientRegistration, RegisteredClient> { | ||
| private static final StringKeyGenerator CLIENT_ID_GENERATOR = new Base64StringKeyGenerator( | ||
| Base64.getUrlEncoder().withoutPadding(), 32); | ||
| private static final StringKeyGenerator CLIENT_SECRET_GENERATOR = new Base64StringKeyGenerator( | ||
| Base64.getUrlEncoder().withoutPadding(), 48); | ||
|
|
||
| @Override | ||
| public RegisteredClient convert(OidcClientRegistration clientRegistration) { | ||
| // @formatter:off | ||
| RegisteredClient.Builder builder = RegisteredClient.withId(UUID.randomUUID().toString()) | ||
| .clientId(CLIENT_ID_GENERATOR.generateKey()) | ||
| .clientIdIssuedAt(Instant.now()) | ||
| .clientName(clientRegistration.getClientName()); | ||
|
|
||
| if (ClientAuthenticationMethod.CLIENT_SECRET_POST.getValue().equals(clientRegistration.getTokenEndpointAuthenticationMethod())) { | ||
| builder | ||
| .clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_POST) | ||
| .clientSecret(CLIENT_SECRET_GENERATOR.generateKey()); | ||
| } else if (ClientAuthenticationMethod.CLIENT_SECRET_JWT.getValue().equals(clientRegistration.getTokenEndpointAuthenticationMethod())) { | ||
| builder | ||
| .clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_JWT) | ||
| .clientSecret(CLIENT_SECRET_GENERATOR.generateKey()); | ||
| } else if (ClientAuthenticationMethod.PRIVATE_KEY_JWT.getValue().equals(clientRegistration.getTokenEndpointAuthenticationMethod())) { | ||
| builder.clientAuthenticationMethod(ClientAuthenticationMethod.PRIVATE_KEY_JWT); | ||
| } else { | ||
| builder | ||
| .clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC) | ||
| .clientSecret(CLIENT_SECRET_GENERATOR.generateKey()); | ||
| } | ||
|
|
||
| builder.redirectUris(redirectUris -> | ||
| redirectUris.addAll(clientRegistration.getRedirectUris())); | ||
|
|
||
| if (!CollectionUtils.isEmpty(clientRegistration.getPostLogoutRedirectUris())) { | ||
| builder.postLogoutRedirectUris(postLogoutRedirectUris -> | ||
| postLogoutRedirectUris.addAll(clientRegistration.getPostLogoutRedirectUris())); | ||
| } | ||
|
|
||
| if (!CollectionUtils.isEmpty(clientRegistration.getGrantTypes())) { | ||
| builder.authorizationGrantTypes(authorizationGrantTypes -> | ||
| clientRegistration.getGrantTypes().forEach(grantType -> | ||
| authorizationGrantTypes.add(new AuthorizationGrantType(grantType)))); | ||
| } else { | ||
| builder.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE); | ||
| } | ||
| if (CollectionUtils.isEmpty(clientRegistration.getResponseTypes()) || | ||
| clientRegistration.getResponseTypes().contains(OAuth2AuthorizationResponseType.CODE.getValue())) { | ||
| builder.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE); | ||
| } | ||
|
|
||
| if (!CollectionUtils.isEmpty(clientRegistration.getScopes())) { | ||
| builder.scopes(scopes -> | ||
| scopes.addAll(clientRegistration.getScopes())); | ||
| } | ||
|
|
||
| ClientSettings.Builder clientSettingsBuilder = ClientSettings.builder() | ||
| .requireProofKey(true) | ||
| .requireAuthorizationConsent(true); | ||
|
|
||
| if (ClientAuthenticationMethod.CLIENT_SECRET_JWT.getValue().equals(clientRegistration.getTokenEndpointAuthenticationMethod())) { | ||
| MacAlgorithm macAlgorithm = MacAlgorithm.from(clientRegistration.getTokenEndpointAuthenticationSigningAlgorithm()); | ||
| if (macAlgorithm == null) { | ||
| macAlgorithm = MacAlgorithm.HS256; | ||
| } | ||
| clientSettingsBuilder.tokenEndpointAuthenticationSigningAlgorithm(macAlgorithm); | ||
| } else if (ClientAuthenticationMethod.PRIVATE_KEY_JWT.getValue().equals(clientRegistration.getTokenEndpointAuthenticationMethod())) { | ||
| SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.from(clientRegistration.getTokenEndpointAuthenticationSigningAlgorithm()); | ||
| if (signatureAlgorithm == null) { | ||
| signatureAlgorithm = SignatureAlgorithm.RS256; | ||
| } | ||
| clientSettingsBuilder.tokenEndpointAuthenticationSigningAlgorithm(signatureAlgorithm); | ||
| clientSettingsBuilder.jwkSetUrl(clientRegistration.getJwkSetUrl().toString()); | ||
| } | ||
|
|
||
| builder | ||
| .clientSettings(clientSettingsBuilder.build()) | ||
| .tokenSettings(TokenSettings.builder() | ||
| .idTokenSignatureAlgorithm(SignatureAlgorithm.RS256) | ||
| .build()); | ||
|
|
||
| return builder.build(); | ||
| // @formatter:on | ||
| } | ||
|
|
||
| } | ||
|
|
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
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.
Uh oh!
There was an error while loading. Please reload this page.