Skip to content
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

Explain in JWTCallerPrincipal#getName JavaDocs that this method may not return a unique principal name #731

Merged

Conversation

sberyozkin
Copy link
Contributor

Fixes #714

@sberyozkin sberyozkin requested a review from Skyllarr October 13, 2023 17:27
@Skyllarr
Copy link
Collaborator

Skyllarr commented Oct 16, 2023

@sberyozkin just wondering why the javadoc of JsonWebToken#getName is not being updated instead to not mention uniqueness?

@sberyozkin
Copy link
Contributor Author

sberyozkin commented Oct 16, 2023

@Skyllarr, good point, right now I'm not sure how eclipse/microprofile-jwt-auth#319 will be resolved, we may indeed end up adding the same kind of caution there, though a more energetic fix would be to remove a preferred_username check if the major MP JWT version - the problem is, it is hard to know when the major version will happen or if we will get an all around agreement.

In general, everyone is concerned about breaking things at the spec level

@sberyozkin sberyozkin force-pushed the doc_principal_name_is_not_unique branch from 955597e to 04f8168 Compare October 16, 2023 17:05
@Skyllarr
Copy link
Collaborator

Skyllarr commented Oct 16, 2023

@sberyozkin makes sense, thank you!

@sberyozkin sberyozkin merged commit 605c57b into smallrye:main Oct 17, 2023
5 checks passed
@sberyozkin sberyozkin deleted the doc_principal_name_is_not_unique branch October 17, 2023 10:44
@sberyozkin sberyozkin added this to the 4.3.2 milestone Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a warning to the docs that JsonWebToken.getName is not guaranteed to be unique
2 participants