Summary

Add API token support to the Djblets web API infrastructure.

Review Request #7475 — Created July 2, 2015 and submitted July 7, 2015, 4:39 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-0.9.x

Bugs

Depends On

Commit

9a80f73...

Reviewers

Groups

djblets

People

Description

Review Board 2.5 introduced support for using API tokens for

authentication, but this was limited to Review Board. This change ports

over that logic into Djblets, so that other applications can make use of

the same API token capabilities.
This consists of backends for authentication, mixins for WebAPIResource

subclasses, an abstract model that projects can subclass for storing API

token data, policy validation and enforcement, and a model manager.
There are also unit tests for API token policy validation, plus a new

assertion function for helping test ValidationError messages.

Testing Done

Unit tests for both Djblets and Review Board pass (with the API token code
ripped out of Review Board).

Issues

Description	From	Last Updated
undefined name 'WebAPIToken'	reviewbot	July 2, 2015, 5:28 p.m.
Col: 1 W391 blank line at end of file	reviewbot	July 2, 2015, 5:28 p.m.
Col: 80 E501 line too long (82 > 79 characters)	reviewbot	July 2, 2015, 5:30 p.m.
Col: 80 E501 line too long (82 > 79 characters)	reviewbot	July 2, 2015, 5:29 p.m.
Col: 80 E501 line too long (80 > 79 characters)	reviewbot	July 2, 2015, 5:29 p.m.
Col: 80 E501 line too long (80 > 79 characters)	reviewbot	July 2, 2015, 5:29 p.m.
The key that gets passed in to sha1 needs to be bytes, not unicode. I'd suggest assembling the key and …	david	July 6, 2015, 3:58 p.m.
Add a period at the end?	david	July 6, 2015, 3:58 p.m.
Can we swap the single and double quotes in this string?	david	July 6, 2015, 3:58 p.m.
Same here?	david	July 6, 2015, 3:59 p.m.
Same here?	david	July 6, 2015, 3:59 p.m.
And here?	david	July 6, 2015, 3:59 p.m.
And here?	david	July 6, 2015, 3:59 p.m.
And here? I see more below but I'm not going to add comments for them.	david	July 6, 2015, 4 p.m.
Docstring?	david	July 6, 2015, 4:11 p.m.
This should probably be self.api_token_model.DoesNotExist.	brennie	July 6, 2015, 11:49 p.m.
You don't need pass with a docstring.	brennie	July 6, 2015, 11:50 p.m.
if not policy ?	brennie	July 6, 2015, 11:51 p.m.
I think this should use six.string_types instead of basestring.	david	July 7, 2015, 4:38 p.m.
'ObjectDoesNotExist' imported but unused	reviewbot	July 7, 2015, midnight

Tool: Pyflakes
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/errors.py
    djblets/webapi/models.py
    djblets/webapi/tests/test_api_policy.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/errors.py
    djblets/webapi/models.py
    djblets/webapi/tests/test_api_policy.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst

djblets/webapi/auth/backends/api_tokens.py (Diff revision 1)
The issue has been resolved. Show all issues
```
 undefined name 'WebAPIToken'
```
djblets/webapi/resources/mixins/api_tokens.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 1
 W391 blank line at end of file
```
djblets/webapi/tests/test_api_policy.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (82 > 79 characters)
```
djblets/webapi/tests/test_api_policy.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (82 > 79 characters)
```
djblets/webapi/tests/test_api_policy.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (80 > 79 characters)
```
djblets/webapi/tests/test_api_policy.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Col: 80
 E501 line too long (80 > 79 characters)
```

Change Summary:

Fixd the PyFlakes complaints.

Commit:

a398b4137b1491d41b296cea224952cb0ce726ac

4ca5ef343281357c6d4874668571b14c4f141f99

Diff:

Revision 2 (+1212)

Show changes

	djblets/webapi/errors.py
	djblets/webapi/managers.py
	djblets/webapi/models.py
	djblets/webapi/auth/backends/api_tokens.py
	djblets/webapi/resources/mixins/__init__.py
	djblets/webapi/resources/mixins/api_tokens.py
	djblets/webapi/tests/test_api_policy.py
	docs/djblets/coderef/index.rst

Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/errors.py
    djblets/webapi/models.py
    djblets/webapi/tests/test_api_policy.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst



Tool: Pyflakes
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/errors.py
    djblets/webapi/models.py
    djblets/webapi/tests/test_api_policy.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst

djblets/webapi/managers.py (Diff revision 2)

The issue has been resolved. Show all issues

The key that gets passed in to sha1 needs to be bytes, not unicode. I'd suggest assembling the key and then calling .encode('utf-8').

chipx86 July 3, 2015, 1:08 p.m.

This code is all directly copied from Review Board, and seems to be working?

chipx86 July 3, 2015, 1:09 p.m.


>>> hashlib.sha1(u'abc').hexdigest()
'a9993e364706816aba3e25717850c26c9cd0d89d'

>>> hashlib.sha1('abc').hexdigest()
'a9993e364706816aba3e25717850c26c9cd0d89d'

david July 3, 2015, 1:18 p.m.

I think that's because Python 2 will coerce it. Python 3 won't.

djblets/webapi/managers.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Add a period at the end?
```
djblets/webapi/models.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can we swap the single and double quotes in this string?
```
djblets/webapi/models.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Same here?
```
djblets/webapi/models.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Same here?
```
djblets/webapi/models.py (Diff revision 2)
The issue has been resolved. Show all issues
```
And here?
```
djblets/webapi/models.py (Diff revision 2)
The issue has been resolved. Show all issues
```
And here?
```
djblets/webapi/models.py (Diff revision 2)
The issue has been resolved. Show all issues
```
And here?
I see more below but I'm not going to add comments for them.
```
djblets/webapi/resources/mixins/api_tokens.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Docstring?
```

