Configure how RabbitMQ determines the username from an OAuth 2.0 token #6247
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.
This PR is about configuring how RabbitMQ determines the username from an OAuth 2.0 token (a.k.a. JWT).
There are two situations where RabbitMQ needs to determine the username:
User 'rabbit_admin' authenticated successfully by backend rabbit_auth_backend_oauth
Current implementation
RabbitMQ first looks up if a username was provided along with the token. This is possible when we authenticate via one of the messaging protocols, e.g. amqp. The username field should be left blank and the password carries the JWT. However, if the username field is present, RabbitMQ uses that field. If the username is not present, RabbitMQ uses the
sub
claim and if it does not have it either, it uses theclient_id
claim.Problems with the current implementation
sub
field for some internal primary key associated to the user. When the user logs in to the management ui, it is not a good experience to show an identity the user does not relate to.Proposed changes
This PR adds a new setting to the auth2 backend plugin that allows you to specify one or multiple claims which are used to determine the user's identity. For instance, UAA typically sets the user's identity in the
user_name
claim. In this case, we would configure RabbitMQ to look foruser_name
first and then foremail
.Types of Changes
What types of changes does your code introduce to this project?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply.You can also fill these out after creating the PR.
If you're unsure about any of them, don't hesitate to ask on the mailing list.
We're here to help!
This is simply a reminder of what we are going to look for before merging your code.
CONTRIBUTING.md
documentFurther Comments
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc.