Use REST_AUTH_TOKEN_APP and remove REST_USE_JWT

Prevent simultaneous Knox and JWT use. Options are 'jwt' or 'knox'
This commit is contained in:
Daniel Stanton 2017-01-24 14:20:41 +00:00
parent b49bb2a1aa
commit e9c4ecbc07
9 changed files with 16 additions and 16 deletions

View File

@ -10,7 +10,7 @@ Configuration
- TOKEN_SERIALIZER - response for successful authentication in ``rest_auth.views.LoginView``, default value ``rest_auth.serializers.TokenSerializer`` - TOKEN_SERIALIZER - response for successful authentication in ``rest_auth.views.LoginView``, default value ``rest_auth.serializers.TokenSerializer``
- JWT_SERIALIZER - (Using REST_USE_JWT=True) response for successful authentication in ``rest_auth.views.LoginView``, default value ``rest_auth.serializers.JWTSerializer`` - JWT_SERIALIZER - (Using REST_AUTH_TOKEN_APP = 'jwt') response for successful authentication in ``rest_auth.views.LoginView``, default value ``rest_auth.serializers.JWTSerializer``
- USER_DETAILS_SERIALIZER - serializer class in ``rest_auth.views.UserDetailsView``, default value ``rest_auth.serializers.UserDetailsSerializer`` - USER_DETAILS_SERIALIZER - serializer class in ``rest_auth.views.UserDetailsView``, default value ``rest_auth.serializers.UserDetailsSerializer``
@ -46,7 +46,7 @@ Configuration
- **REST_SESSION_LOGIN** - Enable session login in Login API view (default: True) - **REST_SESSION_LOGIN** - Enable session login in Login API view (default: True)
- **REST_USE_JWT** - Enable JWT Authentication instead of Token/Session based. This is built on top of django-rest-framework-jwt http://getblimp.github.io/django-rest-framework-jwt/, which must also be installed. (default: False) - **REST_AUTH_TOKEN_APP** - Enable a compatible installed third party authentication app instead of built-in Django Rest Framework Tokens. Options are `'jwt'`, using django-rest-framework-jwt http://getblimp.github.io/django-rest-framework-jwt/, and `'knox'`, using django-rest-knox https://github.com/James1345/django-rest-knox/. (default: False)
- **OLD_PASSWORD_FIELD_ENABLED** - set it to True if you want to have old password verification on password change enpoint (default: False) - **OLD_PASSWORD_FIELD_ENABLED** - set it to True if you want to have old password verification on password change enpoint (default: False)

View File

@ -159,5 +159,5 @@ By default, ``django-rest-auth`` uses Django's Token-based authentication. If yo
.. code-block:: python .. code-block:: python
REST_USE_JWT = True REST_AUTH_TOKEN_APP = 'jwt'

View File

