Skip to content

Commit

Permalink
docs(vc-api): key & did & proof types (#178)
Browse files Browse the repository at this point in the history
* docs: add vc-api supported key types

* docs: add vc-api supported did methods

* docs: add vc-api supported proof types
  • Loading branch information
jrhender authored Sep 14, 2023
1 parent 6fdc7b0 commit e217744
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions apps/vc-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,45 @@ In particular, there are several endpoints related to exchanges that are outside
| Presenting | Submit Submission Review | No |
| Presenting | Create Presentation from Credentials | No |

#### Supported Proof Types for Proof Generation

The proof types supported during Proof generation (e.g. issuance and presentation) are listed below.
Currently only [Data Integrity (JSON-LD)](https://www.w3.org/TR/vc-data-model/#data-integrity-proofs) proofs are supported.
The "Related DID" is mentioned because the verification method used to generate the proof is selected from the `issuer` property for VCs or `holder` property for VPs.

The following proof types are supported:

| Proof Type | Related DID | Test Status
| --- | --- | ---
| Ed25519Signature2018 | did:key | Covered by automated tests
| EcdsaSecp256k1Signature2019 | did:ethr | Not yet covered by automated tests

### DID Module

The DID Module in the [vc-api](./) offers the generation of DIDs and tracking the data resolvable in their DID documents.

#### Supported DID Methods

The table below shows which DID methods are available.

| DID Method | Notes
| --- | ---
| key | Only Ed25519 (with `Ed25519VerificationKey2018` verification method)
| ethr | Only implicit DID resolution. No chain data resolution supported

### Key Module
The key module is kept separate from the DID module because it's plausible that key module will be provided by a different service (i.e. a dedicated KMS) at some point.

#### Supported Key Types

The table below shows which key types are available for each operation.

| Operations | Key Type
| --- | ---
| Import | Ed25519
| Generate | Ed25519, ES256K
| Export | Any key stored

#### Key Import/Export

The key module allows for the import and export of key pairs.
Expand Down

0 comments on commit e217744

Please sign in to comment.