Skip to main content

OpenID Connect authentication support for Django

Project description

https://badge.fury.io/py/django-auth-oidc.svg

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 django-extauth is much better for this case), 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

Installation

pip install django-auth-oidc

settings.py

INSTALLED_APPS += ['django_auth_oidc']

urls.py

urlpatterns += [
        url(r'^accounts/login/', include('django_auth_oidc.urls')),
]

Configuration

Authorization Server

App’s redirect URI: http(s)://app-domain/accounts/login/callback

Your application

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:

AUTH_URL=(protocol+)http(s)://client_id:client_secret@server/

(Note: “:”, “@”, “/” and “%” inside client_id and client_secret must be urlquoted.)

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-auth-oidc-0.2.0.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

django_auth_oidc-0.2.0-py2.py3-none-any.whl (6.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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