Rego template endpoint #96
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
wcalderipe
approved these changes
Feb 7, 2024
apps/authz/src/app/http/rest/dto/policy-criterion-builder.dto.ts
Outdated
Show resolved
Hide resolved
| @@ -84,4 +87,10 @@ export class AdminService { | |||
|
|
|||
| return payload.request.data | |||
| } | |||
|
|
|||
| async setPolicyRules(payload: SetPolicyRulesRequest): Promise<PolicyCriterionBuilder[]> { | |||
| await this.opaService.generateRegoFile(payload.request.data) | |||
There was a problem hiding this comment.
Do you plan to save these policies in the database as well, no?
There was a problem hiding this comment.
yes but not on the engine part. see this discussion:
https://narvalxyz.slack.com/archives/C067Q1TDA9G/p1707310563319479
Comment on lines
37
to
94
| generateRegoFile(policies: PolicyCriterionBuilder[]): void { | ||
| Handlebars.registerHelper('criterion', function (item) { | ||
| const criterion: Criterion = item.criterion | ||
| const args = item.args | ||
|
|
||
| if (args === null) { | ||
| return `${criterion}` | ||
| } | ||
|
|
||
| if (!isEmpty(args)) { | ||
| if (Array.isArray(args)) { | ||
| if (typeof args[0] === 'string') { | ||
| return `${criterion}({${args.map((el) => `"${el}"`).join(', ')}})` | ||
| } | ||
|
|
||
| if (criterion === Criterion.CHECK_APPROVALS) { | ||
| return `approvals = ${criterion}([${args.map((el) => JSON.stringify(el)).join(', ')}])` | ||
| } | ||
|
|
||
| return `${criterion}([${args.map((el) => JSON.stringify(el)).join(', ')}])` | ||
| } | ||
|
|
||
| return `${criterion}(${JSON.stringify(args)})` | ||
| } | ||
| }) | ||
|
|
||
| Handlebars.registerHelper('reason', function (item) { | ||
| if (item.then === Then.PERMIT) { | ||
| const reason = [ | ||
| `"type": "${item.then}"`, | ||
| `"policyId": "${item.name}"`, | ||
| '"approvalsSatisfied": approvals.approvalsSatisfied', | ||
| '"approvalsMissing": approvals.approvalsMissing' | ||
| ] | ||
| return `reason = {${reason.join(', ')}}` | ||
| } | ||
|
|
||
| if (item.then === Then.FORBID) { | ||
| const reason = { | ||
| type: item.then, | ||
| policyId: item.name, | ||
| approvalsSatisfied: [], | ||
| approvalsMissing: [] | ||
| } | ||
| return `reason = ${JSON.stringify(reason)}` | ||
| } | ||
| }) | ||
|
|
||
| const templateSource = readFileSync('./apps/authz/src/opa/template/template.hbs', 'utf-8') | ||
|
|
||
| const template = Handlebars.compile(templateSource) | ||
|
|
||
| const regoContent = template({ policies }) | ||
|
|
||
| writeFileSync(`./apps/authz/src/opa/rego/generated/${uuidv4()}.rego`, regoContent, 'utf-8') | ||
|
|
||
| console.log('Policy .rego file generated successfully.') | ||
| } |
There was a problem hiding this comment.
Here's a suggestion on how to unit test this logic:
- Separate side effects from policy generation logic. If you move the template file reading and Rego file writing elsewhere, the logic essentially becomes: given a policy schema and a template string, you produce a policy string on the other side (the Rego logic).
- Unit test each criterion defined in
policy-build.type.ts. For a given template and criterion A, specify what you expect as a policy. Do this without merging criteria into a single policy. This approach will provide comprehensive documentation of what you expect for smaller system components. - Unit test a few criteria together to generate a policy and check if the outcome matches your expectations. This will provide us confidence on criteria composition.
There was a problem hiding this comment.
These types of logic to map from standard A to B are often a major source of bugs. Let's get that covered so we can move faster without breaking things 😉
wcalderipe
reviewed
Feb 9, 2024
packages/authz-shared/src/lib/decorators/is-account-id.decorator.ts
Outdated
Show resolved
Hide resolved
packages/authz-shared/src/lib/decorators/is-asset-id.decorator.ts
Outdated
Show resolved
Hide resolved
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.
No description provided.