Kagi
Kagi provides support for FIDO WebAuthn security keys and TOTP tokens in Django.
Kagi is a relatively young project and has not yet been fully battle-tested. Its use in a high-impact environment should be accompanied by a thorough understanding of how it works before relying on it.
Installation
python -m pip install kagi
Add kagi to INSTALLED_APPS and include kagi.urls somewhere in your URL patterns. Set: LOGIN_URL = "kagi:login"
Make sure that Django’s built-in login view does not have a urlpattern, because it will authenticate users without their second factor. Kagi provides its own login view to handle that.
Demo
To see a demo, use the test project included in this repository and perform the following steps (creating and activating a virtual environment first is optional).
First, install Poetry:
curl -sSL https://install.python-poetry.org/ | python -
Clone the Kagi source code and switch to its directory:
git clone https://github.com/justinmayer/kagi.git && cd kagi
Install dependencies, run database migrations, create a user, and serve the demo:
poetry install poetry shell invoke migrate python testproj/manage.py createsuperuser invoke serve
You should now be able to see the demo project login page in your browser at: http://localhost:8000/kagi/login
Supported browsers and versions can be found here: https://caniuse.com/webauthn For domains other than localhost, WebAuthn requires that the site is served over a secure (HTTPS) connection.
Since you haven’t added any security keys yet, you will be logged in with just a username and password. Once logged in and on the multi-factor settings page, choose “Manage WebAuthn keys” and then “Add another key” and follow the provided instructions. Once WebAuthn and/or TOTP has been successfully configured, your account will be protected by multi-factor authentication, and when you log in the next time, your WebAuthn key or TOTP token will be required.
You can manage the keys attached to your account on the key management page at: http://localhost:8000/kagi/keys
Using WebAuthn Keys on Linux
Some distros don’t come with udev rules to make USB HID /dev/ nodes accessible to normal users. If your key doesn’t light up and start flashing when you expect it to, this might be what is happening. See https://github.com/Yubico/libu2f-host/issues/2 and https://github.com/Yubico/libu2f-host/blob/master/70-u2f.rules for some discussion of the rule to make it accessible. If you just want a quick temporary fix, you can run sudo chmod 666 /dev/hidraw* every time after you plug in your key (the files disappear after unplugging).
Gratitude
This project would not exist without the significant contributions made by Rémy HUBSCHER.
Thanks to Gavin Wahl for django-u2f, which served as useful initial scaffolding for this project.
Release files for kagi 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| kagi-0.4.0.tar.gz | 26.4 kB | Without provenance | Details for kagi-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| kagi-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for kagi-0.4.0-py3-none-any.whl |
Total release size: 62.3 kB
Release files / kagi-0.4.0.tar.gz
| Download URL | kagi-0.4.0.tar.gz |
|---|---|
| Size | 26.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1530e7de0b9b3522d77ea41e1069b6497f04c19063061a57d26a2f9ce2561061
|
|
BLAKE2b-256 checksum How to use checksums |
43942391f343d905522d5317c2ed4d23e38a79b26f9dcacdde86349455bdd6d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.11
|
Release files / kagi-0.4.0-py3-none-any.whl
| Download URL | kagi-0.4.0-py3-none-any.whl |
|---|---|
| Size | 35.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3b184d871246b754e168cd08a9ab9cfb4dc45bbfb039e05c6691e092b94e4e2e
|
|
BLAKE2b-256 checksum How to use checksums |
b18c0ad8b13921ad5597a22f9abc589e85ee37705587d58bd3a86abb3411ce5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.11
|
Security for kagi 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