Change Summary:


Encoded the raw API token to a UTF-8 string.
Swapped quotes in the validation errors to show double quotes in the error message.
Added a docstring to call_method_view.
Added an assertRaisesValidationError that helps to sanely compare a given string to that of a ValidationError.

Description:

		Review Board 2.5 introduced support for using API tokens for
		authentication, but this was limited to Review Board. This change ports
		over that logic into Djblets, so that other applications can make use of
		the same API token capabilities.

		This consists of backends for authentication, mixins for WebAPIResource
		subclasses, an abstract model that projects can subclass for storing API
		token data, policy validation and enforcement, and a model manager.

~		There are also unit tests for API token policy validation.
	~	There are also unit tests for API token policy validation, plus a new
	+	assertion function for helping test `ValidationError` messages.

Commit:

4ca5ef343281357c6d4874668571b14c4f141f99

34a8ea628a3ef888be97db40b3a77075a33471f3

Diff:

Revision 3 (+1231)

Show changes

	djblets/testing/testcases.py
	djblets/webapi/errors.py
	djblets/webapi/managers.py
	djblets/webapi/models.py
	djblets/webapi/auth/backends/api_tokens.py
	djblets/webapi/resources/mixins/__init__.py
	djblets/webapi/resources/mixins/api_tokens.py
	djblets/webapi/tests/test_api_policy.py
	1 more

Tool: Pyflakes
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/tests/test_api_policy.py
    djblets/testing/testcases.py
    djblets/webapi/models.py
    djblets/webapi/errors.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/tests/test_api_policy.py
    djblets/testing/testcases.py
    djblets/webapi/models.py
    djblets/webapi/errors.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst

djblets/webapi/auth/backends/api_tokens.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should probably be self.api_token_model.DoesNotExist.
```
djblets/webapi/errors.py (Diff revision 3)
The issue has been resolved. Show all issues
```
You don't need pass with a docstring.
```
djblets/webapi/models.py (Diff revision 3)
The issue has been resolved. Show all issues
```
if not policy ?
```

Commit:

34a8ea628a3ef888be97db40b3a77075a33471f3

9a80f7384ec8a319e4591f6d0ba95644a271b00b

Diff:

Revision 4 (+1230)

Show changes

	djblets/testing/testcases.py
	djblets/webapi/errors.py
	djblets/webapi/managers.py
	djblets/webapi/models.py
	djblets/webapi/auth/backends/api_tokens.py
	djblets/webapi/resources/mixins/__init__.py
	djblets/webapi/resources/mixins/api_tokens.py
	djblets/webapi/tests/test_api_policy.py
	1 more

Tool: Pyflakes
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/tests/test_api_policy.py
    djblets/testing/testcases.py
    djblets/webapi/models.py
    djblets/webapi/errors.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst



Tool: PEP8 Style Checker
Processed Files:
    djblets/webapi/auth/backends/api_tokens.py
    djblets/webapi/resources/mixins/api_tokens.py
    djblets/webapi/tests/test_api_policy.py
    djblets/testing/testcases.py
    djblets/webapi/models.py
    djblets/webapi/errors.py
    djblets/webapi/managers.py

Ignored Files:
    djblets/webapi/resources/mixins/__init__.py
    docs/djblets/coderef/index.rst

djblets/webapi/auth/backends/api_tokens.py (Diff revision 4)
The issue has been resolved. Show all issues
```
 'ObjectDoesNotExist' imported but unused
```

Ship it!

djblets/testing/testcases.py (Diff revision 4)
The issue has been resolved. Show all issues
```
I think this should use six.string_types instead of basestring.
```

Status:: Completed
Change Summary:: Pushed to release-0.9.x (8cc58e8)