Skip to content

Commit

Permalink
Fixed README Admonitions
Browse files Browse the repository at this point in the history
Signed-off-by: Felix Hoops <9974641+jfelixh@users.noreply.github.com>
  • Loading branch information
jfelixh authored Jun 15, 2024
1 parent 631b36f commit bb238ef
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@
![jest workflow](https://github.com/GAIA-X4PLC-AAD/ssi-to-oidc-bridge/actions/workflows/node.js.yml/badge.svg)
![playwright workflow](https://github.com/GAIA-X4PLC-AAD/ssi-to-oidc-bridge/actions/workflows/playwright.yml/badge.svg)

> [!WARNING] This repository is intended for prototyping and as a reference
> [!WARNING]
> This repository is intended for prototyping and as a reference
> implementation. At this time, no security guarantees can be given.
> [!NOTE] A preprint of our paper providing more background information is
> [!NOTE]
> A preprint of our paper providing more background information is
> available [on arXiv](https://arxiv.org/abs/2401.09488). While it is slightly
> outdated now, it provides a good introduction.
> [!NOTE] This software artifact was originally intended to support only Gaia-X
> [!NOTE]
> This software artifact was originally intended to support only Gaia-X
> Participant Credentials. It has since evolved to be fully configurable for
> almost any Verifiable Credential, almost any wallet application, and almost
> any current OIDC client.
Expand Down Expand Up @@ -148,7 +151,8 @@ prototyping an OIDC client service you are developing. Note that running a full
deployment requires the same steps, but instead of using a tool like `ngrok`, a
proper domain has to be set up.

> [!IMPORTANT] You need to use a tool like ngrok for testing so your smartphone
> [!IMPORTANT]
> You need to use a tool like ngrok for testing so your smartphone
> wallet can access the vclogin backend. However, it can lead to issues with
> `application/x-www-form-urlencoded` request bodies used in the flow
> (<https://ngrok.com/docs/ngrok-agent/changelog/#changes-in-22>). But you can
Expand All @@ -174,7 +178,8 @@ proper domain has to be set up.

To validate the running bridge with a simple OIDC client:

> [!NOTE] You might run into a "Permisson denied" issue when running the shell
> [!NOTE]
> You might run into a "Permisson denied" issue when running the shell
> script `./test_client.sh`. You need to mark the file as executable using
> `chmod +x ./test_client.sh`.
Expand All @@ -191,7 +196,8 @@ To validate the running bridge with a simple OIDC client:
9. end up at `http://localhost:9010/callback` with metadata about the login
being displayed

> [!TIP] If you want to understand what the wallet is doing in the exchange, go
> [!TIP]
> If you want to understand what the wallet is doing in the exchange, go
> to settings and toggle on "Developer Mode". After scanning a QR code, the
> wallet will now give you the option to see or save the interaction data. If
> you just want to continue the sign-in, tap "skip".
Expand Down

0 comments on commit bb238ef

Please sign in to comment.