RXJWT - Extendable JWT library for Django REST Framework
This library provides user authorization functions through JSON Web Token (JWT) mechanism.
Installation
pip install rxjwt- Add rxjwt app to your INSTALLED APPS:
INSTALLED_APPS = [
...
'rxjwt'
]- Run migrate:
python manage.py migrate - Use the library
Usage
Basic usage
- Create new token pair where you need:
from rxjwt.token import generate_user_token_pair
from yourproject.settings import SECRET_KEY # Or use another strong secret
...
access_token, refresh_token = generate_user_token_pair(user, SECRET_KEY)- Send your token to user
... your view goes here ...
return Response({
"token": str(access_token)
})- Verify your token:
from rxjwt.token import UserAccessToken
from yourproject.settings import SECRET_KEY # Or use another strong secret
...
token = UserAccessToken(token_as_string)
if token.verify(SECRET_KEY):
# Token is valid, do something e. g. user = token.get_user()
else:
# Token is not valid, show an error message Usage as authentication class
Add rjxwt.auth.JWTAuthentication to your REST_FRAMEWORK settings:
'DEFAULT_AUTHENTICATION_CLASSES': [
'rxjwt.auth.JWTAuthentication',
],Custom user tokens
You may extend token classes imported from rxjwt.token:
from rxjwt.token import UserAccessToken as UserAccessTokenBase
...
class MyUserAccessToken(UserAccessTokenBase):
@classmethod
def generate_user_secret(cls, user, secret=""):
return user.get_secret(secret)Settings
All the settings must be listed in RXJWT setting like this:
... the rest of your settings.py ...
RXJWT = {
"SETTING_NAME": SETTING_VALUE
}-
ACCESS_TOKEN_CLASS: A string containing path to custom access token class e. g.
yourapp.token.YourUserAccessToken. This setting must be set when using custom access token class and JWTAuthentication from rxjwt.auth -
SOFT_DELETE_ATTR: A string containing soft delete attribute name of your User model. Defaults to
datetime_removed. If there is an attribute with given name and itis not Nonetoken will be considered invalid.
