-
Notifications
You must be signed in to change notification settings - Fork 1
feat: add obligations #150
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 1 commit
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
771b0ac
add obligation doc
alkalescent b2fa2d1
gemini suggestion
alkalescent 4c41516
npm run update-vendored-yaml
alkalescent 867dbfc
suggestions
alkalescent f77bf40
Update docs/components/policy/obligations.md
alkalescent bc7649d
Update docs/components/policy/obligations.md
alkalescent 9474d41
Update docs/components/policy/obligations.md
alkalescent a93d361
Update docs/components/policy/obligations.md
alkalescent 3a221e3
add triggers
alkalescent 3d81327
Update docs/components/policy/obligations.md
alkalescent 1739b6a
clarify that pep is optional w explanation of global obl and update d…
alkalescent 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 |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| # Obligations | ||
|
|
||
| Obligations are policy constructs that enable conditional access enforcement at the Policy Enforcement Point (PEP) level. They define additional restrictions and requirements beyond basic attribute-based access control (ABAC), allowing security administrators to enforce conditions such as multi-factor authentication (MFA), watermarking, encryption, or time-based access controls. | ||
|
|
||
alkalescent marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ## Composition | ||
|
|
||
| An obligation consists of three parts: | ||
|
|
||
| 1. A Namespace | ||
| 2. A Definition | ||
| 3. A Value | ||
|
|
||
| Platform Policy Obligations can contain multiple Namespaces, each with multiple Definitions, and each Definition can have multiple Values. | ||
|
Check failure on line 13 in docs/components/policy/obligations.md
|
||
|
|
||
| ```mermaid | ||
| graph LR; | ||
alkalescent marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Namespace_A-->Definition_A; | ||
| Definition_A-->Value_A; | ||
| Definition_A-->Value_B; | ||
|
|
||
| Namespace_A-->Definition_B; | ||
| Definition_B-->Value_C; | ||
| Definition_B-->Value_D; | ||
| ``` | ||
|
|
||
| ## Obligation Types | ||
|
|
||
| There are two types of obligations supported by the platform: | ||
|
|
||
| ### Standard Obligations | ||
|
|
||
| Standard Obligations are enforced by the Access PDP (Policy Decision Point) when validating whether an Entity of a specified Category can perform an Action on a given Resource. These obligations must be satisfied for access to be granted. | ||
alkalescent marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| A Standard Obligation includes: | ||
| - **Entity Category**: The type of entity (SUBJECT or ENVIRONMENT) that must satisfy this obligation | ||
alkalescent marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - **Action**: The specific action being performed (READ, STORE, CREATE, UPDATE, DELETE) | ||
| - **Resource Attribute Value**: The data attribute for which this obligation is scoped | ||
| - **Obligation Value**: The required obligation value that must be satisfied | ||
|
|
||
| #### Examples of Standard Obligations: | ||
|
|
||
| **Watermarking Requirement** | ||
| - All HIPAA documents must be watermarked on read | ||
| - Entity Category: ENVIRONMENT (watermarking must be supported by the client) | ||
| - Action: READ | ||
| - Resource: `https://example.com/attr/classification/value/hipaa` | ||
| - Obligation Value: `https://example.com/obl/drm/value/watermarking` | ||
|
|
||
| **Age Verification for Content** | ||
| - Movies rated R should only be read by users 17+ | ||
| - Entity Category: SUBJECT (a person must meet the obligation criteria) | ||
| - Action: READ | ||
| - Resource: `https://example.com/attr/rating/value/r` | ||
| - Obligation Value: `https://example.com/obl/age/value/17+` | ||
|
|
||
| ### Handling Obligations [UNIMPLEMENTED] | ||
|
|
||
| Handling Obligations define conditions where an Entity can perform an action on a specified Resource because the Resource can be handled differently if the calling PEP enforces additional obligations. The Access PDP performs what is effectively a "Drop/Add" operation for authorization purposes. | ||
|
|
||
| A Handling Obligation includes: | ||
| - **Entity Category**: The type of entity that must satisfy this obligation | ||
| - **Action**: The specific action being performed | ||
| - **Resource Attribute Value**: The data attribute to be "dropped" for authorization | ||
| - **Obligation Value**: The required obligation value | ||
| - **Obligation Attribute Value**: The attribute value to be "added" for authorization | ||
|
|
||
| #### Example of Handling Obligations: | ||
|
|
||
| **Transmit as Confidential with Encryption** | ||
| Allow transmission of top secret data to networks entitled with confidential classification or above, with the additional obligation to encrypt the data using FIPS 140-2. | ||
|
|
||
| - Entity Category: ENVIRONMENT | ||
| - Action: STORE | ||
| - Resource Attribute Value: `https://example.com/attr/classification/value/topsecret` (Drop) | ||
| - Obligation Value: `https://example.com/obl/encryption/value/fips-140-2` | ||
| - Obligation Attribute Value: `https://example.com/attr/classification/value/confidential` (Add) | ||
|
|
||
| ## FQN (Fully Qualified Name) Convention | ||
|
Check failure on line 78 in docs/components/policy/obligations.md
|
||
|
|
||
| Obligations use a specific naming convention to distinguish them from attributes: | ||
|
|
||
| - **Obligation Definition**: `<namespace>/obl/<obligation_name>` | ||
| - **Obligation Value**: `<namespace>/obl/<obligation_name>/value/<obligation_value>` | ||
|
|
||
| For example: | ||
| - `https://example.com/obl/drm` (definition) | ||
| - `https://example.com/obl/drm/value/watermarking` (value) | ||
|
|
||
| ## Common Use Cases | ||
|
|
||
| ### Multi-Factor Authentication (MFA) | ||
| Require additional authentication for sensitive data access: | ||
| ``` | ||
| Obligation: https://example.com/obl/auth/value/mfa | ||
| Applied to: TOP SECRET classified documents | ||
| Condition: Subject entity must complete MFA before READ access | ||
| ``` | ||
|
|
||
| ### Geographic Restrictions | ||
| Control access based on location: | ||
| ``` | ||
| Obligation: https://example.com/obl/location/value/usa | ||
| Applied to: Classified documents | ||
| Condition: Environment entity must be within approved geographic boundaries | ||
| ``` | ||
|
|
||
| ### Time-Based Access (Burn After Reading) | ||
| Implement expiration policies: | ||
| ``` | ||
| Obligation: https://example.com/obl/expiration/value/24hr | ||
| Applied to: Project-specific documents | ||
| Condition: Access expires 24 hours after first READ action | ||
| ``` | ||
|
|
||
| ### Document Watermarking | ||
| Ensure document traceability: | ||
| ``` | ||
| Obligation: https://example.com/obl/drm/value/user-watermark | ||
| Applied to: Sensitive documents | ||
| Condition: Environment must apply user identification watermark on READ | ||
| ``` | ||
alkalescent marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
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.
Uh oh!
There was an error while loading. Please reload this page.