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

ACL with Microsoft Entra token support #378

Merged
merged 14 commits into from
May 21, 2024

Conversation

msft-paddy14
Copy link
Contributor

This PR proposes changes for #377.
The changes are done

  • Currently ACL auth by default does username and password validation with ACL entries. As part of this PR I've added IAuthenticator instance to inject authentication behavior of username and password and then just validate the permissions against the ACL list of the user rather than default behavior of password.
  • This approach favours composing the existing AclAuthenticator with AADAuthenticator rather than creating a new AclAadAuthenticator to keep the code clean and avoid class explosion

Testing:
There were no AAD tests. Have added a basic test to validate AAD + ACL and that it works with cluster auth.
I had to add support for a new constructor for testing with IssuerSigningToken - it might be easier to put this behind an abstraction but didn't do it to avoid changing scope of this PR

- Currently ACL auth by default does username and password validation with ACL entries. We compose it with an IAuthenticator instance to inject authentication behavior of username and  password and then just validate the permissions against the ACL list of the user. This approach is more favorable as it minimizes changes and avoids redundant code needed to combine behaviors of AclAuthenticator and AADAuthenticator. Rather than inheriting these behavior, we compose AclAuthenticator with an IAuthenticator.

Testing:
There were no AAD tests. Have added a basic test to validate AAD + ACL and that it works with cluster auth.
@msft-paddy14 msft-paddy14 self-assigned this May 12, 2024
@msft-paddy14 msft-paddy14 linked an issue May 12, 2024 that may be closed by this pull request
@msft-paddy14 msft-paddy14 requested review from vazois and lmaas May 13, 2024 17:16
libs/server/Auth/Aad/IssuerSigningTokenProvider.cs Outdated Show resolved Hide resolved
libs/server/Auth/GarnetAadAuthenticator.cs Outdated Show resolved Hide resolved
libs/server/Auth/AuthenticationSettings.cs Outdated Show resolved Hide resolved
libs/server/Auth/AuthenticationSettings.cs Outdated Show resolved Hide resolved
libs/server/Auth/GarnetACLAuthenticator.cs Outdated Show resolved Hide resolved
libs/server/Auth/GarnetACLAuthenticator.cs Outdated Show resolved Hide resolved
libs/server/Auth/GarnetAadAuthenticator.cs Outdated Show resolved Hide resolved
libs/server/Auth/GarnetAadAuthenticator.cs Outdated Show resolved Hide resolved
libs/server/Auth/GarnetAadAuthenticator.cs Outdated Show resolved Hide resolved
- Refactor to AclWithAad and AclWithPassword hierarchies
- fix naming convention for private member _validateUsername
- add comments and fix tests
- Add support for groupId check and corresponding test
libs/server/Auth/Aad/IssuerSigningTokenProvider.cs Outdated Show resolved Hide resolved
libs/server/Auth/AuthenticationSettings.cs Outdated Show resolved Hide resolved
… and move test constructor for IssuerSigningTokenProvider to test code
@vazois vazois self-requested a review May 20, 2024 16:09
Copy link
Contributor

@vazois vazois left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

@msft-paddy14 msft-paddy14 merged commit 5c4041e into main May 21, 2024
23 checks passed
@msft-paddy14 msft-paddy14 deleted the users/padgupta/add_acl_support branch May 21, 2024 18:17
chyin6 pushed a commit to jusjin-org/garnet that referenced this pull request Jul 2, 2024
* - Added option to allow AAD auth with ACL
- Currently ACL auth by default does username and password validation with ACL entries. We compose it with an IAuthenticator instance to inject authentication behavior of username and  password and then just validate the permissions against the ACL list of the user. This approach is more favorable as it minimizes changes and avoids redundant code needed to combine behaviors of AclAuthenticator and AADAuthenticator. Rather than inheriting these behavior, we compose AclAuthenticator with an IAuthenticator.

Testing:
There were no AAD tests. Have added a basic test to validate AAD + ACL and that it works with cluster auth.

* formatting fixes

* - Added AADValidateUsername flag
- Refactor to AclWithAad and AclWithPassword hierarchies
- fix naming convention for private member _validateUsername
- add comments and fix tests

* fomratting fixes

* fix logger parameter positioning

* fix parameter ordering for logger

* add default value

* add base type assertions

* add default value  - failing test due to this.

* - Fix comments to account for groupId
- Add support for groupId check and corresponding test

* Refactor code to separeate Authentication settings into seprate files and move test constructor for IssuerSigningTokenProvider to test code

---------

Co-authored-by: Lukas Maas <lumaas@microsoft.com>
@github-actions github-actions bot locked and limited conversation to collaborators Jul 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ACL support with Microsoft Entra tokens
3 participants