@ -1,6 +1,6 @@
from django.conf import settings from django.conf import settings
if getattr(settings, 'REST_USE_KNOX', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'knox':
from rest_auth.serializers import KnoxTokenSerializer as DefaultTokenSerializer from rest_auth.serializers import KnoxTokenSerializer as DefaultTokenSerializer
else: else:
from rest_auth.serializers import TokenSerializer as DefaultTokenSerializer from rest_auth.serializers import TokenSerializer as DefaultTokenSerializer

View File

@ -1,10 +1,10 @@
from django.conf import settings from django.conf import settings
if getattr(settings, 'REST_USE_KNOX', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'knox':
try: try:
from knox.models import AuthToken as DefaultTokenModel from knox.models import AuthToken as DefaultTokenModel
except ImportError: except ImportError:
raise ImportError("Install django-rest-knox to use REST_USE_KNOX = True") raise ImportError("Install django-rest-knox before setting REST_AUTH_TOKEN_APP to 'knox'")
else: else:
from rest_framework.authtoken.models import Token as DefaultTokenModel from rest_framework.authtoken.models import Token as DefaultTokenModel

View File

@ -43,7 +43,7 @@ class RegisterView(CreateAPIView):
allauth_settings.EmailVerificationMethod.MANDATORY: allauth_settings.EmailVerificationMethod.MANDATORY:
return {"detail": _("Verification e-mail sent.")} return {"detail": _("Verification e-mail sent.")}
if getattr(settings, 'REST_USE_JWT', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'jwt':
data = { data = {
'user': user, 'user': user,
'token': self.token 'token': self.token
@ -64,7 +64,7 @@ class RegisterView(CreateAPIView):
def perform_create(self, serializer): def perform_create(self, serializer):
user = serializer.save(self.request) user = serializer.save(self.request)
if getattr(settings, 'REST_USE_JWT', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'jwt':
self.token = jwt_encode(user) self.token = jwt_encode(user)
else: else:
self.token = create_token(self.token_model, user, serializer) self.token = create_token(self.token_model, user, serializer)

View File

@ -136,7 +136,7 @@ class APITestCase1(TestCase, BaseAPITestCase):
self.post(self.login_url, data=payload, status_code=200) self.post(self.login_url, data=payload, status_code=200)
@override_settings(REST_USE_JWT=True) @override_settings(REST_AUTH_TOKEN_APP='jwt')
def test_login_jwt(self): def test_login_jwt(self):
payload = { payload = {
"username": self.USERNAME, "username": self.USERNAME,
@ -367,7 +367,7 @@ class APITestCase1(TestCase, BaseAPITestCase):
self.assertEqual(user.last_name, self.response.json['last_name']) self.assertEqual(user.last_name, self.response.json['last_name'])
self.assertEqual(user.email, self.response.json['email']) self.assertEqual(user.email, self.response.json['email'])
@override_settings(REST_USE_JWT=True) @override_settings(REST_AUTH_TOKEN_APP='jwt')
def test_user_details_using_jwt(self): def test_user_details_using_jwt(self):
user = get_user_model().objects.create_user(self.USERNAME, self.EMAIL, self.PASS) user = get_user_model().objects.create_user(self.USERNAME, self.EMAIL, self.PASS)
payload = { payload = {
@ -398,7 +398,7 @@ class APITestCase1(TestCase, BaseAPITestCase):
self._login() self._login()
self._logout() self._logout()
@override_settings(REST_USE_JWT=True) @override_settings(REST_AUTH_TOKEN_APP='jwt')
def test_registration_with_jwt(self): def test_registration_with_jwt(self):
user_count = get_user_model().objects.all().count() user_count = get_user_model().objects.all().count()

View File

@ -37,7 +37,7 @@ class BaseAPITestCase(object):
# check_headers = kwargs.pop('check_headers', True) # check_headers = kwargs.pop('check_headers', True)
if hasattr(self, 'token'): if hasattr(self, 'token'):
if getattr(settings, 'REST_USE_JWT', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'jwt':
kwargs['HTTP_AUTHORIZATION'] = 'JWT %s' % self.token kwargs['HTTP_AUTHORIZATION'] = 'JWT %s' % self.token
else: else:
kwargs['HTTP_AUTHORIZATION'] = 'Token %s' % self.token kwargs['HTTP_AUTHORIZATION'] = 'Token %s' % self.token

View File

@ -280,7 +280,7 @@ class TestSocialAuth(TestCase, BaseAPITestCase):
@responses.activate @responses.activate
@override_settings( @override_settings(
REST_USE_JWT=True REST_AUTH_TOKEN_APP='jwt'
) )
def test_jwt(self): def test_jwt(self):
resp_body = '{"id":"123123123123","first_name":"John","gender":"male","last_name":"Smith","link":"https:\\/\\/www.facebook.com\\/john.smith","locale":"en_US","name":"John Smith","timezone":2,"updated_time":"2014-08-13T10:14:38+0000","username":"john.smith","verified":true}' # noqa resp_body = '{"id":"123123123123","first_name":"John","gender":"male","last_name":"Smith","link":"https:\\/\\/www.facebook.com\\/john.smith","locale":"en_US","name":"John Smith","timezone":2,"updated_time":"2014-08-13T10:14:38+0000","username":"john.smith","verified":true}' # noqa

View File

@ -52,7 +52,7 @@ class LoginView(GenericAPIView):
django_login(self.request, self.user) django_login(self.request, self.user)
def get_response_serializer(self): def get_response_serializer(self):
if getattr(settings, 'REST_USE_JWT', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'jwt':
response_serializer = JWTSerializer response_serializer = JWTSerializer
else: else:
response_serializer = TokenSerializer response_serializer = TokenSerializer
@ -61,7 +61,7 @@ class LoginView(GenericAPIView):
def login(self): def login(self):
self.user = self.serializer.validated_data['user'] self.user = self.serializer.validated_data['user']
if getattr(settings, 'REST_USE_JWT', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'jwt':
self.token = jwt_encode(self.user) self.token = jwt_encode(self.user)
else: else:
self.token = create_token(self.token_model, self.user, self.token = create_token(self.token_model, self.user,
@ -73,7 +73,7 @@ class LoginView(GenericAPIView):
def get_response(self): def get_response(self):
serializer_class = self.get_response_serializer() serializer_class = self.get_response_serializer()
if getattr(settings, 'REST_USE_JWT', False): if getattr(settings, 'REST_AUTH_TOKEN_APP', False) is 'jwt':
data = { data = {
'user': self.user, 'user': self.user,
'token': self.token 'token': self.token