Skip to content

Commit 987547d

Browse files
authored
OID4VC Update to README.md (#2341)
Add notes on how to use the status list plugin with the oid4vc plugin Signed-off-by: timbl-ont <[email protected]>
1 parent 3245a7b commit 987547d

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

oid4vc/README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,53 @@ Now you have a `UniversityCredential` in your Sphereon Wallet. To demonstrate th
6363

6464
As mentioned, the demo automatically takes care of a lot of the setup calls necessary to prepare credential definitions, presentation requests, and so forth. You can see what calls are being made, and with what values, both in the container logs and on the page.
6565

66+
67+
### Integrating the Status List Plugin
68+
69+
Documentation for the [Status List Plugin] (https://github.com/openwallet-foundation/acapy-plugins/blob/main/status_list/README.md)
70+
71+
1. Configuring the plugin:
72+
73+
Command Line: *--plugin status_list.v1_0*
74+
75+
Example Configuration:
76+
```
77+
OID4VCI_STATUS_HANDLER: status_list.v1_0.status_handler
78+
STATUS_LIST_SIZE: 131072
79+
STATUS_LIST_SHARD_SIZE: 131072
80+
STATUS_LIST_PUBLIC_URI: https://localhost:8082/tenant/{tenant_id}/status/{list_number}
81+
STATUS_LIST_FILE_PATH: /tmp/bitstring/{tenant_id}/{list_number}
82+
```
83+
3. Binding a status list to a *supported_cred_id*:
84+
85+
Once bound all credentials issued with the given supported_cred_id will include a status list entry - either w3c or ietf
86+
87+
API Call - *POST .../status-list/defs*
88+
89+
Example JSON Body (list_type can be either "w3c" or "ietf"):
90+
```
91+
{
92+
"issuer_did": "did....",
93+
"list_size": 131072,
94+
"list_type": "ietf",
95+
"shard_size": 1024,
96+
"status_message": [
97+
{
98+
"status": "0x00",
99+
"message": "active"
100+
},
101+
{
102+
"status": "0x01",
103+
"message": "revoked"
104+
},
105+
],
106+
"status_purpose": "revocation",
107+
"status_size": 1,
108+
"supported_cred_id": "string",
109+
"verification_method": "did...."
110+
}
111+
```
112+
66113
### Note
67114

68115
In a production environment, the described processes would be more dynamic and involve additional security measures. This demo provides a streamlined representation for clarity and ease of understanding.

0 commit comments

Comments
 (0)