django_crypto_auth's Introduction

django_crypto_auth

Documentation:

Django Rest - Token Based Authentication

Response:

If user is successfully authenticated, response will return a JSON:

{
    "token": "token",
    "expiry": n,
    "refresh_token": "refresh token,
    "user": "username"
}

Settings:

- CRYPTO_AUTH_TOKEN_SHUFFLE: tuple | list *
    - Items have to be string letters from "a" to "j"
    - The order will determine how the token will be encrypted
    - You can use create_token_shuffle method from crypto_auth.helper to generate one

- CRYPTO_AUTH_TOKEN_SERIALIZER: string
    - Override django_crypto_auth Serializer
    - Format should be -> "myapp.serializer.SerializerClass"

- CRYPTO_AUTH_TOKEN_KEYWORD: str
    - Header keyword authentication
    - Default = "TSESSION"

- CRYPTO_AUTH_MAX_TOKEN_LIMIT: int
    - Max token limit per user
    - Default = 2

- CRYPTO_AUTH_SUBSET_LENGTH: int
    - Subset from Token
    - Has to be between 2 and 15
    - Default = 4

- CRYPTO_AUTH_TOKEN_EXPIRY: dict - tuple = ("<keyword>", n: int)
    - keyword should be:
        - seconds, minutes, hours, days or weeks
    - Default = ("minutes", 3)

Note:

LoginVIew from crypto_auth.views use DEFAULT_AUTHENTICATION_CLASSES from rest_framework.

More info Here.

if you want to override it, just do

class CustomView(LoginView):
    authentication_classes = [CustomAuthentication]

More info Here.

Test

# go to crypto_auth
$ cd django_crypto_auth

# move to test branch
$ git checkout test

# go back and run
$ cd ..
$ python manage.py test django_crypto_auth

Recommend Projects