Skip to content
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

docs: add decision record about the use of iron-verifiable-credentials #472

Merged
merged 1 commit into from
Jun 14, 2023
Merged

docs: add decision record about the use of iron-verifiable-credentials #472

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: 22 additions & 0 deletions docs/development/decision-records/2023-06-13_use_of_iron_library/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Usage of `iron-verifiable-credentials`

## Decision

Tractus-X EDC will use the [iron-verifiable-credentials](https://github.com/filip26/iron-verifiable-credentials) library
for all processing of VerifiableCredentials and VerifiablePresentations.

## Rationale

The Eclipse Dataspaces Components project uses iron's sister
library, [titanium-json-ld](https://github.com/filip26/titanium-json-ld/) for processing JSON-LD, which achieves close
to 100% of conformance with the JSON-LD specification.

It thus stands to reason that we use `iron-verifiable-credentials`, because it supports issuing/verifying VCs/VPs, has
support for JSON-LD (internally it also uses `titanium-json-ld`) and otherwise has a very light dependency footprint.
which means high runtime type compatibility can be expected and minimal mapping/compatibility layers are needed. Crypto
suites are pluggable, so in addition to `iron-ed25519-cryptosuite-2020`, which is also provided, we will implement
support for `JsonWebKey2020` which was mandated by the Catena-X consortium.

## Approach

- add support for `JsonWebKey2020` to Tractus-X EDC using `iron-verifiable-credentials`.