Metadata-Version: 1.1
Name: django-auth-oidc
Version: 0.4.4
Summary: OpenID Connect authentication support for Django
Home-page: https://gitlab.com/aiakos/django-auth-oidc
Author: Aiakos Contributors
Author-email: aiakos@aiakosauth.com
License: MIT
Description-Content-Type: UNKNOWN
Description: Django-Auth-OIDC - OpenID Connect authentication support for Django
        ===================================================================
        .. image:: https://badge.fury.io/py/django-auth-oidc.svg
        	:target: https://badge.fury.io/py/django-auth-oidc
        
        This is a Django login view that authenticates against an OpenID Connect
        Authentication Server.
        
        Use it if you own a single Authentication Server that you want to share
        between multiple apps.
        
        What is OpenID Connect?
        -----------------------
        
        It's a OAuth2-based standard for authentication in applications.
        
        It can be used for social logins (but we recommend Aiakos_ if you need
        more than one), and for setting up Single Sign-On into multiple services
        hosted by the same company. In the last case, it somewhat supersedes LDAP,
        as with OIDC people are entering their credentials only into the views
        served by the Authentication Server, and not into all the company's
        applications.
        
        Requirements
        ------------
        
        - Python 2.7 / 3.5+
        - Django 1.8+
        - openid-connect_
        
        Installation
        ------------
        
        .. code:: python
        
        	pip install django-auth-oidc
        
        settings.py
        ~~~~~~~~~~~
        
        .. code:: python
        
        	INSTALLED_APPS += ['django_auth_oidc']
        
        urls.py
        ~~~~~~~
        
        .. code:: python
        
        	urlpatterns += [
        		url(r'^auth/', include('django_auth_oidc.urls')),
        	]
        
        Configuration
        -------------
        
        Authorization Server
        ~~~~~~~~~~~~~~~~~~~~
        
        App's redirect URI: http(s)://app-domain/auth/done
        App's post-logout redirect URI: http(s)://app-domain/*LOGOUT_REDIRECT_URL* (or / if not set)
        
        Authorization Server details
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        You may specify following settings in the Django settings file:
        
        * AUTH_SERVER - OpenID Connect Authorization Server URL.
        * AUTH_CLIENT_ID - Client ID received from the Authorization Server
        * AUTH_CLIENT_SECRET - Client secret received from the Authorization Server
        * AUTH_PROTOCOL (optional) - Legacy protocol supported by openid-connect_ library, for example github or gitlab. See openid-connect_'s documentation for full list of supported protocols.
        
        Or, alternatively, you may set the AUTH_URL environment variable:
        
        .. code:: bash
        
        	AUTH_URL=(protocol+)http(s)://client_id:client_secret@server/
        
        (Note: ":", "@", "/" and "%" inside client_id and client_secret must be urlquoted.)
        
        Behavior
        ~~~~~~~~
        
        * AUTH_SCOPE (default: ['openid']) - list of scopes to request from the auth server
        * AUTH_GET_USER_FUNCTION (default: 'django_auth_oidc:get_user_by_username') - name of a function that takes the user info dict, and returns an user object representing that user; note that it should set the user.backend attribute.
        
        .. _openid-connect: https://gitlab.com/aiakos/python-openid-connect
        .. _Aiakos: https://gitlab.com/aiakos/aiakos
        
Keywords: django auth oauth openid oidc social ldap
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
