Moving to structured JSON policy decisions. #1718
Merged
Conversation
This file contains 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 commit makes two major changes:
1. All policy enforcement points now receive a context objects and use it
to log policy errors and denial decisions.
2. Policy denials are now conveyed as structured JSON objects.
Whereas previously policy denial was surfaced as a text error message,
the policy now generates a bracketed base64 encoded string:
policydecision< (base64) >policydecision
When decoded, this will be a JSON object with the following structure:
```json
{
"input": <redacted input object>,
"decision": "deny",
"reason": <reason object explaining decision>,
"policyError": <optional error field>
}
```
NB: the `"policyError"` field above is only present if the denial was
triggered by an actual error in the Rego policy.
Signed-off-by: Matthew A Johnson <matjoh@microsoft.com>
anmaxvl
approved these changes
Apr 5, 2023
helsaawy
approved these changes
Apr 6, 2023
| if len(rawResult) == 0 { | ||
| return result, nil | ||
| return nil, errors.New("emtpy result from Rego query") |
There was a problem hiding this comment.
Is there any way to get context around why the rego query is empty or what to do about it?
|
|
||
| errorBytes, err := base64.RawURLEncoding.DecodeString(matches[1]) | ||
| if err != nil { | ||
| return "", err |
There was a problem hiding this comment.
Would it make sense to also return the policy decision error so that action can be taken despite the fact that it's not properly base64 encoded?
| } | ||
|
|
||
| if versionMissing { | ||
| return nil, errors.New(noAPIVersionError) |
There was a problem hiding this comment.
Rather than using errors.New here, if you make the error types exported and define the global variables with errors.New above, it would be possible in the future to use errors.Is to take different actions based on different issues and decouple from the exact wording in the error message.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 makes two major changes:
Whereas previously policy denial was surfaced as a text error message, the policy now generates a bracketed base64 encoded string:
policydecision< (base64) >policydecisionWhen decoded, this will be a JSON object with the following structure:
NB: the
"policyError"field above is only present if the denial was triggered by an actual error in the Rego policy.