Metadata-Version: 1.1
Name: django-admin-oauth2
Version: 0.2.6
Summary: A django app that replaces the django admin authentication mechanism by deferring to an oauth2 provider
Home-page: https://github.com/RealGeeks/django-admin-oauth2
Author: Real Geeks LLC
Author-email: andrew@realgeeks.com
License: MIT
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)
        
        # IMPORTANT SECURITY NOTE
        
        If you use this package, you should install the latest development version of `requests_oauthlib` in order to get [an important commit that fixes a CSRF vulnerability](https://github.com/requests/requests-oauthlib/commit/c5cad15edc28040f85dba52ceebb18e11bd9e759)
        
        # Support
        
        django-admin-oauth2 should support Python 2.6, 2.7, pypy, and Django versions 1.4 through 1.7
        
        ## 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
         * 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
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
