docs: add ADR for glob support for role assignments#234
docs: add ADR for glob support for role assignments#234BryanttV wants to merge 2 commits intoopenedx:mainfrom
Conversation
|
Thanks for the pull request, @BryanttV! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
| We will configure the ``AuthzEnforcer`` to use a domain/scope matching function for ``g`` policies that supports glob-like suffixes. Concretely: | ||
|
|
||
| - The enforcer will register a domain matching function for the ``g`` (grouping) function (for example, using ``key_match_func``). | ||
| - This matching function will treat ``*`` as a wildcard at the **end** of the string. That is, patterns such as ``course-v1:OpenedX+*`` will match ``course-v1:OpenedX+SOME+COURSE``, but the model will not rely on complex patterns or regular expressions. |
There was a problem hiding this comment.
Can you add a little more about the scope boundaries and how they are determined? Also exactly where a suffix can begin? Specifically I'd like to document which of these scopes would be considered valid:
*c*course-*course-v1*course-v1:*course-v1:O*course-v1:OpenedX+*(already listed, and I assume the only one that would be valid?)
Similarly I'd like to be explicit about whether these comparisons are case-sensitive or not.
There was a problem hiding this comment.
I assume these would be different per scope type matcher, but would just like to be explicit about the best practices and how we're choosing to reject globs in scopes that don't have custom matchers.
bmtcril
left a comment
There was a problem hiding this comment.
Just a couple of comments
Related issue: #172
Description
This PR adds ADR 0012 - Glob Support For Role Assignments, proposing an extension to the authorization model (Casbin) so that role assignments (
gpolicies) can use glob-like matching in thescopefield.Merge checklist
Check off if complete or not applicable: