Skip to content

Commit

Permalink
docs: add Flows section
Browse files Browse the repository at this point in the history
  • Loading branch information
andrea-dintino committed Dec 12, 2024
1 parent a501ebf commit 47b728c
Show file tree
Hide file tree
Showing 18 changed files with 153 additions and 21 deletions.
19 changes: 11 additions & 8 deletions docs/guides/Flows/flows.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,25 @@
---
title: 🧩 Flows
order: 10
title: Flows
order: 30
---

# Issuance and Verification Flows


# Parameters
Flows define the full behaviour of credential issuance and verification. While the Template define the Flow's core business logic, you define in the Flow parameters such as the duration of a credential, the cryptography and protocols to be used, the Microservices it should run on, as well as the data that is visible by the user (name, description, logo) as well as the machine-readable data used in the communication protocols (e.g. OpenID4VCI and OpenID4VP).

- **TLDR: what is actually Flow in DIDroom?**
> [!NOTE]
> Imagine a Flow as a shell of extra parameters that surround a template. Imagine that you are offering the same credentials, once with a 1 day expiration and once with a 1 month expiration: the templates used will typically be the same, while the Flow configurations will change.
# Provivionins and Microservices

## Parameters

# Flows
When editing the a Flow, you're editing several parameters, some of them are machine-readable, some are human readable, some have impact on the credentials that will be issued (*Cryptography* type and *Expiration*), some impact the deployment (the *Microservices* section).

| Dashboard Flow Editor |
|--|
| <img src="../images/dashboard/flow-editor.png" alt="dashboard-flow-editor" width="1000"/> |

# Toolchain


# Extendability

60 changes: 52 additions & 8 deletions docs/guides/Flows/microservices.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,66 @@
---
title: 🧩 Microservices
order: 30
title: Microservices
order: 40
---

# Basics
Credential Issuance and Verification are (partly) executed in Microservices. The Microservices are configured in the Dashboard, the Dashboard also provides you with the actuall Microservices code, with different deployment possibilities.


# Configuration
## Configuration

You can create a new Microservice or edit it, by giving it a *Name* and an *Endpoint*, the *Port* is initially selected randomly but can be edited.

# Protocols (OID4VCI & more)
| Microservices setup |
|--|
| <img src="../images/dashboard/microservices-setup.png" alt="microservices-setup" width="1000"/> |

## Deployment

# Parameters and presets
Once you are happy with the Templated and Flows you created, you can start deploying them. You that by:

