Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TokenAuthentication: Allow custom keyword in the header #4097

Merged
merged 2 commits into from
May 4, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api-guide/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,8 @@ For clients to authenticate, the token key should be included in the `Authorizat

Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

**Note:** If you want to use a different keyword in the header, such as `Bearer`, simply subclass `TokenAuthentication` and set the `keyword` class variable.

If successfully authenticated, `TokenAuthentication` provides the following credentials.

* `request.user` will be a Django `User` instance.
Expand Down
5 changes: 3 additions & 2 deletions rest_framework/authentication.py
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@ class TokenAuthentication(BaseAuthentication):
Authorization: Token 401f7ac837da42b97f613d789819ff93537bee6a
"""

keyword = 'Token'
model = None

def get_model(self):
Expand All @@ -168,7 +169,7 @@ def get_model(self):
def authenticate(self, request):
auth = get_authorization_header(request).split()

if not auth or auth[0].lower() != b'token':
if not auth or auth[0].lower() != self.keyword.lower().encode():
return None

if len(auth) == 1:
Expand Down Expand Up @@ -199,4 +200,4 @@ def authenticate_credentials(self, key):
return (token.user, token)

def authenticate_header(self, request):
return 'Token'
return self.keyword
22 changes: 17 additions & 5 deletions tests/test_authentication.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ class CustomTokenAuthentication(TokenAuthentication):
model = CustomToken


class CustomKeywordTokenAuthentication(TokenAuthentication):
keyword = 'Bearer'


class MockView(APIView):
permission_classes = (permissions.IsAuthenticated,)

Expand All @@ -53,6 +57,7 @@ def put(self, request):
url(r'^basic/$', MockView.as_view(authentication_classes=[BasicAuthentication])),
url(r'^token/$', MockView.as_view(authentication_classes=[TokenAuthentication])),
url(r'^customtoken/$', MockView.as_view(authentication_classes=[CustomTokenAuthentication])),
url(r'^customkeywordtoken/$', MockView.as_view(authentication_classes=[CustomKeywordTokenAuthentication])),
url(r'^auth-token/$', 'rest_framework.authtoken.views.obtain_auth_token'),
url(r'^auth/', include('rest_framework.urls', namespace='rest_framework')),
]
Expand Down Expand Up @@ -166,6 +171,7 @@ class BaseTokenAuthTests(object):
urls = 'tests.test_authentication'
model = None
path = None
header_prefix = 'Token '

def setUp(self):
self.csrf_client = APIClient(enforce_csrf_checks=True)
Expand All @@ -179,31 +185,31 @@ def setUp(self):

def test_post_form_passing_token_auth(self):
"""Ensure POSTing json over token auth with correct credentials passes and does not require CSRF"""
auth = 'Token ' + self.key
auth = self.header_prefix + self.key
response = self.csrf_client.post(self.path, {'example': 'example'}, HTTP_AUTHORIZATION=auth)
self.assertEqual(response.status_code, status.HTTP_200_OK)

def test_fail_post_form_passing_nonexistent_token_auth(self):
# use a nonexistent token key
auth = 'Token wxyz6789'
auth = self.header_prefix + 'wxyz6789'
response = self.csrf_client.post(self.path, {'example': 'example'}, HTTP_AUTHORIZATION=auth)
self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)

def test_fail_post_form_passing_invalid_token_auth(self):
# add an 'invalid' unicode character
auth = 'Token ' + self.key + "¸"
auth = self.header_prefix + self.key + "¸"
response = self.csrf_client.post(self.path, {'example': 'example'}, HTTP_AUTHORIZATION=auth)
self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)

def test_post_json_passing_token_auth(self):
"""Ensure POSTing form over token auth with correct credentials passes and does not require CSRF"""
auth = "Token " + self.key
auth = self.header_prefix + self.key
response = self.csrf_client.post(self.path, {'example': 'example'}, format='json', HTTP_AUTHORIZATION=auth)
self.assertEqual(response.status_code, status.HTTP_200_OK)

def test_post_json_makes_one_db_query(self):
"""Ensure that authenticating a user using a token performs only one DB query"""
auth = "Token " + self.key
auth = self.header_prefix + self.key

def func_to_test():
return self.csrf_client.post(self.path, {'example': 'example'}, format='json', HTTP_AUTHORIZATION=auth)
Expand Down Expand Up @@ -273,6 +279,12 @@ class CustomTokenAuthTests(BaseTokenAuthTests, TestCase):
path = '/customtoken/'


class CustomKeywordTokenAuthTests(BaseTokenAuthTests, TestCase):
model = Token
path = '/customkeywordtoken/'
header_prefix = 'Bearer '


class IncorrectCredentialsTests(TestCase):
def test_incorrect_credentials(self):
"""
Expand Down