Skip to main content

Django app for WebAuthn and TOTP-based multi-factor authentication

Project description

https://circleci.com/gh/justinmayer/kagi.svg?style=svg

Kagi provides support for FIDO WebAuthn security keys and TOTP tokens in Django.

Kagi is a working proof-of-concept and isn’t yet production ready. There are many TODOs sprinkled around the code that should be fixed before relying on it.

Installation

$ 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 the repo and perform the following steps (using a virtual environment is optional):

git clone https://github.com/justinmayer/kagi
cd kagi
make install
make serve

cd testproj
python manage.py migrate
python manage.py createsuperuser

Supported browsers and versions can be found here: https://caniuse.com/webauthn WebAuthn also requires that the site is served over a secure (HTTPS) connection.

Start by going to https://localhost:8000/kagi/login. Since you haven’t added any security keys yet, you will be logged in with just a username and password.

Once logged in, click “Add another key” on the key management page and follow the instructions. Now your account is protected by multi-factor authentication, and when you log in again your WebAuthn key or TOTP token will be required.

You can manage the keys attached to your account on the key management page as well, at the URL https://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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kagi-0.1.0.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

kagi-0.1.0-py3-none-any.whl (34.5 kB view details)

Uploaded Python 3

File details

Details for the file kagi-0.1.0.tar.gz.

File metadata

  • Download URL: kagi-0.1.0.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.4 Darwin/17.7.0

File hashes

Hashes for kagi-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ce2b64c76bd9e38a231b016182680de12cd503d2a06227b97484897471d5a15e
MD5 1410ece8790d4ed6e5dca0a8a26e26fa
BLAKE2b-256 cd5f1c62349ce3c139338c742581c2a5f979d0f4d3121a23b4b8f9f7a9b007fb

See more details on using hashes here.

File details

Details for the file kagi-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: kagi-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 34.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/0.12.17 CPython/3.7.4 Darwin/17.7.0

File hashes

Hashes for kagi-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b580a073959e196619d94edcec3107b8ce818cfac262e8ab5a6efb7d21c14235
MD5 c05af72614c650977c177a2d788cdc5c
BLAKE2b-256 a67ecdb902301093aa2998c4732b0bdc53ba74ed72c7e1ecff558071371c6b71

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page