search

jazzband / django-two-factor-auth

Complete Two-Factor Authentication for Django providing the easiest integration into most Django projects.
MIT License
1.62k stars 442 forks source link
authentication django two-factor-authentication

readme

================================ Django Two-Factor Authentication

.. image:: https://jazzband.co/static/img/badge.svg :target: https://jazzband.co/ :alt: Jazzband

.. image:: https://github.com/jazzband/django-two-factor-auth/workflows/build/badge.svg?branch=master :alt: Build Status :target: https://github.com/jazzband/django-two-factor-auth/actions

.. image:: https://codecov.io/gh/jazzband/django-two-factor-auth/branch/master/graph/badge.svg :alt: Test Coverage :target: https://codecov.io/gh/jazzband/django-two-factor-auth

.. image:: https://badge.fury.io/py/django-two-factor-auth.svg :alt: PyPI :target: https://pypi.python.org/pypi/django-two-factor-auth

Complete Two-Factor Authentication for Django. Built on top of the one-time password framework django-otp and Django's built-in authentication framework django.contrib.auth for providing the easiest integration into most Django projects. Inspired by the user experience of Google's Two-Step Authentication, allowing users to authenticate through call, text messages (SMS), by using a token generator app like Google Authenticator or a YubiKey hardware token generator (optional).

If you run into problems, please file an issue on GitHub, or contribute to the project by forking the repository and sending some pull requests. The package is translated into English, Dutch and other languages. Please contribute your own language using Transifex_.

Test drive this app through the example app. It demos most features except the Twilio integration. The example also includes django-user-sessions for providing Django sessions with a foreign key to the user. Although the package is optional, it improves account security control over django.contrib.sessions.

Compatible with supported Django and Python versions. At the moment of writing that includes 3.2, 4.0, 4.1, and 4.2 on Python 3.8, 3.9, 3.10 and 3.11. Documentation is available at readthedocs.io_.

Installation

Refer to the installation instructions_ in the documentation.

Getting help

For general questions regarding this package, please hop over to Stack Overflow_. If you think there is an issue with this package; check if the issue is already listed (either open or closed), and file an issue if it's not.

Contribute

Read the contribution guidelines_.

See Also

Have a look at django-user-sessions for Django sessions with a foreign key to the user. This package is also included in the example app.

License

The project is licensed under the MIT license.

.. _example app: https://github.com/jazzband/django-two-factor-auth/tree/master/example .. _django-otp: https://pypi.org/project/django-otp/ .. _Transifex: https://explore.transifex.com/Bouke/django-two-factor-auth/ .. _Twilio: https://www.twilio.com/ .. _contribution guidelines: https://github.com/jazzband/django-two-factor-auth/blob/master/CONTRIBUTING.rst .. _django-user-sessions: https://pypi.org/project/django-user-sessions/ .. readthedocs.io: https://django-two-factor-auth.readthedocs.io/en/stable/index.html .. installation instructions: https://django-two-factor-auth.readthedocs.io/en/stable/installation.html .. _Stack Overflow: https://stackoverflow.com/questions/tagged/django-two-factor-auth .. _Yubikey: https://www.yubico.com/products/yubikey-hardware/