-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ccc71d3
commit bb0d72f
Showing
23 changed files
with
255 additions
and
212 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| title: Acknowledgements | ||
| order: 10 | ||
| --- | ||
|
|
||
|
|
||
| # 🫶🏻 Acknowledgements | ||
|
|
||
| ## NGI Trustchain | ||
|
|
||
| Supported by [NGI TRUSTCHAIN](https://trustchain.ngi.eu/), which is made possible with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme. | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
|
|
||
| ## NGI Assure | ||
|
|
||
|
|
||
|
|
||
| Supported by [NGI ASSURE](https://nlnet.nl/assure/), operated by the [NLNet foundation](https://nlnet.nl/), which is made possible with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme. | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| --- | ||
| title: Concepts/Components | ||
| order: 1 | ||
| --- | ||
|
|
||
|
|
||
| # 📑 Concepts/Components | ||
|
|
||
|
|
||
| ## Issuance and Verification Flows | ||
|
|
||
| The flows contain the **general setup for the Issuance and Verification**, with focus on the parameters for a specific credential, such as name, description, logo, microservices issueing/verifying those. **The business logic and data structures** for the Issuance and Verification are **contained in templates**, which can be **selected inside the Issuance and Verification Flows**. The complexity within the protocols and cryptography and hidden behind the DIDroom Dashboard, the specs are in the pages [Issuance flow](./issuance.md) and [Verification flow](./verification.md). | ||
|
|
||
|
|
||
|
|
||
| ## Templates | ||
|
|
||
| they contain the business logic of *authorization*, *issuance* and *verification* flows along with the data structures used in the flows. An issuance flow contains two templates: | ||
| - The Authorization template (governs the business logic of the Authorization Server) | ||
| - The Issuance template (governs the business logic of the Credential Issuance) | ||
|
|
||
| The idea behind this separation, is **to allow the user mix and re-use templates in multiple credential issuance flows**. | ||
|
|
||
| The same template can be used in multiple flows, for example for a credential that has 3 different expiries (1 month, 6 months and 12 month). Or for example two Issuance Flows can use the same Authorization template (cause the Authorization process is the same for both) but two different issuance template (cause the Credential Issuer will need to write different data in the two credentials). | ||
|
|
||
| --------- | ||
|
|
||
| **Decentralized Identifier (DID)**: A globally unique, self-sovereign identifier that enables individuals and entities to have control over their digital identities without relying on centralized authorities. | ||
|
|
||
| **EUDI-ARF**: Acronym for "The European Digital Identity Wallet Architecture and Reference Framework," a technical core of the eIDAS 2.0 regulation that outlines standards for digital identity wallets. | ||
|
|
||
| **eIDAS 2.0 Regulation**: The updated version of the eIDAS (electronic Identification, Authentication and Trust Services) regulation that sets standards for electronic identification and trusted services within the European Union. | ||
|
|
||
| **Self-Sovereign Identity (SSI)**: A decentralized identity model that enables individuals to have full control over their digital identity and personal data. SSI allows users to manage and share verifiable credentials without the need for intermediaries. | ||
|
|
||
| **Verifiable Credentials (VC)**: Digital attestations that enable the issuance and verification of claims about a subject's identity, attributes, or qualifications. | ||
|
|
||
| **Wallet**: In the context of DidRoom, a software application or platform that allows users to manage their digital identities, store cryptographic keys, create and manage DIDs, and interact with blockchain networks and verifiable credentials. | ||
|
|
||
| **Zero-Knowledge Proofs**: Cryptographic methods that allow a party to prove knowledge of a certain value or statement without revealing the actual value itself. Zero-knowledge proofs enhance privacy and security by demonstrating knowledge without disclosing sensitive information. | ||
|
|
||
| **W3C-DID**: Abbreviation for "W3C Decentralized Identifier," a standard by the World Wide Web Consortium (W3C) for creating, managing, and resolving decentralized identifiers. | ||
|
|
||
| **W3C-VC**: Abbreviation for "W3C Verifiable Credentials," a standard by the World Wide Web Consortium (W3C) for creating and verifying digital credentials in a secure and interoperable manner. | ||
|
|
||
| **Zenroom**: A cryptographic virtual machine developed by Dyne.org Foundation, capable of performing various cryptographic operations and supporting blockchain interoperability. | ||
|
|
||
| **Zenswarm**: A blockchain oracle technology developed for blockchain interoperability and off-chain cryptography, utilizing Zenroom at its core. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,5 @@ | ||
| --- | ||
| title: Technology and Components | ||
| title: 🧩 Technology and Components | ||
| order: 60 | ||
| --- | ||
|
|
||
|
|
||
| # 📑 Concepts/Components | ||
|
|
||
|
|
||
| ## Issuance and Verification Flows | ||
|
|
||
| The flows contain the **general setup for the Issuance and Verification**, with focus on the parameters for a specific credential, such as name, description, logo, microservices issueing/verifying those. **The business logic and data structures** for the Issuance and Verification are **contained in templates**, which can be **selected inside the Issuance and Verification Flows**. The complexity within the protocols and cryptography and hidden behind the DIDroom Dashboard, the specs are in the pages [Issuance flow](./issuance.md) and [Verification flow](./verification.md). | ||
|
|
||
|
|
||
|
|
||
| ## Templates | ||
|
|
||
| they contain the business logic of *authorization*, *issuance* and *verification* flows along with the data structures used in the flows. An issuance flow contains two templates: | ||
| - The Authorization template (governs the business logic of the Authorization Server) | ||
| - The Issuance template (governs the business logic of the Credential Issuance) | ||
|
|
||
| The idea behind this separation, is **to allow the user mix and re-use templates in multiple credential issuance flows**. | ||
|
|
||
| The same template can be used in multiple flows, for example for a credential that has 3 different expiries (1 month, 6 months and 12 month). Or for example two Issuance Flows can use the same Authorization template (cause the Authorization process is the same for both) but two different issuance template (cause the Credential Issuer will need to write different data in the two credentials). | ||
|
|
||
| --------- | ||
|
|
||
| **Decentralized Identifier (DID)**: A globally unique, self-sovereign identifier that enables individuals and entities to have control over their digital identities without relying on centralized authorities. | ||
|
|
||
| **EUDI-ARF**: Acronym for "The European Digital Identity Wallet Architecture and Reference Framework," a technical core of the eIDAS 2.0 regulation that outlines standards for digital identity wallets. | ||
|
|
||
| **eIDAS 2.0 Regulation**: The updated version of the eIDAS (electronic Identification, Authentication and Trust Services) regulation that sets standards for electronic identification and trusted services within the European Union. | ||
|
|
||
| **Self-Sovereign Identity (SSI)**: A decentralized identity model that enables individuals to have full control over their digital identity and personal data. SSI allows users to manage and share verifiable credentials without the need for intermediaries. | ||
|
|
||
| **Verifiable Credentials (VC)**: Digital attestations that enable the issuance and verification of claims about a subject's identity, attributes, or qualifications. | ||
|
|
||
| **Wallet**: In the context of DidRoom, a software application or platform that allows users to manage their digital identities, store cryptographic keys, create and manage DIDs, and interact with blockchain networks and verifiable credentials. | ||
|
|
||
| **Zero-Knowledge Proofs**: Cryptographic methods that allow a party to prove knowledge of a certain value or statement without revealing the actual value itself. Zero-knowledge proofs enhance privacy and security by demonstrating knowledge without disclosing sensitive information. | ||
|
|
||
| **W3C-DID**: Abbreviation for "W3C Decentralized Identifier," a standard by the World Wide Web Consortium (W3C) for creating, managing, and resolving decentralized identifiers. | ||
|
|
||
| **W3C-VC**: Abbreviation for "W3C Verifiable Credentials," a standard by the World Wide Web Consortium (W3C) for creating and verifying digital credentials in a secure and interoperable manner. | ||
|
|
||
| **Zenroom**: A cryptographic virtual machine developed by Dyne.org Foundation, capable of performing various cryptographic operations and supporting blockchain interoperability. | ||
|
|
||
| **Zenswarm**: A blockchain oracle technology developed for blockchain interoperability and off-chain cryptography, utilizing Zenroom at its core. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| --- | ||
| order: 1 | ||
| title: DIDroom Dashboard | ||
| --- | ||
| # 👩⚖️ DIDroom Dashboard | ||
|
|
||
| Welcome, System Administrator! This guide provides step-by-step instructions for oversee the configuration and management of decentralized identity solutions within their organizations. Here you'll find instructions on how to use the Dashboard to configure settings, monitor your issuance flows, and access key functionalities. | ||
|
|
||
| ## Create an organization | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_organization.webm" /> | ||
|
|
||
| ## Setup a credential issuer metadata | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_credential_issuer.webm" /> | ||
|
|
||
| ## Setup an authorization server metadata | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_authz_server.webm" /> | ||
|
|
||
| ## Create a fully working credential issuing flow | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/issuance_flow.webm" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,4 @@ | ||
| --- | ||
| order: 30 | ||
| title: 👩⚖️ DIDroom Dashboard | ||
| title: 👩⚖️ Issuance and Organization | ||
| --- | ||
| # 👩⚖️ DIDroom Dashboard | ||
|
|
||
| Welcome, System Administrator! This guide provides step-by-step instructions for oversee the configuration and management of decentralized identity solutions within their organizations. Here you'll find instructions on how to use the Dashboard to configure settings, monitor your issuance flows, and access key functionalities. | ||
|
|
||
| ## Create an organization | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_organization.webm" /> | ||
|
|
||
| ## Setup a credential issuer metadata | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_credential_issuer.webm" /> | ||
|
|
||
| ## Setup an authorization server metadata | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/create_authz_server.webm" /> | ||
|
|
||
| ## Create a fully working credential issuing flow | ||
|
|
||
| <video controls="controls" src="https://github.com/ForkbombEu/signroom/raw/main/screenshots/videos/issuance_flow.webm" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,65 +2,3 @@ | |
| title: Pricing | ||
| order: 90 | ||
| --- | ||
|
|
||
| # 🫱🏽🫲🏿 Pricing 🫱🏾🫲🏼 | ||
|
|
||
| ## Pricing Tables | ||
|
|
||
| Our pricing table. For a quick description of the different items, see below. | ||
|
|
||
| | | **Free** | **Pro** | **Enterprise** | | ||
| |--|--|--|--| | ||
| |<span style="color:blue">Organizations</span> | 1 | 1 | Unlimited | | ||
| |<span style="color:blue">Issuance flows</span> | 1 | 5 | Unlimited | | ||
| |<span style="color:blue">Verification flows</span> | 1 | 5 | Unlimited | | ||
| |<span style="color:blue">Public credentials</span> | No | No | Yes | | ||
| |Microservices Deployment | Manual | Manual, Auto | Manual, Auto, CI | | ||
| |Control Room | SaaS | SaaS | SaaS, on premises | | ||
| |<span style="color:red">Admin Dashboard</span> | No | No | On premises | | ||
| |<span style="color:red">Credential customization Support</span> | No | Github | Training, Support, Customization | | ||
| |<span style="color:red">White labeling</span> | No | No | Yes | | ||
| |<span style="color:red">W3C-DID service</span> | SaaS | SaaS | SaaS, on premises, customizable | | ||
| |**Price** | **Free!** | **99 €/month**| [Call Sales](mailto:[email protected]) | | ||
|
|
||
|
|
||
|
|
||
| ## Feature description | ||
|
|
||
| Below a description of the individual features. | ||
|
|
||
| ### Organizations | ||
| - Description: an Organization contains users, Credential Issuance and Verification, and Microservices setup. | ||
| - Info: [create Organization](../Orgadmin/create) | ||
|
|
||
| ### Issuance flows and Verification flows | ||
| - Description: Credential Issuance and Verification flows define what a Credential contains, how it is issued and how it is verified. Issuance and Verification are operated by Microservices. | ||
| - Info: [Create an Issuance Flow](../Orgadmin/issuance_flow) and [Create a Verification Flow](../Verifier/verification_flow) | ||
|
|
||
| ### Microservices Deployment | ||
|
|
||
| - Description: Microservices operate Credential Issuance and Verification. The Wallet and Verifier apps exchange information with the Microservices. | ||
| - Info: [Deploy Microservices](../Sysadmin/deploy_microservices) | ||
|
|
||
| ### Control Room | ||
| - Description: the DIDroom Dashboard is the main web application to setup Organizations, users, Credential Issuance and Verification Flows and Microservices. | ||
| - Info: [DIDroom Dashboard](../Orgadmin/index) | ||
|
|
||
| ### Admin Dashboard | ||
| - Description: the DIDroom Admin Dashboard is the backend of the whole DIDroom ecosystem. It is based on [Starters SaaS](https://github.com/dyne/starters) which itself is powered by [Pocketbase](https://github.com/pocketbase/pocketbase) | ||
| - Info: [System Administrator](../Sysadmin/) | ||
|
|
||
| ### Public credentials | ||
| - Description: this feature allows you to have your credential Issuance flow visible by anyone who installs the DIDroom Wallet and Verifier app. The Wallet users can request the credentials by clicking on the credential from the Wallet's home. | ||
|
|
||
| ### Credential customization Support | ||
| - Description: the Credential Authorization, Issuance and Verification, can be customised, for example to read the credential's data from an external database or to perform Authorization on a 3rd party service. Customization is implemented on our Online IDE [Apiroom](https://apiroom.net/) using [Zenroom](https://dev.zenroom.org/) and [Slangroom](https://dyne.org/slangroom/). | ||
| - Info: we offer custom development and training for the customization | ||
|
|
||
| ### White labeling | ||
| - Description: the [Wallet app](https://github.com/forkbombEu/wallet), the [Verifier App](https://github.com/forkbombEu/verifier) and the [DIDroom Dashboard](https://github.com/ForkbombEu/signroom/tree/main/webapp) are white-label friendly. White-labeling is performed using [DIDroom-Components](https://github.com/ForkbombEu/didroom-components) and the [Playbook](https://forkbombeu.github.io/didroom-components/). | ||
| - Info: we offer support for white-labeling and custom development | ||
|
|
||
| ### W3C-DID service | ||
| - Description: DIDroom uses Dyne.org's W3C-DID [implementation](https://github.com/dyne/w3c-did) and [service](https://explorer.did.dyne.org/). | ||
| - Info: we offer support for deployment and custom development of W3C-DID services. | ||
Oops, something went wrong.