Skip to content

Commit 95ea2bd

Browse files
yshyn-iohkyshyn-iohk
authored
docs: add specification list, fixed #198 (#213)
docs: add specifications.md Signed-off-by: Yurii Shynbuiev <[email protected]>
1 parent fd74e12 commit 95ea2bd

File tree

2 files changed

+127
-70
lines changed

2 files changed

+127
-70
lines changed

‎documentation/home/identus/specifications.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Specifications
2+
3+
## Legend
4+
5+
- ✅ - Supported
6+
- ❌ - Not supported
7+
- 🚫 - Not applicable
8+
- 🔄 - In progress
9+
- ❓ - Not sure
10+
- 🚧 - Under construction
11+
12+
## Mediator
13+
14+
| | Specification | Purpose |
15+
|----|----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
16+
| ✅ | [DIDComm Messaging v2.x Editor's Draft](https://identity.foundation/didcomm-messaging/spec/) | The core DIDCommV2 specification |
17+
| ✅ | [Peer DID 1.0](https://identity.foundation/peer-did-method-spec/) | ❓Peer DID specification, did:peer:2 is currently used |
18+
| ✅ | [BasicMessage 2.0](https://didcomm.org/basicmessage/2.0) | The BasicMessage protocol describes a stateless, easy to support user message protocol |
19+
| ✅ | [Coordinate Mediation 2.0](https://didcomm.org/coordinate-mediation/2.0/) | The protocol to coordinate mediation configuration between a mediating agent and the recipient |
20+
| 🚧 | [Coordinate Mediation 3.0](https://didcomm.org/coordinate-mediation/3.0/) *(TODO)* | The protocol to coordinate mediation configuration between a mediating agent and the recipient |
21+
| ✅ | [Message Pickup 3.0](https://didcomm.org/messagepickup/3.0/) | The protocol to facilitate an agent picking up messages held at a mediator |
22+
| ✅ | [Trust Ping 2.0](https://didcomm.org/trust-ping/2.0/) | The trust-ping protocol defined in the DIDComm Messaging Spec. This enables the sender and recipient to engage in an exchange of trust pings |
23+
| ✅ | [Report Problem 2.0](https://didcomm.org/report-problem/2.0/) | The Report Problem protocol is defined in the DIDComm Messaging Spec. This protocol describes sending a problem report to another party |
24+
25+
## Cloud Agent (CA) and SDKs TypeScript(TS)/Swift(SW)/Kotlin Multiplatform(KM)
26+
27+
| CA | TS | SW | KM | Specification | Purpose |
28+
|----|----|----|----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
29+
| ✅ | ✅ | ✅ | ✅ | [Decentralized Identifiers (DIDs) v1.0](https://www.w3.org/TR/did-1.0/) | Core specification for DIDs |
30+
| ✅ | ✅ | ✅ | ✅ | [PRISM DID Method Specification - did:prism](https://github.com/input-output-hk/prism-did-method-spec/blob/main/w3c-spec/PRISM-method.md) | PRISM DID Method specification |
31+
| ✅ | ✅ | ✅ | ✅ | [Peer DID 1.0](https://identity.foundation/peer-did-method-spec/) | ❓Peer DID specification, did:peer:2 is currently used |
32+
| ✅ | ✅ | ✅ | ✅ | [Verifiable Credentials JSON Schema Specification](https://www.w3.org/TR/vc-json-schema/) | JSON Schemas for Verifiable Credentials |
33+
| ✅ | ✅ | ✅ | ✅ | [Securing Verifiable Credentials using JOSE and COSE](https://www.w3.org/TR/vc-jose-cose/) | Core specification for VC-JWT |
34+
| ✅ | ✅ | ✅ | ✅ | [JSON Object Signing and Encryption (JOSE)](https://www.iana.org/assignments/jose/jose.xhtml) | JOSE registry of headers, curves, keys, signature and encryption algorithms |
35+
| ✅ | ❌ | ❌ | ❌ | [Selective Disclosure for JWTs (SD-JWT)](https://datatracker.ietf.org/doc/draft-ietf-oauth-selective-disclosure-jwt/07/) | Core specification for SD-JWT (not SD-JWT-VC). Outdated, the latest is v14 |
36+
| ❌ | ✅ | ✅ | ✅ | [SD-JWT-based Verifiable Credentials (SD-JWT VC)](https://datatracker.ietf.org/doc/draft-ietf-oauth-sd-jwt-vc/) | Core specification for SD-JWT (not SD-JWT-VC). Outdated, the latest is v14 |
37+
| ✅ | ✅ | ✅ | ✅ | [AnonCreds Specification v1.0](https://hyperledger.github.io/anoncreds-spec/) | Core specification for AnonCreds |
38+
| ✅ | ✅ | ✅ | ✅ | [DID:PRISM AnonCreds Method](https://hyperledger.github.io/anoncreds-methods-registry/#didprism-anoncreds-method) | DID:PRISM AnonCreds Method for Schema and Credential Definition |
39+
| ✅ | ✅ | ✅ | ✅ | [HTTP AnonCreds Method](https://hyperledger.github.io/anoncreds-methods-registry/#http-anoncreds-method) | HTTP AnonCreds Method for Schema and Credential Definition |
40+
| ✅ | ✅ | ✅ | ✅ | [Bitstring Status List v1.0](https://www.w3.org/TR/vc-bitstring-status-list/) | Core specification for VC-JWT |
41+
| ❌ | ❓ | ❓ | ❓ | [DIF Presentation Exchange 2.x.x](https://identity.foundation/presentation-exchange) | DIF Presentation Exchange protocol |
42+
| ✅ | ✅️ | ✅️ | ✅️ | [Out of Band Protocol 2.0](https://identity.foundation/didcomm-messaging/spec/#out-of-band-messages) | Out of Band messages for DIDComm (part of DIDCommV2 specification) | |
43+
| ✅ | 🚫 | 🚫 | 🚫 | [Coordinate Mediation Protocol 2.0](https://didcomm.org/coordinate-mediation/2.0/) | Coordinate Mediation Protocol for DIDCommV2 |
44+
| ✅ | ✅️ | ✅️ | ✅️ | [Connection Protocol 1.0](https://github.com/hyperledger-identus/cloud-agent/blob/main/mercury/protocol-connection/Connection-Protocol.md) | The protocol is used when you wish to create a connection with another agent |
45+
| ✅ | ❓️ | ❓️ | ❓️ | [Aries RFC 0023: DID Exchange v1](https://github.com/hyperledger/aries-rfcs/tree/main/features/0023-did-exchange) | The protocol to exchange DIDs between agents when establishing a DID based relationship |
46+
| ✅ | ❓️ | ❓️ | ❓️ | [Aries RFC 0434: Out-of-Band Protocol 1.1](https://github.com/hyperledger/aries-rfcs/blob/main/features/0434-outofband/README.md), same as<br/> [DIDCommV2 Invitation 1.0](https://identity.foundation/didcomm-messaging/spec/#invitation) | Out-of-Band Protocol for DIDComm (part of DIDCommV2 specification) |
47+
| ✅ | 🚫 | 🚫 | 🚫 | [Trust Ping Protocol 2.0](https://didcomm.org/trust-ping/2.0/) | The protocol is a standard way for agents to test connectivity, responsiveness, and security of a DIDComm channel |
48+
| ✅ | 🚫 | 🚫 | 🚫 | [Routing Protocol 2.0](https://identity.foundation/didcomm-messaging/spec/#routing-protocol-20) | The routing protocol defines how a sender and a recipient cooperate, using a partly trusted mediator, to facilitate message delivery |
49+
| ✅ | ✅ | ✅ | ✅ | [Issue Credential Protocol 3.0](https://github.com/decentralized-identity/waci-presentation-exchange/blob/main/issue_credential/README.md) | DIDCommV2 Issue Credential Protocol 3.0 for VC-JWT, AnonCreds and SD-JWT |
50+
| ✅ | ✅ | ✅ | ✅ | [Present Proof Protocol 3.0](https://github.com/decentralized-identity/waci-didcomm/blob/main/present_proof/present-proof-v3.md) | DIDCommV2 Present Proof Protocol 3.0 for VC-JWT, AnonCreds and SD-JWT |
51+
| ✅ | ✅ | ✅ | ✅ | [Identus Revocation Notification Protocol 1.0](https://github.com/hyperledger-identus/cloud-agent/blob/main/mercury/protocol-revocation-notification/Revocation-notification-protocol.md) | The protocol for an Issuer to notify the revocation of a credential to the holder. |
52+
| ✅ | ✅ | ✅ | ✅ | [Aries RFC 0035: Report Problem Protocol 1.0](https://github.com/hyperledger/aries-rfcs/blob/main/features/0035-report-problem/README.md) | Report Problem Protocol for DIDCommV2 |
53+
| 🔄 | 🔄 | 🔄 | 🔄 | [OpenID for Verifiable Credential Issuance - draft 15](https://openid.net/specs/openid-4-verifiable-credential-issuance-1_0.html) | OpenID Connect for VC Issuance (VC-JWT is supported only). Client side. |
54+
| 🔄 | 🔄 | 🔄 | 🚧 | [OpenID for Verifiable Credential Presentation - draft 15](https://openid.net/specs/openid-4-verifiable-credential-presentation-1_0.html) | OpenID Connect for VC Presentation (VC-JWT is supported only). Client side. |
55+
56+

‎documentation/home/sidebars.js‎

Lines changed: 71 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -13,82 +13,83 @@
1313

1414
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
1515
const sidebars = {
16-
// By default, Docusaurus generates a sidebar from the docs folder structure
17-
//tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
16+
// By default, Docusaurus generates a sidebar from the docs folder structure
17+
//tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
1818

19-
// But you can create a sidebar manually
19+
// But you can create a sidebar manually
2020

21-
docsSidebar: [
22-
{
23-
type: 'doc',
24-
id: 'README', // document ID
25-
label: 'Getting Started', // sidebar label
26-
},
27-
"quick-start",
28-
{
29-
type: "category",
30-
label: "Concepts",
31-
collapsed: false,
32-
link: {
33-
type: "generated-index",
34-
title: "Concepts",
35-
description: "Learn about the most important SSI concepts!",
36-
},
37-
items: [
38-
"concepts/identity",
39-
"concepts/multi-tenancy",
40-
],
41-
},
42-
{
43-
type: "category",
44-
label: "Identus",
45-
link: {
46-
type: "generated-index",
47-
title: "Identus",
48-
description: "Learn about the Identus ecosystem!",
49-
},
50-
collapsed: false,
51-
items: [
52-
"identus/overview",
21+
docsSidebar: [
5322
{
54-
type: "category",
55-
label: "Cloud Agent",
56-
collapsed: true,
57-
link: {
58-
type: "generated-index",
59-
title: "Cloud Agent",
60-
description: "Learn about the Identus Cloud Agent!",
61-
},
62-
items: [
63-
"identus/cloud-agent/overview",
64-
"identus/cloud-agent/building-blocks",
65-
"identus/cloud-agent/authentication",
66-
"identus/cloud-agent/did-management",
67-
"identus/cloud-agent/secrets-storage",
68-
"identus/cloud-agent/environment-variables",
69-
],
23+
type: 'doc',
24+
id: 'README', // document ID
25+
label: 'Getting Started', // sidebar label
7026
},
27+
"quick-start",
7128
{
72-
type: "category",
73-
label: "Prism Node",
74-
collapsed: true,
75-
link: {
76-
type: "generated-index",
77-
title: "Prism Node",
78-
description: "Learn about the Identus Prism Node!",
79-
},
80-
items: [
81-
"identus/prism-node/overview",
82-
"identus/prism-node/running-node",
83-
],
29+
type: "category",
30+
label: "Concepts",
31+
collapsed: false,
32+
link: {
33+
type: "generated-index",
34+
title: "Concepts",
35+
description: "Learn about the most important SSI concepts!",
36+
},
37+
items: [
38+
"concepts/identity",
39+
"concepts/multi-tenancy",
40+
],
8441
},
85-
"identus/mediator",
86-
"identus/troubleshooting&considerations",
87-
"identus/getting-help",
88-
],
89-
},
90-
"concepts/glossary",
91-
],
42+
{
43+
type: "category",
44+
label: "Identus",
45+
link: {
46+
type: "generated-index",
47+
title: "Identus",
48+
description: "Learn about the Identus ecosystem!",
49+
},
50+
collapsed: false,
51+
items: [
52+
"identus/overview",
53+
{
54+
type: "category",
55+
label: "Cloud Agent",
56+
collapsed: true,
57+
link: {
58+
type: "generated-index",
59+
title: "Cloud Agent",
60+
description: "Learn about the Identus Cloud Agent!",
61+
},
62+
items: [
63+
"identus/cloud-agent/overview",
64+
"identus/cloud-agent/building-blocks",
65+
"identus/cloud-agent/authentication",
66+
"identus/cloud-agent/did-management",
67+
"identus/cloud-agent/secrets-storage",
68+
"identus/cloud-agent/environment-variables",
69+
],
70+
},
71+
{
72+
type: "category",
73+
label: "Prism Node",
74+
collapsed: true,
75+
link: {
76+
type: "generated-index",
77+
title: "Prism Node",
78+
description: "Learn about the Identus Prism Node!",
79+
},
80+
items: [
81+
"identus/prism-node/overview",
82+
"identus/prism-node/running-node",
83+
],
84+
},
85+
"identus/mediator",
86+
"identus/troubleshooting&considerations",
87+
"identus/getting-help",
88+
],
89+
},
90+
"concepts/glossary",
91+
"identus/specifications"
92+
],
9293
};
9394

9495
module.exports = sidebars;

0 commit comments

Comments
 (0)