Fix #18863: Add extensible ClientSettings to ClientRegistration#18933
Open
pranavmanglik wants to merge 1 commit intospring-projects:mainfrom
Open
Fix #18863: Add extensible ClientSettings to ClientRegistration#18933pranavmanglik wants to merge 1 commit intospring-projects:mainfrom
pranavmanglik wants to merge 1 commit intospring-projects:mainfrom
Conversation
Signed-off-by: Pranav Manglik <pranav@undreamt.in>
3caa493 to
8a68648
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This pull request introduces an extensible
ClientSettingsconfiguration withinClientRegistration. Currently,ClientRegistrationhandles core OAuth2 properties, but adding provider-specific or advanced settings (such as custom PKCE requirements or extended client metadata) often requires modifying the core class or maintaining complex external maps.By encapsulating these configurations in a dedicated, immutable
ClientSettingsobject, we provide a cleaner API for future extensions without bloating theClientRegistrationroot. This aligns with the framework's goals of modularity and extensibility for modern OAuth2/OIDC flows.Key Changes
ClientSettings: A new configuration class held byClientRegistrationto store specialized client behavior settings.ClientRegistration.Builder: Added the.clientSettings(ClientSettings)method to the builder pattern to allow for fluent configuration.ClientRegistration.Builderto ensure that providedClientSettings(e.g.,requireProofKey) are compatible with the selectedAuthorizationGrantType.ClientRegistrationTestscovering valid configurations, edge cases, and validation failures.Related Issues
Ref: #18863 Checklist
./gradlew checkstyleMainClientRegistrationTests./gradlew :spring-security-oauth2-client:test