Conditions :: Cerbos Authorization Management Platform // Documentation
Conditions
| This documentation is for a previous version of Cerbos. Choose 0.53.0 from the version picker at the top right or navigate to https://docs.cerbos.dev for the latest version. |
A powerful feature of Cerbos policies is the ability to define conditions that are evaluated against the data provided in the request. Conditions are written using the Common Expression Language (CEL).
Cerbos ships with an interactive REPL that can be used to experiment with writing CEL conditions. It can be started by running cerbos repl. See the REPL documentation for more information. |
Every condition expression must evaluate to a boolean true/false value. A condition block in a policy can contain either a single condition expression, or multiple expressions combined using the all, any, or none operators. These logical operators may be nested.
Condition block
condition:
match:
all:
of:
- expr: request.resource.attr.status == "PENDING_APPROVAL"
- expr: >
"GB" in request.resource.attr.geographies
Top-level identifiers
Within a condition expression, you have access to several top-level identifiers:
request
Data provided in the check or plan request (principal, resource, and auxiliary data).
runtime
Additional data computed while evaluating the policy.
variables
Variables declared in the variables section of the policy.
globals
Global variables declared in the policy engine configuration.
There are also single-letter aliases available to allow you to write terser expressions:
P
request.principal
R
request.resource
V
variables
G
globals
The request object
request:
principal: (1)
id: alice (2)
roles: (3)
- employee
attr: (4)
geography: GB
resource: (5)
kind: leave_request (6)
id: XX125 (7)
attr: (8)
owner: alice
auxData: (9)
jwt: (10)
iss: acme.corp
| 1 | The principal whose permissions are being checked. |
| 2 | ID of the principal. |
| 3 | Static roles that are assigned to the principal by your identity management system. |
| 4 | Free-form context data about the principal. |
| 5 | The resource on which the principal is performing actions. |
| 6 | Resource kind. |
| 7 | ID of the resource instance. |
| 8 | Free-form context data about the resource instance. |
| 9 | Auxiliary data sources. |
| 10 | JWT claims. |
The runtime object
runtime:
effectiveDerivedRoles: (1)
- owner
- gb_employee
| 1 | Derived roles that were assigned to to the principal by Cerbos while evaluating the policy. This is only populated in expressions in resource policies, and only includes derived roles that are referenced in at least one policy rule. |
Expressions and blocks
Single boolean expression
condition:
match:
expr: P.id.matches("^dev_.*")
Operators
| Operator | Description |
|---|---|
! |
Logical negation (NOT) |
- |
Subtraction/numeric negation |
!= |
Unequals |
% |
Modulo |
&& |
Logical AND |
| ` | |
* |
Multiplication |
+ |
Addition/concatenation |
/ |
Division |
⇐ |
Less than or equal to |
< |
Less than |
== |
Equals |
>= |
Greater than or equal to |
> |
Greater than |
in |
Membership in lists or maps |
? : |
Ternary condition (if-then-else) |
Policy variables
To avoid duplication in condition expressions, you can define variables in policies.
Accessing JWT claims
"cerbie" in request.auxData.jwt.aud && request.auxData.jwt.iss == "cerbos"
Durations
| Suffix | Unit |
|---|---|
ns |
Nanoseconds |
us |
Microseconds |
ms |
Milliseconds |
s |
Seconds |
m |
Minutes |
h |
Hours |
Timestamps
...
"resource": {
"kind": "leave_request",
"attr": {
"lastAccessed": "2021-04-20T10:00:20.021-05:00",
"lastUpdateTime": "2021-05-01T13:34:12.024Z",
}
}
...