Skip to main content

A Django authentication backend for Microsoft ADFS and AzureAD

Project description

Documentation Status https://img.shields.io/pypi/v/django-auth-adfs.svg https://img.shields.io/pypi/pyversions/django-auth-adfs.svg https://img.shields.io/pypi/djversions/django-auth-adfs.svg https://codecov.io/github/snok/django-auth-adfs/coverage.svg?branch=master

A Django authentication backend for Microsoft ADFS and Azure AD

Features

  • Integrates Django with Active Directory on Windows 2012 R2, 2016 or Azure AD in the cloud.

  • Provides seamless single sign on (SSO) for your Django project on intranet environments.

  • Auto creates users and adds them to Django groups based on info received from ADFS.

  • Django Rest Framework (DRF) integration: Authenticate against your API with an ADFS access token.

Installation

Python package:

pip install django-auth-adfs

In your project’s settings.py add these settings.

AUTHENTICATION_BACKENDS = (
    ...
    'django_auth_adfs.backend.AdfsAuthCodeBackend',
    ...
)

INSTALLED_APPS = (
    ...
    # Needed for the ADFS redirect URI to function
    'django_auth_adfs',
    ...

# checkout the documentation for more settings
AUTH_ADFS = {
    "SERVER": "adfs.yourcompany.com",
    "CLIENT_ID": "your-configured-client-id",
    "RELYING_PARTY_ID": "your-adfs-RPT-name",
    # Make sure to read the documentation about the AUDIENCE setting
    # when you configured the identifier as a URL!
    "AUDIENCE": "microsoft:identityserver:your-RelyingPartyTrust-identifier",
    "CA_BUNDLE": "/path/to/ca-bundle.pem",
    "CLAIM_MAPPING": {"first_name": "given_name",
                      "last_name": "family_name",
                      "email": "email"},
}

# Configure django to redirect users to the right URL for login
LOGIN_URL = "django_auth_adfs:login"
LOGIN_REDIRECT_URL = "/"

########################
# OPTIONAL SETTINGS
########################

MIDDLEWARE = (
    ...
    # With this you can force a user to login without using
    # the LoginRequiredMixin on every view class
    #
    # You can specify URLs for which login is not enforced by
    # specifying them in the LOGIN_EXEMPT_URLS setting.
    'django_auth_adfs.middleware.LoginRequiredMiddleware',
)

In your project’s urls.py add these paths:

urlpatterns = [
    ...
    path('oauth2/', include('django_auth_adfs.urls')),
]

This will add these paths to Django:

  • /oauth2/login where users are redirected to, to initiate the login with ADFS.

  • /oauth2/login_no_sso where users are redirected to, to initiate the login with ADFS but forcing a login screen.

  • /oauth2/callback where ADFS redirects back to after login. So make sure you set the redirect URI on ADFS to this.

  • /oauth2/logout which logs out the user from both Django and ADFS.

You can use them like this in your django templates:

<a href="{% url 'django_auth_adfs:logout' %}">Logout</a>
<a href="{% url 'django_auth_adfs:login' %}">Login</a>
<a href="{% url 'django_auth_adfs:login-no-sso' %}">Login (no SSO)</a>

Contributing

Contributions to the code are more then welcome. For more details have a look at the CONTRIBUTING.rst file.

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-adfs-1.8.0.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

django_auth_adfs-1.8.0-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

Details for the file django-auth-adfs-1.8.0.tar.gz.

File metadata

  • Download URL: django-auth-adfs-1.8.0.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.11 Linux/5.8.0-1039-azure

File hashes

Hashes for django-auth-adfs-1.8.0.tar.gz
Algorithm Hash digest
SHA256 10dc2a469ff2c215b9c5c97353ba838e977a681b8497b1900da167b63bd2edb2
MD5 3cb4fb1eac88b58ad8bd9e5492f1cfd9
BLAKE2b-256 8836a0713a4d940750d14bcd9ada43e88cd42d56dcea38941b06d3c57337c5f5

See more details on using hashes here.

File details

Details for the file django_auth_adfs-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: django_auth_adfs-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.11 Linux/5.8.0-1039-azure

File hashes

Hashes for django_auth_adfs-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dcdbff76ac6b7c9275473b6256d99ae4fa97855ba160bc909d0568c54cb42d1e
MD5 b2db45d83a190d9705898ef4575ea861
BLAKE2b-256 1c617b4d0e7765fd3d510cac60041c27ce220abed9c594bb15a03c3b1a269a14

See more details on using hashes here.

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