-
Notifications
You must be signed in to change notification settings - Fork 889
chore: Optimize rego policy input allocations #6135
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
22c6f50
chore: Optimize rego policy evaluation allocations
Emyrk 5b08612
Add a unit test that prevents regressions of rego input
Emyrk b696b1c
Maintain logging
Emyrk 407b236
Add comment
Emyrk eb5903d
Remove duplicated code
Emyrk 4ecd497
Remove unused line
Emyrk 6218570
Fix using forbidden error
Emyrk 22629e6
Linting
Emyrk File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| package rbac | ||
|
|
||
| import ( | ||
| "github.com/open-policy-agent/opa/ast" | ||
| "golang.org/x/xerrors" | ||
| ) | ||
|
|
||
| // regoInputValue returns a rego input value for the given subject, action, and | ||
| // object. This rego input is already parsed and can be used directly in a | ||
| // rego query. | ||
| func regoInputValue(subject Subject, action Action, object Object) (ast.Value, error) { | ||
| regoSubj, err := subject.regoValue() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("subject: %w", err) | ||
| } | ||
|
|
||
| s := [2]*ast.Term{ | ||
| ast.StringTerm("subject"), | ||
| ast.NewTerm(regoSubj), | ||
| } | ||
| a := [2]*ast.Term{ | ||
| ast.StringTerm("action"), | ||
| ast.StringTerm(string(action)), | ||
| } | ||
| o := [2]*ast.Term{ | ||
| ast.StringTerm("object"), | ||
| ast.NewTerm(object.regoValue()), | ||
| } | ||
|
|
||
| input := ast.NewObject(s, a, o) | ||
|
|
||
| return input, nil | ||
| } | ||
|
|
||
| // regoPartialInputValue is the same as regoInputValue but only includes the | ||
| // object type. This is for partial evaluations. | ||
| func regoPartialInputValue(subject Subject, action Action, objectType string) (ast.Value, error) { | ||
| regoSubj, err := subject.regoValue() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("subject: %w", err) | ||
| } | ||
|
|
||
| s := [2]*ast.Term{ | ||
| ast.StringTerm("subject"), | ||
| ast.NewTerm(regoSubj), | ||
| } | ||
| a := [2]*ast.Term{ | ||
| ast.StringTerm("action"), | ||
| ast.StringTerm(string(action)), | ||
| } | ||
| o := [2]*ast.Term{ | ||
| ast.StringTerm("object"), | ||
| ast.NewTerm(ast.NewObject( | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("type"), | ||
| ast.StringTerm(objectType), | ||
| }), | ||
| ), | ||
| } | ||
|
|
||
| input := ast.NewObject(s, a, o) | ||
|
|
||
| return input, nil | ||
| } | ||
|
|
||
| // regoValue returns the ast.Object representation of the subject. | ||
| func (s Subject) regoValue() (ast.Value, error) { | ||
| subjRoles, err := s.Roles.Expand() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("expand roles: %w", err) | ||
| } | ||
|
|
||
| subjScope, err := s.Scope.Expand() | ||
| if err != nil { | ||
| return nil, xerrors.Errorf("expand scope: %w", err) | ||
| } | ||
| subj := ast.NewObject( | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("id"), | ||
| ast.StringTerm(s.ID), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("roles"), | ||
| ast.NewTerm(regoSlice(subjRoles)), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("scope"), | ||
| ast.NewTerm(subjScope.regoValue()), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("groups"), | ||
| ast.NewTerm(regoSliceString(s.Groups...)), | ||
| }, | ||
| ) | ||
|
|
||
| return subj, nil | ||
| } | ||
|
|
||
| func (z Object) regoValue() ast.Value { | ||
| userACL := ast.NewObject() | ||
| for k, v := range z.ACLUserList { | ||
| userACL.Insert(ast.StringTerm(k), ast.NewTerm(regoSlice(v))) | ||
| } | ||
| grpACL := ast.NewObject() | ||
| for k, v := range z.ACLGroupList { | ||
| grpACL.Insert(ast.StringTerm(k), ast.NewTerm(regoSlice(v))) | ||
| } | ||
| return ast.NewObject( | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("id"), | ||
| ast.StringTerm(z.ID), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("owner"), | ||
| ast.StringTerm(z.Owner), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("org_owner"), | ||
| ast.StringTerm(z.OrgID), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("type"), | ||
| ast.StringTerm(z.Type), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("acl_user_list"), | ||
| ast.NewTerm(userACL), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("acl_group_list"), | ||
| ast.NewTerm(grpACL), | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func (role Role) regoValue() ast.Value { | ||
| orgMap := ast.NewObject() | ||
| for k, p := range role.Org { | ||
| orgMap.Insert(ast.StringTerm(k), ast.NewTerm(regoSlice(p))) | ||
| } | ||
| return ast.NewObject( | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("site"), | ||
| ast.NewTerm(regoSlice(role.Site)), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("org"), | ||
| ast.NewTerm(orgMap), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("user"), | ||
| ast.NewTerm(regoSlice(role.User)), | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func (s Scope) regoValue() ast.Value { | ||
| r, ok := s.Role.regoValue().(ast.Object) | ||
| if !ok { | ||
| panic("developer error: role is not an object") | ||
| } | ||
| r.Insert( | ||
| ast.StringTerm("allow_list"), | ||
| ast.NewTerm(regoSliceString(s.AllowIDList...)), | ||
| ) | ||
| return r | ||
| } | ||
|
|
||
| func (perm Permission) regoValue() ast.Value { | ||
| return ast.NewObject( | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("negate"), | ||
| ast.BooleanTerm(perm.Negate), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("resource_type"), | ||
| ast.StringTerm(perm.ResourceType), | ||
| }, | ||
| [2]*ast.Term{ | ||
| ast.StringTerm("action"), | ||
| ast.StringTerm(string(perm.Action)), | ||
| }, | ||
| ) | ||
| } | ||
|
|
||
| func (act Action) regoValue() ast.Value { | ||
| return ast.StringTerm(string(act)).Value | ||
| } | ||
|
|
||
| type regoValue interface { | ||
| regoValue() ast.Value | ||
| } | ||
|
|
||
| // regoSlice returns the ast.Array representation of the slice. | ||
| // The slice must contain only types that implement the regoValue interface. | ||
| func regoSlice[T regoValue](slice []T) *ast.Array { | ||
| terms := make([]*ast.Term, len(slice)) | ||
| for i, v := range slice { | ||
| terms[i] = ast.NewTerm(v.regoValue()) | ||
| } | ||
| return ast.NewArray(terms...) | ||
| } | ||
|
|
||
| func regoSliceString(slice ...string) *ast.Array { | ||
| terms := make([]*ast.Term, len(slice)) | ||
| for i, v := range slice { | ||
| terms[i] = ast.StringTerm(v) | ||
| } | ||
| return ast.NewArray(terms...) | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
review: these had been breaking comparison due to comparing empty vs nil slice