-
Notifications
You must be signed in to change notification settings - Fork 164
Node.js: clarify instance-based auth #2761
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
Draft
sjvans
wants to merge
4
commits into
main
Choose a base branch
from
instance-based
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+40
−10
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -257,14 +257,22 @@ Here, users can read and write orders they've created, and `Auditor` users can r | |
|
|
||
| Restrictions can be defined on different types of CDS resources, but there are some limitations with regards to supported privileges: | ||
|
|
||
| | CDS Resource | `grant` | `to` | `where` | Remark | | ||
| |-----------------|:-------:|:----:|:-----------------:|---------------| | ||
| | service | <Na/> | <Y/> | <Na/> | = `@requires` | | ||
| | entity | <Y/> | <Y/> | <Y/><sup>1</sup> | | | ||
| | action/function | <Na/> | <Y/> | <Na/><sup>2</sup> | = `@requires` | | ||
|
|
||
| > <sup>1</sup>For bound actions and functions that are not bound against a collection, Node.js supports instance-based authorization at the entity level. For example, you can use `where` clauses that *contain references to the model*, such as `where: CreatedBy = $user`. For all bound actions and functions, Node.js supports simple static expressions at the entity level that *don't have any reference to the model*, such as `where: $user.level = 2`. | ||
| > <sup>2</sup> For unbound actions and functions, Node.js supports simple static expressions that *don't have any reference to the model*, such as `where: $user.level = 2`. | ||
| | CDS Resource | `grant` | `to` | `where` | Remark | | ||
| |-----------------------|:-------:|:----:|:-----------------:|---------------| | ||
| | service | <Na/> | <Y/> | <Na/> | = `@requires` | | ||
| | entity | <Y/> | <Y/> | <Y/> | | | ||
| | bound action/function | <Na/> | <Y/> | <Na/><sup>1</sup> | = `@requires` | | ||
| | action/function | <Na/> | <Y/> | <Na/><sup>2</sup> | = `@requires` | | ||
|
|
||
| > <sup>1</sup> For [bound actions and functions](../../cds/cdl#bound-actions) that *are not bound to a collection of instances*, Node.js supports instance-based authorization. | ||
| > Example: | ||
| > ```cds | ||
| > entity Orders @(restrict: [ | ||
| > { grant: 'cancel', where: (CreatedBy = $user) }, | ||
| > ]) {/*...*/} | ||
| > ``` | ||
|
|
||
| > <sup>2</sup> For (unbound) actions and functions, Node.js supports simple static expressions that *don't have any reference to the model*, such as `where: $user.level = 2`. | ||
|
|
||
| Unsupported privilege properties are ignored by the runtime. Especially, for bound or unbound actions, the `grant` property is implicitly removed (assuming `grant: '*'` instead). The same also holds for functions: | ||
|
|
||
|
|
@@ -314,7 +322,7 @@ The resulting authorizations are illustrated in the following access matrix: | |
| | `CustomerService.Orders` (*) | <X/> | <Y/><sup>1</sup> | <X/> | <X/> | | ||
| | `CustomerService.monthlyBalance` | <Y/> | <X/> | <X/> | <X/> | | ||
|
|
||
| > <sup>1</sup> A `Vendor` user can only access the instances that they created. <br> | ||
| > <sup>1</sup> A `Customer` user can only access the instances that they created. <br> | ||
|
|
||
| The example models access rules for different roles in the same service. In general, this is _not recommended_ due to the high complexity. See [best practices](#dedicated-services) for information about how to avoid this. | ||
|
|
||
|
|
@@ -442,12 +450,18 @@ This means that, the condition applies to following standard CDS events only: | |
|
|
||
| <div class="impl java"> | ||
|
|
||
| In addition, the runtime [checks the filter condition of the input data](#input-data-auth) for following standard CDS events: | ||
| In addition, the Java runtime [checks the filter condition of the input data](#input-data-auth) for following standard CDS events: | ||
| - `CREATE` (input filter) | ||
| - `UPDATE` (input filer) | ||
|
|
||
| </div> | ||
|
|
||
| <div class="impl node"> | ||
|
|
||
| In addition, for `CREATE` as well as unbound actions and functions, the Node.js runtime supports simple static expressions that *don't have any reference to the model*, such as `where: $user.level = 2`. | ||
|
|
||
| </div> | ||
|
|
||
| You can define filter conditions in the `where`-clause of restrictions based on [CQL](/cds/cql)-predicates, declared as [compiler expressions](../../cds/cdl#expressions-as-annotation-values): | ||
|
|
||
| * Predicates with arithmetic operators. | ||
|
|
@@ -609,6 +623,7 @@ Paths on 1:n associations (`Association to many`) evaluate to `true`, _if the co | |
|
|
||
| <div class="impl java"> | ||
|
|
||
| // TODO: Node.js does not support his? | ||
| <div id="exists-subquery" /> | ||
|
|
||
| </div> | ||
|
|
@@ -633,6 +648,21 @@ Starting with CAP Java `4.0`, deep authorization is active by default. | |
| It can be disabled by setting <Config java>cds.security.authorization.instanceBased.checkInputData: false</Config>. | ||
|
|
||
|
|
||
| ### Simple Static Checks { #simple-static-checks .node} | ||
|
|
||
| Most instance-based [`@restrict.where`](#restrict-annotation) conditions reference business data (for example, `where: 'createdBy = $user'`) and can only be enforced against persisted data — pushed into the query for `READ`, or verified with a `COUNT` for `UPDATE`/`DELETE`. | ||
|
|
||
| Some conditions, though, reduce to a plain comparison of literals once [user attributes](#user-attrs) are resolved: | ||
|
|
||
| ```cds | ||
| entity Reviews @(restrict: [ | ||
| { grant: 'CREATE', where: '$user.level >= 2' } ]); | ||
| ``` | ||
|
|
||
| For a user with `level = 3`, this becomes `3 >= 2`, which the runtime evaluates in memory — granting or rejecting with `403` without any database access. Such _simple static checks_ apply to `CREATE` (and its draft variant `NEW`) and to unbound actions and functions, where there's no persisted instance to query. They're only recognized for a single binary comparison (`=`, `!=`, `<`, `<=`, `>`, `>=`) with no reference to entity elements. | ||
|
|
||
|
|
||
| //> TODO: Node.js? | ||
| ### Rejected Entity Selection { #reject-403 .java} | ||
|
Comment on lines
+665
to
666
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Node.js? |
||
|
|
||
| Entities that have an instance-based authorization condition, that is [`@restrict.where`](/guides/security/authorization#restrict-annotation), | ||
|
|
||
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.
Node.js?