Skip to content

Commit 42e569b

Browse files
leifjleifj
committed
Simplify VCTM registry page
- Clarify registry.siros.org is publication/storage, not resolution - Reference go-wallet-backend for resolution implementation - Remove incorrect configuration examples and URL details - Direct readers to registry.siros.org for details
1 parent 12c96f7 commit 42e569b

File tree

1 file changed

+14
-161
lines changed

1 file changed

+14
-161
lines changed

‎docs/sirosid/vctm-registry.md‎

Lines changed: 14 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -4,175 +4,28 @@ sidebar_position: 4
44

55
# VCTM Registry
66

7-
The SIROS Foundation maintains a public registry of Verifiable Credential Type Metadata (VCTM) at **[registry.siros.org](https://registry.siros.org)**.
7+
The SIROS Foundation maintains a public registry for publishing Verifiable Credential Type Metadata (VCTM) at **[registry.siros.org](https://registry.siros.org)**.
88

9-
## What is VCTM?
10-
11-
Verifiable Credential Type Metadata (VCTM) files define credential schemas, display properties, and claim definitions. When an issuer issues a credential, the VCTM tells wallets and verifiers:
12-
13-
- What claims the credential contains
14-
- How to display the credential to users
15-
- What the VCT (Verifiable Credential Type) identifier is
16-
- Localized labels and descriptions
17-
18-
## Registry Overview
19-
20-
The SIROS VCTM Registry aggregates and publishes VCTM files from multiple organizations, providing:
21-
22-
- **Stable URLs** for VCTM references
23-
- **Organization-based namespacing**
24-
- **Automatic aggregation** from source repositories
25-
- **Consistent SIROS branding**
26-
27-
## URL Structure
28-
29-
VCTMs are accessible at:
30-
31-
```
32-
https://registry.siros.org/<organization>/<vctm-name>.json
33-
```
34-
35-
**Examples:**
36-
37-
| URL | Description |
38-
|-----|-------------|
39-
| `https://registry.siros.org/sirosfoundation/pid.json` | SIROS Foundation PID credential |
40-
| `https://registry.siros.org/sirosfoundation/ehic.json` | SIROS Foundation EHIC credential |
41-
42-
## Using the Registry
43-
44-
### In Issuer Configuration
45-
46-
Reference VCTM files from the registry in your issuer configuration:
47-
48-
```yaml
49-
credential_constructor:
50-
pid:
51-
vct: "urn:eudi:pid:arf-1.8:1"
52-
vctm_url: "https://registry.siros.org/sirosfoundation/pid-arf-1.8.json"
53-
# Or use a local copy
54-
vctm_file_path: "/metadata/vctm_pid.json"
55-
format: "dc+sd-jwt"
56-
auth_method: basic
57-
```
58-
59-
### Fetching VCTM
9+
## Purpose
6010

61-
```bash
62-
# Download a VCTM file
63-
curl -o vctm_pid.json https://registry.siros.org/sirosfoundation/pid.json
64-
```
11+
The registry provides a publication platform for organizations to share their VCTM files. It serves as:
6512

66-
## Publishing to the Registry
13+
- **A storage backend** for VCTM files organized by organization
14+
- **A publication point** where credential type metadata can be discovered
15+
- **An aggregation service** that collects VCTMs from multiple sources
6716

68-
Organizations can publish their own VCTMs to the registry.
17+
:::note Important Distinction
18+
The registry is a publication mechanism, not a VCTM resolution service. VCTM resolution (looking up credential type metadata by VCT identifier) is implemented separately. See the [go-wallet-backend](https://github.com/sirosfoundation/go-wallet-backend) for a reference implementation that can use registry.siros.org as a backend.
19+
:::
6920

70-
### Requirements
71-
72-
1. Use the [mtcvctm](https://github.com/sirosfoundation/mtcvctm) GitHub Action
73-
2. Publish VCTMs to a `vctm` branch in your repository
74-
3. Include a `.well-known/vctm-registry.json` manifest
75-
76-
### Setup with GitHub Actions
77-
78-
```yaml
79-
# .github/workflows/publish-vctm.yml
80-
name: Publish VCTM
81-
82-
on:
83-
push:
84-
branches: [main]
85-
paths:
86-
- 'metadata/*.json'
87-
88-
jobs:
89-
publish:
90-
runs-on: ubuntu-latest
91-
steps:
92-
- uses: actions/checkout@v4
93-
- uses: sirosfoundation/mtcvctm@v1
94-
with:
95-
vctm-directory: metadata/
96-
```
97-
98-
### Registry Manifest
99-
100-
The `vctm` branch must contain `.well-known/vctm-registry.json`:
101-
102-
```json
103-
{
104-
"organization": "your-org",
105-
"vctms": [
106-
{
107-
"name": "my-credential",
108-
"file": "my-credential.json",
109-
"vct": "urn:example:my-credential:1"
110-
}
111-
]
112-
}
113-
```
114-
115-
## VCTM File Structure
116-
117-
A VCTM file follows the [IETF SD-JWT VC specification](https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/):
118-
119-
```json
120-
{
121-
"vct": "urn:eudi:pid:arf-1.8:1",
122-
"name": "Person Identification Data",
123-
"description": "EU Person Identification Data credential",
124-
"display": [
125-
{
126-
"lang": "en-US",
127-
"name": "PID",
128-
"description": "Personal identification credential",
129-
"rendering": {
130-
"simple": {
131-
"background_color": "#12107c",
132-
"text_color": "#ffffff",
133-
"logo": {
134-
"uri": "https://example.org/logo.png",
135-
"alt_text": "Organization Logo"
136-
}
137-
}
138-
}
139-
}
140-
],
141-
"claims": [
142-
{
143-
"path": ["given_name"],
144-
"display": [
145-
{"lang": "en-US", "label": "First Name"}
146-
],
147-
"sd": "allowed"
148-
},
149-
{
150-
"path": ["family_name"],
151-
"display": [
152-
{"lang": "en-US", "label": "Last Name"}
153-
],
154-
"sd": "allowed"
155-
}
156-
]
157-
}
158-
```
159-
160-
## Official SIROS VCTMs
161-
162-
The following VCTMs are maintained by the SIROS Foundation:
21+
## What is VCTM?
16322

164-
| Credential | VCT | Registry URL |
165-
|------------|-----|--------------|
166-
| **PID (ARF 1.5)** | `urn:eudi:pid:arf-1.5:1` | [pid-arf-1.5.json](https://registry.siros.org/sirosfoundation/pid-arf-1.5.json) |
167-
| **PID (ARF 1.8)** | `urn:eudi:pid:arf-1.8:1` | [pid-arf-1.8.json](https://registry.siros.org/sirosfoundation/pid-arf-1.8.json) |
168-
| **EHIC** | `urn:eudi:ehic:1` | [ehic.json](https://registry.siros.org/sirosfoundation/ehic.json) |
169-
| **PDA1** | `urn:eudi:pda1:1` | [pda1.json](https://registry.siros.org/sirosfoundation/pda1.json) |
170-
| **Diploma** | `urn:eudi:diploma:1` | [diploma.json](https://registry.siros.org/sirosfoundation/diploma.json) |
171-
| **ELM** | `urn:eudi:elm:1` | [elm.json](https://registry.siros.org/sirosfoundation/elm.json) |
23+
Verifiable Credential Type Metadata (VCTM) files define how credentials should be displayed and what claims they contain. They follow the [IETF SD-JWT VC specification](https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/).
17224

17325
## Resources
17426

17527
- **Registry Website**: [registry.siros.org](https://registry.siros.org)
17628
- **Source Repository**: [github.com/sirosfoundation/registry.siros.org](https://github.com/sirosfoundation/registry.siros.org)
177-
- **VCTM Action**: [github.com/sirosfoundation/mtcvctm](https://github.com/sirosfoundation/mtcvctm)
178-
- **IETF SD-JWT VC Draft**: [draft-ietf-oauth-sd-jwt-vc](https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/)
29+
- **VCTM Publishing Action**: [github.com/sirosfoundation/mtcvctm](https://github.com/sirosfoundation/mtcvctm)
30+
31+
Visit [registry.siros.org](https://registry.siros.org) for details on available VCTMs and how to publish your own.

0 commit comments

Comments
 (0)