Skip to main content

A django app that replaces the django admin authentication mechanism by deferring to an oauth2 provider

Project description

# django-admin-oauth2

A django app that replaces the django admin authentication mechanism by
deferring to an oauth2 provider.

[![Build Status](https://travis-ci.org/RealGeeks/django-admin-oauth2.png?branch=master)](https://travis-ci.org/RealGeeks/django-admin-oauth2)

# Support

django-admin-oauth2 should support Python 2.7, pypy, and Django versions 1.6 through 1.10

## Installation

Step 1: `pip install django-admin-oauth2` and include it in your project's requirements

Step 2: Include the django-admin-oauth2 urlconf in your project's urls.py:

```python
url(r'/admin/oauth/', include('oauthadmin.urls'))
```

Step 3: Include oauthadmin in your INSTALLED_APPS:

```python
INSTALLED_APPS = (
'oauthadmin'
)
````


Step 4: Install the middleware in your project's settings.py:

```python
MIDDLEWARE_CLASSES = (
'oauthadmin.middleware.OauthAdminSessionMiddleware'
)
```

*make sure that this comes AFTER 'django.contrib.sessions.middleware.SessionMiddleware'*

Step 5: If you are on Django 1.5 or above, you'll need to set your session serializer
to "django.contrib.sessions.serializers.PickleSerializer" since we are storing the
pickled user object in the session.

```python
SESSION_SERIALIZER = "django.contrib.sessions.serializers.PickleSerializer"

```

Step 6: Set up all the correct options (see below for available options)

## Settings

* OAUTHADMIN_GET_USER: This is function that is given the oauth token and returns
a django.auth.models.User model corresponding to the currently logged-in user.
You can set permissions on this user object and stuff.
* OAUTHADMIN_CLIENT_ID: Your oAuth client ID
* OAUTHADMIN_CLIENT_SECRET: oAuth client secret
* OAUTHADMIN_BASE_URL: The landing point for all oAuth related queries.
* OATHADMIN_AUTH_URL: oAuth provider URL
* OAUTHADMIN_TOKEN_URL: oAuth bearer token provider URL
* OAUTHADMIN_PING_INTERVAL (optional, defaults to 300): Minimum number of seconds between ping requests
* OAUTHADMIN_PING: (optional, defaults to None) This optional function takes an oauth token and returns True if it's still valid and False if it's no longer valid (if they have logged out of the oauth server)

## Testing

If you want to test this app, install the requirements needed for testing:

```
pip install -r test-requirements.txt
```

and then run the tests with the provided script:

```
./runtests.sh

```

## Notes

When the CSRF validation token doesn't match, django-admin-oauth2 will redirect back to the login url so it can retry the authorization step. Sometimes people will bookmark the oauth server with an out-of-date CSRF state string, this is better than showing them an error page.


## Changelog
* 1.0.2: Send next parameter through state instead of using redirect URI. This makes redirect URI validation work.
* 1.0.1: Send redirect URI when exchanging grant code for auth token
* 1.0.0: Add support for django 1.8, 1.9, and 1.10. Drop support for python 2.6. Add support for python 3.5. Update test suite to run with tox.
* 0.2.6: Roundtrip original URL accessed through the oauth process so you can go to the URL you requested after the authorization process finishes. Thanks @igorsobreira.
* 0.2.5: Fix bug where failing ping was not invalidating session immediately, only on the second request.
* 0.2.4: Redirect to the login if the grant is invalid
* 0.2.3: Redirect to the login if the state is mismatching
* 0.2.2: Redirect to the login if the state goes missing (sometimes people bookmark the login url)
* 0.2.1: Added tests for the ping function and fixed a bug with the session variable name for the ping timestamp.
* 0.2.0: Added support for pinging the auth server to make sure the token is still valid

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-admin-oauth2-1.0.2.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

django_admin_oauth2-1.0.2-py2-none-any.whl (9.4 kB view details)

Uploaded Python 2

File details

Details for the file django-admin-oauth2-1.0.2.tar.gz.

File metadata

File hashes

Hashes for django-admin-oauth2-1.0.2.tar.gz
Algorithm Hash digest
SHA256 f860efdf615c4ed5681edc93b28e6fdb966e1b89fde53fec312e996527d3a275
MD5 9e2b7e3a7601dd17a6a8947a55a1427e
BLAKE2b-256 d8c6771259d2854301eba45c494ad21272949ac82ef1bc89efdf056565389b80

See more details on using hashes here.

File details

Details for the file django_admin_oauth2-1.0.2-py2-none-any.whl.

File metadata

File hashes

Hashes for django_admin_oauth2-1.0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 24f71f89b594738ad514317c9ee98bec78b80d804a6bcf5ccda71a603e391586
MD5 b60fedb72b9d07893591e4dcab76c387
BLAKE2b-256 8c13167e19b717893044ead5d3e04645d20a37499a5b6189eb561ff2180f1573

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page