Skip to content

feat: add section on policies #11

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.

Sign up for GitHub

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 1 commit into from
Jan 15, 2025
Merged

feat: add section on policies #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion best.practices/interoperability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ The normative JSON schemas are very permissive. Adding `additionalProperties` is
the requirements of JSON-LD. Dataspaces are encouraged to define normative JSON schemas extending the list of required
and optional properties from the DSP JSON schemas.

## Policies

The Dataspace Protocol `Offer` is a JSON object reusing properties from the Open Digital Rights Language (ODRL).
`Offer`s contain `Constraint`s that signify a boolean operation: They consist of three components
- `leftOperand`: This is (by definition in the JSON-LD context) a IRI that must either be fully qualified in the payload
or implicitly namespaced by an additional entry in the `@context` object.
- `operator`: This is a reference to the ODRL-IRI of boolean operator used to evaluate a constraint.
- `rightOperand`: Right operands are literals (usually strings) that describe the target value of the Constraint.

`Constraint`s will usually be evaluated against data that is out-of-band from the `Policy` object. For instance, a
policy engine may evaluate a constraint based on a specific claim about the Data Consumer obtained via a Verifiable
Presentation. Which `Constraints` are satisfied by which credentials is Dataspace-specific and requires conventions.
These conventions are codified in **Credential-Constraint-Profiles**. Such a profile should define
1. a set of terms that are valid for `leftOperand`, `operator` and `rightOperand` in the context of the profile.
Together they constitute the set of supported `Constraints`.
2. validation mechanisms for each `Constraint` and the required side-effects to execute the specified mechanism. This
may include inspecting an authorization token or querying a remote service.

## Additional Properties on Datasets

To allow a Data Consumer to negotiate only for relevant `odrl:Set`s, a Data Provider should attach meaningful
Expand All @@ -13,7 +31,7 @@ predetermined property.

## Participant Identification

Various DSP messages include an identifier for the participants, like `providerId`, `consumerId` and `participantId`.
Various DSP messages include an identifier for the participants, like `assigner`, `assignee` and `participantId`.
Dataspaces may have conventions for these properties, for instance as regexes.

## Filtering
Expand Down Expand Up @@ -118,3 +136,5 @@ For a pull transfer, this property should be bound to the advertised `format` fo
]
}
```