martinord/debauthn repository overview

⁠

A WebAuthn Authenticator Debugging Tool

⁠Prerequisites

• A MongoDB server: a docker instance or mongod.
• A TLS setup. All requests need to use TLS (HTTPS).
• NodeJS (v10 or v12 recommended).

⁠Start

There is a deployment script that helps with all steps. Run ./deploy.sh --help for more information. A MongoDB should be running (check the configuration files at src/config).

Then run:

./deploy.sh --all

⁠Docker deployment

⁠Local build

This deployment would deploy with docker-compose the MongoDB and DebAuthn. First, review the configuration at docker-compose.yml. Then, run:

./deploy.sh --docker

⁠Public build

You can also use the built image available at Docker Hub⁠. For deplying, use this docker-compose.yml⁠ instead.

git clone https://gist.github.com/c76bd20a336782b5c9343bb4456703d0.git
cd c76bd20a336782b5c9343bb4456703d0/
docker-compose up -d

⁠Setting up TLS

In production, it is recommended to use a server like NGINX with TLS that forwards the petitions to DebAuthn.

For development purposes, you can generate self-signed TLS certificates:

mkdir tls
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout tls/private.key -out tls/certificate.crt

Also set TLS=true as an environment variable when running the project.

⁠Dependencies: adding functionality

Apply patches to the dependencies for adding functionality:

npm run postinstall