Skip to main content

SAML 2.0 IdP for Django

Project description

# dj-saml-idp

This started as a fork of novapost/django-saml2-idp, distributed independently as dj-saml-idp.

The original project is at

dj-saml-idp implements the Identity Provider (IDP) side of the SAML 2.0 protocol and makes user authentication available to external applications.

This package only supports Django 1.9+. At this time, it’s only been tested with Django 1.9 & 1.11

# Development And Testing

The package uses a Docker container to support both development and tests. The container creates virtual environments for different Python versions as below:

  • Python 2.7 in /venv27

  • Python 3.7 in /venv37

These environments may be used for development and interactive testing.

To build and run the container, to get a bash prompt: `bash docker build -t dj-saml-idp:latest . docker-compose run --service-ports test `

To support use of IDEs (such as PyCharm) for development, the container can also run SSHD; run the command docker/ at a bash prompt in the container. In the commands above, the –service-ports option is only needed if you intend to run sshd in the container.

The test runner is pytest. For release tests, we use tox to run the tests against different versions of Python and Django. The tests can be run inside the Docker container using tox:

`bash $ . /venv37/bin/activate $ tox `

# Release

First of all, create a new version of the package. We use bumpversion to handle updating all version strings, committing the changes and creating a new git tag automatically. To bump the package version use the following command with whichever part of the semantic version you’d like to update:

`$ bumpversion (major|minor|patch)`

for instance for a minor update, use (which should be the most common case):

`$ bumpversion minor`

You need the PyPI credentials for the mobify account to be able to release a new version and the build script is expecting it defined as an environment variable:

$ export PYPI_PASSWORD=supersecretpassword

Releasing a new version to PyPI is very simple. The first thing you need to do is make sure that all the test are passing and that the version in saml2idp/ is the one that you’d like to create on PyPI.

With that done, all you need to do is run the following commands:

`$ make release`

This will cleanup the build/ and dist/ directories, build a source package and a Python wheel. Both will then be uploaded to PyPI.

# License

Distributed under the MIT License.

# Release History

## 1.0.0 (2019-11-06)

  • Refactor development and test environment

  • Support Python 3

## 0.22.0 (2016-05-26)

  • Allow a redirect_to parameter to be passed to the logout view to redirect the user to after succesful logout instead of showing the logout page.

  • Introduce logging through structlog and provide more informative logging out put to make SAML flows easier to debug. Log messages are all logged under the saml2idp logger now.

  • Adding a new-style processor that carries a name attribute which allows custom templates for each processor during the SSO process. Custom templates are optional and will default to the same templates as before. The change is backwards compatible and handles old-style processors as previously.

## 0.21.2 (2016-04-18)

  • Switched from django.utils.importlib to Python’s standard importlib to work with Django 1.9.

  • Update the test setup to run tests against Django 1.9 in addition to all other versions of Django.

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

dj-saml-idp-1.2.1.tar.gz (17.8 kB view hashes)

Uploaded source

Built Distribution

dj_saml_idp-1.2.1-py2.py3-none-any.whl (25.3 kB view hashes)

Uploaded py2 py3

Supported by

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