Expose getter for nameAttributeKey in OAuth2AuthenticatedPrincipal #16003
+31
−9
Conversation
This file contains 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
spring-projects-issues
added
the
status: waiting-for-triage
jzheaux
requested changes
Nov 1, 2024
| @@ -64,7 +64,7 @@ public DefaultOAuth2AuthenticatedPrincipal(String name, Map<String, Object> attr | |||
| this.attributes = Collections.unmodifiableMap(attributes); | |||
| this.authorities = (authorities != null) ? Collections.unmodifiableCollection(authorities) | |||
| : AuthorityUtils.NO_AUTHORITIES; | |||
| this.name = (name != null) ? name : (String) this.attributes.get("sub"); | |||
| this.name = (name != null) ? name : OAuth2AuthenticatedPrincipal.super.getName(); | |||
There was a problem hiding this comment.
Let's please leave this as-is.
| @@ -81,6 +81,11 @@ public Collection<? extends GrantedAuthority> getAuthorities() { | |||
| return this.authorities; | |||
| } | |||
|
|
|||
| @Override | |||
There was a problem hiding this comment.
What if we instead added a constructor that took the String name instead of the attribute key? Then, we could simply deprecate the nameAttributeKey constructor and have it call the new constructor? In that case, this method and the interface method would go away.
There was a problem hiding this comment.
At that point, we'd also want to update production files to use the new constructor (that is, tests can stay the same).
jzheaux
added
type: enhancement
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.
Given a
DefaultOidcUserorDefaultOAuth2User, it is currently not possible to create a faithful copy of the instance since the constructors require anameAttributeKeyfor the all-arg constructor:which is not accessible.
This issue has been mentioned before in #14461 (comment) where a custom
ExtendedOidcUserdecorator class is used to work around it. While that works, I feel that this should be possible without introducing a separate class using just the public API.The PR aims to change this by adding the
OAuth2AuthenticatedPrincipal.getNameAttributeKeymethod in 464b078. This is a breaking change for classes implementing the interface.With the
nameAttributeKeynow available from within the interface, I figured it also makes sense to provide a default implementation forOAuth2AuthenticatedPrincipal.getNamein c7bcf86.