-
Notifications
You must be signed in to change notification settings - Fork 7
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
Showing
1 changed file
with
7 additions
and
9 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 |
|---|---|---|
|
|
@@ -7,8 +7,8 @@ | |
|
|
||
| # Overview | ||
|
|
||
| This project holds the standard FIDO2 api endpoints and the Proof of Knowledge for Algorand specific private keys. | ||
| The api is a stateful session-based architecture with endpoint guards. | ||
| This project holds the standard FIDO2 api endpoints and the Proof of Knowledge for Algorand specific private keys. | ||
| The api is a stateful session-based architecture with endpoint guards. | ||
| A user must prove ownership of a private key to associate PublicKeyCredentials | ||
|
|
||
| ## Getting started | ||
|
|
@@ -23,15 +23,11 @@ A user must prove ownership of a private key to associate PublicKeyCredentials | |
| git clone [email protected]:algorandfoundation/liquid-auth.git && cd liquid-auth | ||
| ``` | ||
|
|
||
| #### Install package dependencies | ||
|
|
||
| WebAuthn requires a secure context (HTTPS) to work and this will not allow you to test the FIDO2 feature in your local machine. | ||
|
|
||
| ### NGROK | ||
|
|
||
| Sign up for a free account at [ngrok](https://ngrok.com/) and install the ngrok package. | ||
| Configure a Static Domain for your ngrok account and update the [.env](services/liquid-auth-api-js/README.md) file with the following keys with the values from ngrok: | ||
| WebAuthn requires a secure context (HTTPS) to work and this will not allow you to test the FIDO2 feature in your local machine. | ||
|
|
||
| Sign up for a free account at [ngrok](https://ngrok.com/) and configure a static domain for your account. | ||
|
|
||
| #### Configure NGROK | ||
|
|
||
|
|
@@ -52,6 +48,8 @@ tunnels: | |
|
|
||
| #### Update the Service's .docker.env file | ||
|
|
||
| Update the [.docekr.env](.env.docker) file with the following keys with the values from ngrok: | ||
|
|
||
| ```bash | ||
| HOSTNAME=<NGROK_STATIC_DOMAIN> | ||
| ORIGIN=https://<NGROK_STATIC_DOMAIN> | ||
|
|
@@ -70,7 +68,7 @@ Navigate to the ngrok URL in your browser to test the FIDO2 feature. | |
|
|
||
| ## Using the app | ||
|
|
||
| #### Install the [Android client](https://github.com/awesome-algorand/android-authentication-client) to your device. | ||
| #### Install the [Android client](https://github.com/awesome-algorand/android-authentication-client/releases) to your device. | ||
|
|
||
|  | ||
|
|
||
|
|
||