Developing

django-allauth-webauthn make heavy use of the poetry Python packaging and dependency manager and the pre-commit framework.

After you forked (and branched) django-allauth-webauthn please install all development dependencies with poetry:

$ poetry install

poetry will install all needed development dependencies in a virtual environment for you. Afterwards install the pre-commit hooks by running:

$ poetry run pre-commit install

The pre-commit hooks will be executed automatically prior committing to the Git repository. There are hooks for source code styling (e.g. import reordering) and it is ensured that all tests may be executed successfully and that no obvious type checking issues are included.

To execute these hooks manually (i.e. without performing a commit) execute the following:

$ poetry run pre-commit run --all-files

Testing

Tests can be run using the standard Django testing facility by executing:

$ poetry run python manage.py test

Coverage

During test execution a coverage report can be created with:

$ poetry run coverage run manage.py test

To view the coverage report on the command line you have to execute:

$ poetry run coverage report -m

or you can generate an HTML report for more eye candy:

$ poetry run coverage html

The resulting HTML report will be stored in the coverage_html folder.

Demo Project

A simple demo Django project is included within the demo folder and may be run by:

$ cd demo
# Migrate the demo database first (only needed once)
$ poetry run python manage.py migrate
# Run the SSL demo server (a self-signed certificate and private key is created during first run)
$ poetry run python manage.py runserver_plus --cert test.crt

The demo app allows you to register security tokens to a logged in user. If a user has at least a single security token registered, she will be asked to authenticate with this token during sign in. Security tokens may be renamed or deleted. All in one, it demonstrates the basic workflow for webauthn-based two-factor authentication.