1. Downloading the provisioned Microservices by pressing the *Dowload microservices* button.
1. Upload the download .zip to the server where the Microservices will deployed, which responds to the Endpoint you previously configured.
1. Use the docker-compose file (typically doing

# Toolchain
```bash
docker-compose up
```

----

# Extendability
See below the *Home > Organization > Microservices* page:


| Microservices list and Deployment |
|--|
| <img src="../images/dashboard/microservices-manual-deployment-small.png" alt="microservices-manual-deployment-small" width="1000"/> |



## Extendability

DIDroom Microservices are implemented and deployed using:


- NCR (no-code room): REST API server for Zencode scripts, single binary, doesn't require su privildges, includes OpenAPI and automagic GUI for REST APIs see

-> Repo: https://github.com/ForkbombEu/ncr

- DIDroom Microservices: OpenID4VCI and OpenID4VP compatible Microservices, highly customizable, implemented in Zencode (with some JS). This is where the server-side of new protocols and new cryptography is implemented.

-> Repo: https://github.com/ForkbombEu/DIDroom_microservices

- Ghisa: minimalist 0-security proxy, saves you from (some) CORS errors.

-> Repo: https://github.com/ForkbombEu/ghisa


- Zenroom: Cryptographic virtual machine, powers all (almost) the cryptogrphy in DIDroom. Ultra portable, runs on server/mobile/browser/IoT.

-> Repo: https://dev.zenroom.org/

- Slangroom: Extension to Zenroom, for networking, database, file management. See:

-> Repo: https://dyne.org/slangroom/


65 changes: 60 additions & 5 deletions docs/guides/Flows/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,72 @@ title: 🧩 Templates
order: 20
---

# Issuance and Verification Templates
Here we describe the Templates: here lives the customizable and re-usable business logic of Credential Issuance and verification

## Intro

# Business logic
- **What is a template?**
> [!IMPORTANT]
> Templates contain (re-usable) business logic for issuance and verification flow. Templates are scripted in *Zencode* executed by Zenroom and Slangroom, check the [🏗️ Core Technologies](/core-technologies) to know more.
- **Where and how do I use a template?**

Templates are used in *issuance Flows* and *Verification Flows*. When editing a flow, you can select the desired template from a dropdown.

# Parameters and presets
- **How do edit a template?**
Inside the Template editor, in the DIDroom Dashboard. If you want to test the code, you may want to use the [Slangroom editor](https://dyne.org/slangroom/) or [Apiroom](https://apiroom.net/).

- **Where are templates executed?**
Depending if it's an *Authorization*, *Issuance* or *Verification*, the templates are executed inside a Microservice, inside the Wallet or inside the Verifier App [more about this later].


# Toolchain
## Authorization, Issuance and Verification Templates

There are 3 types of Template, they are visible in *Organization > Home* and in the *Templates* section.


| Templates in *Organization > Home* |
|--|
| <img src="../images/dashboard/templates-list-small.png" alt="templates-list-small" width="500"/> |

| *Templates* section |
|--|
| <img src="../images/dashboard/templates-list-large.png" alt="templates-list-large" width="1000"/> |


## Parameters and presets

Based on the type, each Template has a different set of Parameters. Templates are typically built from **Presets**.

### Form structure

It define here the Parameters that Flow (using this Template) will receive as input, specifically,

-> **Authorization Template**: the parameters in the form will be input by the user in the Wallet app and processed by the *Authorization Server*.

-> **Issuance Template**: this time the parameters in the form will be passed by the *Authorization Server* and processed by the *Credential Issuer*.

-> **Verification Template**: the parameters in the form will be read inside the *Verifiable Presentation* produced by the *Wallet App* and processed by the *Verifier App*.

### Custom Code

This contains the core logic of the Template. The Custom code can:

- Read and process the input coming from the parameters in the "Form structure"
- Read and process parameters in the "Zencode data"
- Create and process data on the fly
- Return the processed data: some types of Template, have a certain return data format (e.g. Authorization Template must return a JSON object named "data") but each template can send the output to a REST API or write it into a Database. The parameters relevant to REST APIs and Parameters must be loaded from "Zencode data" (see Presets for examples).

| Templates Editor |
|--|
| <img src="../images/dashboard/template-editor-long.png" alt="template-editor" width="1000"/> |

## Toolchain

Templates are programmed in Zencode and Slangroom and can be tested in the Slangroom Editor, see: https://dyne.org/slangroom/

| Slangroom Editor |
|--|
|[![Slangroom-Editor](../images/dashboard/slangroom-editor.png)](https://dyne.org/slangroom/) |

# Extendability

File renamed without changes.
30 changes: 30 additions & 0 deletions docs/guides/Wallet/wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ The [Wallet App](https://github.com/ForkbombEu/wallet) is an Android/iOS mobile

The Wallet App allows the user to creat an account and the same account can be used to login onto the [DIDroom Dashboard](https://dashboard.didroom.com/).

| Wallet App screenshot |
|--|
| <img src="../images/wallet/wallet-android-credlist.jpg" alt="wallet-android-credlist" width="300"/> |





## Install the app

The app can be installed from the Android and iOS stores:
Expand All @@ -25,3 +33,25 @@ Once you login, you can:
- Scan a QR code to receive a credential
- Scan a QR code (from the Verifier App) to present a credential.


## Test on the web

The Wallet can also be deployed as a web application, offering most of the app functionalities and ideal for testing and debugging. You can deploy your own instance by following the [instructions](https://github.com/ForkbombEu/wallet?tab=readme-ov-file#installation) or test our (manually updated) web deployment at [wallet.didroom.com](https://wallet.didroom.com/).

| Wallet App deployed on web |
|--|
| <img src="../images/wallet/wallet-web.png" alt="wallet-web" width="1000"/> |


## White-labeling

The Wallet (and Verifier) App are built with white-labeling in mind>

1. The mobile apps take load ALL the UX from [didroom-copmponents](https://github.com/forkbombeu/didroom-components) which is packaged into [NPM
package](https://www.npmjs.com/package/@didroom/components) via CI.
1. The whole deployment of the mobile apps on the Android/iOS stores is done via CI,see for example the Android production deployment [CI script](https://github.com/ForkbombEu/wallet/actions/workflows/publish_on_production.yml).
1. See below DIDroom-components [Storybook](https://forkbombeu.github.io/didroom-components/?path=/docs/colors--docs).

| |
|--|
|[![Storybook](../images/wallet/didroom-components-storybook.png)](https://forkbombeu.github.io/didroom-components/) |
Binary file added docs/guides/images/dashboard/flow-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/images/dashboard/microservices.zip
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/images/dashboard/template-editor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/guides/images/wallet/wallet-web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 47b728c

Please sign in to comment.