Skip to main content

REST Multi-factor authentication package for Django

Project description

https://travis-ci.org/merixstudio/django-trench.svg?branch=master https://codecov.io/gh/merixstudio/django-trench/branch/master/graph/badge.svg https://readthedocs.org/projects/django-trench/badge/?version=latest
django-trench provides a set of REST API endpoints to supplement django-rest-framework with multi-factor authentication (MFA, 2FA). It supports both standard built-in authentication methods, as well as JWT (JSON Web Token). django-trench follows the url pattern developed in djoser library and may act as its supplement.
We deliver a couple of sample secondary authentication methods including sending OTP based code by email, SMS/text as well as through 3rd party mobile apps or utilising YubiKey. Developers can easily add own auth backend supporting any communication channel.

Features

  • Easily plugable and compatible with django-rest-framework and djoser

  • Allows user to pick an additional authentication method from range of backends defined by a developer. Read more: backends

  • Comes out of a box with email, SMS, mobile apps and YubiKey support

Requirements

Supported versions

  • Python 3.4, 3.5, 3.6, 3.7

  • Django 1.11, 2.0, 2.1, 2.2

  • Django REST Framework 3.7, 3.8, 3.9

If you implement Token Based Authentication:
If you are going to use JWT authentication:
or

Quick Start

  1. Install the package using pip:

pip install django-trench

or add it to your requirements file.

  1. Add trench library to INSTALLED_APPS in your app settings file:

INSTALLED_APPS = (
    ...,
    'rest_framework',
    'rest_framework.authtoken',  # In case of implementing Token Based Authentication
    ...,
    'trench',
)
  1. Run migrations

Read further in: installation.

Translation

Trench uses Transifex service to translate our package into other languages.

We will appreciate your help with translation.

https://www.transifex.com/merixstudio/django-trench/dashboard/

Demo project

You can also check our live demo.

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

django-trench-0.2.2.tar.gz (23.6 kB view details)

Uploaded Source

File details

Details for the file django-trench-0.2.2.tar.gz.

File metadata

  • Download URL: django-trench-0.2.2.tar.gz
  • Upload date:
  • Size: 23.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.6

File hashes

Hashes for django-trench-0.2.2.tar.gz
Algorithm Hash digest
SHA256 1450b9121881bc3e98dde116085f00a3c3ea8a6aee328a89e6fd0f47e21083ac
MD5 e970203a0314d4f77186b0f2279044ff
BLAKE2b-256 6cc1cb5fb3dd8b4f20cb386b12165dee5e52d0be5076438e7d26d09178ed410c

See more details on using hashes here.

Supported by

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