Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ByteInternet/drf-oidc-auth
OpenID Connect authentication for Django REST Framework
https://github.com/ByteInternet/drf-oidc-auth
Last synced: 24 days ago
JSON representation
OpenID Connect authentication for Django REST Framework
- Host: GitHub
- URL: https://github.com/ByteInternet/drf-oidc-auth
- Owner: ByteInternet
- License: mit
- Created: 2015-09-25T13:12:35.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-29T14:45:24.000Z (10 months ago)
- Last Synced: 2024-11-05T11:58:08.670Z (about 1 month ago)
- Language: Python
- Size: 101 KB
- Stars: 112
- Watchers: 15
- Forks: 46
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - drf-oidc-auth - OpenID Connect authentication for Django REST Framework (Python)
README
# OpenID Connect authentication for Django Rest Framework
This package contains an authentication mechanism for authenticating
users of a REST API using tokens obtained from OpenID Connect.
Currently, it only supports JWT and Bearer tokens. JWT tokens will be
validated against the public keys of an OpenID connect authorization
service. Bearer tokens are used to retrieve the OpenID UserInfo for a
user to identify him.
# Installation
Install using pip:
```sh
pip install drf-oidc-auth
```
Configure authentication for Django REST Framework in settings.py:
```py
REST_FRAMEWORK = {
'DEFAULT_PERMISSION_CLASSES': (
'rest_framework.permissions.IsAuthenticated',
),
'DEFAULT_AUTHENTICATION_CLASSES': (
# ...
'oidc_auth.authentication.JSONWebTokenAuthentication',
'oidc_auth.authentication.BearerTokenAuthentication',
),
}
```
And configure the module itself in settings.py:
```py
OIDC_AUTH = {
# Specify OpenID Connect endpoint. Configuration will be
# automatically done based on the discovery document found
# at /.well-known/openid-configuration
'OIDC_ENDPOINT': 'https://accounts.google.com',
# The Claims Options can now be defined by a static string.
# ref: https://docs.authlib.org/en/latest/jose/jwt.html#jwt-payload-claims-validation
# The old OIDC_AUDIENCES option is removed in favor of this new option.
# `aud` is only required, when you set it as an essential claim.
'OIDC_CLAIMS_OPTIONS': {
'aud': {
'values': ['myapp'],
'essential': True,
}
},
# (Optional) Function that resolves id_token into user.
# This function receives a request and an id_token dict and expects to
# return a User object. The default implementation tries to find the user
# based on username (natural key) taken from the 'sub'-claim of the
# id_token.
'OIDC_RESOLVE_USER_FUNCTION': 'oidc_auth.authentication.get_user_by_id',
# (Optional) Number of seconds in the past valid tokens can be
# issued (default 600)
'OIDC_LEEWAY': 600,
# (Optional) Time before signing keys will be refreshed (default 24 hrs)
'OIDC_JWKS_EXPIRATION_TIME': 24*60*60,
# (Optional) Time before bearer token validity is verified again (default 10 minutes)
'OIDC_BEARER_TOKEN_EXPIRATION_TIME': 10*60,
# (Optional) Token prefix in JWT authorization header (default 'JWT')
'JWT_AUTH_HEADER_PREFIX': 'JWT',
# (Optional) Token prefix in Bearer authorization header (default 'Bearer')
'BEARER_AUTH_HEADER_PREFIX': 'Bearer',
# (Optional) Which Django cache to use
'OIDC_CACHE_NAME': 'default',
# (Optional) A cache key prefix when storing and retrieving cached values
'OIDC_CACHE_PREFIX': 'oidc_auth.',
}
```
# Running tests
```sh
pip install tox
tox
```
## Mocking authentication
There's a `AuthenticationTestCaseMixin` provided in the `oidc_auth.test` module, which you
can use for testing authentication like so:
```python
from oidc_auth.test import AuthenticationTestCaseMixin
from django.test import TestCase
class MyTestCase(AuthenticationTestCaseMixin, TestCase):
def test_example_cache_of_valid_bearer_token(self):
self.responder.set_response(
'http://example.com/userinfo', {'sub': self.user.username})
auth = 'Bearer egergerg'
resp = self.client.get('/test/', HTTP_AUTHORIZATION=auth)
self.assertEqual(resp.status_code, 200)
# Token expires, but validity is cached
self.responder.set_response('http://example.com/userinfo', "", 401)
resp = self.client.get('/test/', HTTP_AUTHORIZATION=auth)
self.assertEqual(resp.status_code, 200)
def test_example_using_invalid_bearer_token(self):
self.responder.set_response('http://example.com/userinfo', "", 401)
auth = 'Bearer hjikasdf'
resp = self.client.get('/test/', HTTP_AUTHORIZATION=auth)
self.assertEqual(resp.status_code, 401)
```
# References
* Requires [Django REST Framework](http://www.django-rest-framework.org/)
* And of course [Django](https://www.djangoproject.com/)
* Inspired on [REST framework JWT Auth](https://github.com/GetBlimp/django-rest-framework-jwt)