This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

A Django authentication backend for Microsoft ADFS

Features

  • Integrates Django with Active Directory through Microsoft ADFS by using OAuth2.
  • 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 in JWT claims received from ADFS.

Installation

Python package:

pip install django-auth-adfs

In your project’s settings.py

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

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

# checkout config.py for more settings
AUTH_ADFS = {
    "ADFS_SERVER": "adfs.yourcompany.com",
    "ADFS_CLIENT_ID": "your-configured-client-id",
    "ADFS_RESOURCE": "your-adfs-RPT-name",
    "ADFS_SIGNING_CERT": "/path/to/adfs-signing-certificate.pem",
    # Make sure to read the documentation about the ADFS_AUDIENCE setting
    # when you configured the identifier as a URL!
    "ADFS_AUDIENCE": "microsoft:identityserver:your-RelyingPartyTrust-identifier",
    "ADFS_ISSUER": "http://adfs.yourcompany.com/adfs/services/trust",
    "ADFS_CA_BUNDLE": "/path/to/ca-bundle.pem",
    "ADFS_CLAIM_MAPPING": {"first_name": "given_name",
                           "last_name": "family_name",
                           "email": "email"},
    "ADFS_REDIR_URI": "https://www.yourcompany.com/oauth2/login",
}

########################
# OPTIONAL SETTINGS
########################
TEMPLATES = [
    {
        ...
        'OPTIONS': {
            'context_processors': [
                # Only needed if you want to use the variable ADFS_AUTH_URL in your templates
                'django_auth_adfs.context_processors.adfs_url',
                ...
            ],
        },
    },
]


MIDDLEWARE_CLASSES = (
    ...
    # With this you can force a user to login without using
    # the @login_required decorator for every view function
    #
    # You can specify URLs for which login is not forced by
    # specifying them in LOGIN_EXEMPT_URLS in setting.py.
    # The values in LOGIN_EXEMPT_URLS are interpreted as regular expressions.
    'django_auth_adfs.middleware.LoginRequiredMiddleware',
)

In your project’s urls.py

urlpatterns = [
    ...
    # Needed for the redirect URL to function
    # The namespace is important and shouldn't be changed
    url(r'^oauth2/', include('django_auth_adfs.urls', namespace='auth_adfs')),
    ...
]

The URL you have to configure as the redirect URL in ADFS depends on the url pattern you configure. In the example above you have to make the redirect url in ADFS point to https://yoursite.com/oauth2/login

Contributing

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

Changelog

0.0.4 (2016-03-14)

  • Made the absence of the group claim non-fatal to allow users without a group.

0.0.3 (2016-02-21)

  • ADFS_REDIR_URI is now a required setting
  • Now supports Python 2.7, 3.4 and 3.5
  • Now supports Django 1.7, 1.8 and 1.9
  • Added debug logging to aid in troubleshooting
  • Added unit tests
  • Lot’s of code cleanup

0.0.2 (2016-02-11)

  • Fixed a possible issue with the cryptography package when used with apache + mod_wsgi.
  • Added a optional context processor to make the ADFS authentication URL available as a template variable (ADFS_AUTH_URL).
  • Added a optional middleware class to be able force an anonymous user to authenticate.

0.0.1 (2016-02-09)

  • Initial release
Release History

Release History

0.0.4

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.3

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.2

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.0.1

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django_auth_adfs-0.0.4-py3-none-any.whl (21.6 kB) Copy SHA256 Checksum SHA256 3.4 Wheel Mar 14, 2016
django-auth-adfs-0.0.4.tar.gz (26.8 kB) Copy SHA256 Checksum SHA256 Source Mar 14, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting