django-saml2-auth

This release contains version updates, deprecation and fixes to encryption. Support for Python 3.7 and 3.8 are removed, as well as Django 4.0 and 4.1. The encryption in this library was tricky, and with fixes by @gregorywong, it is supposed to work as expected. If you are already using CERT_FILE and KEY_FILE parameters, you don't need to touch anything, as the ENCRYPTION_KEYPAIRS will be automatically populated. Also, pysaml2 is updated to 7.4.2 to add support for xmlsec1 v.1.3.x, thanks to @mvbattista. The other dependencies are updated as well.

What's Changed

• Bump pyjwt from 2.7.0 to 2.8.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/193
• Bump responses from 0.23.1 to 0.23.3 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/197
• Add ENCRYPTION_KEYPAIRS to settings by @gregorywong in https://github.com/grafana/django-saml2-auth/pull/216
• Release v3.12.0 by @mostafa in https://github.com/grafana/django-saml2-auth/pull/218

New Contributors

• @gregorywong made their first contribution in https://github.com/grafana/django-saml2-auth/pull/216
• @mvbattista made their first contribution in #218 (#204)

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.11.0...v3.12.0

This release contains 3 important features:

1. Long sought-after debugging. See how to debug.
2. Support for key and certificate files, configurable via KEY_FILE: str and CERT_FILE: str respectively, thanks to @sgabb.
3. Support for creating groups if they don't exist in Django based on incoming IdP group attribute statements, configurable via CREATE_GROUPS: bool, thanks to @santigandolfo.

What's Changed

• Bump coverage from 7.2.6 to 7.2.7 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/171
• feat(settings): add cert and key file by @sgabb in https://github.com/grafana/django-saml2-auth/pull/176
• Add proper debug config by @mostafa in https://github.com/grafana/django-saml2-auth/pull/185
• Add CREATE_GROUPS boolean to Settings by @santigandolfo in https://github.com/grafana/django-saml2-auth/pull/191
• Release v3.11.0 by @mostafa in https://github.com/grafana/django-saml2-auth/pull/186

New Contributors

• @santigandolfo made their first contribution in https://github.com/grafana/django-saml2-auth/pull/191

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.10.0...v3.11.0

What's Changed

• Bump responses from 0.21.0 to 0.22.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/98
• Bump types-setuptools from 65.4.0.0 to 65.5.0.1 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/99
• Bump pyjwt from 2.5.0 to 2.6.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/100
• [Snyk] Security upgrade setuptools from 39.0.1 to 65.5.1 by @mostafa in https://github.com/grafana/django-saml2-auth/pull/123
• [Snyk] Security upgrade setuptools from 39.0.1 to 65.5.1 by @snyk-bot in https://github.com/grafana/django-saml2-auth/pull/113
• Bump pytest from 7.1.3 to 7.2.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/102
• Bump django-stubs from 1.12.0 to 1.13.1 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/118
• Bump types-setuptools from 65.5.0.1 to 65.6.0.3 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/126
• Bump cyclonedx-bom from 3.6.3 to 3.10.1 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/122
• login page redirect url passed as RelayState instead of "login_next_url" by @gnuman in https://github.com/grafana/django-saml2-auth/pull/164
• Update dependencies by @mostafa in https://github.com/grafana/django-saml2-auth/pull/170

New Contributors

• @snyk-bot made their first contribution in https://github.com/grafana/django-saml2-auth/pull/113
• @gnuman made their first contribution in https://github.com/grafana/django-saml2-auth/pull/164

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.9.0...v3.10.0

What's Changed

• Adds support for configurable authentication backends by @henxing in https://github.com/grafana/django-saml2-auth/pull/72
• Add GET_USER to TRIGGER actions by @paoloromolini in https://github.com/grafana/django-saml2-auth/pull/88
• Creating user with custom function by @UraizAli and @mostafa in https://github.com/grafana/django-saml2-auth/pull/93
• Release v3.9.0 by @mostafa in https://github.com/grafana/django-saml2-auth/pull/92
• Update dependencies to latest versions by @mostafa in https://github.com/grafana/django-saml2-auth/pull/97
• Fix issues with coverage report to coveralls.io by @mostafa in https://github.com/grafana/django-saml2-auth/commit/fae23d57eba477d522ddba9d4f4b8abcecf8bf13, https://github.com/grafana/django-saml2-auth/commit/107919a49f478185c1b4f1c7d22e19506782518b and https://github.com/grafana/django-saml2-auth/commit/2d5a66828486b81dce74f32e335ffb603548fc70
• Update README by @mostafa in https://github.com/grafana/django-saml2-auth/commit/c6c78c5b308e38f6a5854f39b3500b5d4407a962 and https://github.com/grafana/django-saml2-auth/commit/8446374211ca22c903b3ca246363c4588e457cac

New Contributors

• @henxing made their first contribution in https://github.com/grafana/django-saml2-auth/pull/72
• @paoloromolini and @TamaraNocentini made their first contribution in https://github.com/grafana/django-saml2-auth/pull/88
• @UraizAli made their first contribution in https://github.com/grafana/django-saml2-auth/pull/93

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.8.0...v3.9.0

What's Changed

• Add cyclonedx-bom for generating SBOMs for requirements files by @mostafa in https://github.com/grafana/django-saml2-auth/pull/42

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.6.0...v3.6.1

What's Changed

• Bump types-setuptools from 57.4.14 to 57.4.17 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/53
• Bump django-stubs from 1.10.1 to 1.11.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/48
• Bump dictor from 0.1.9 to 0.1.10 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/50
• Bump responses from 0.20.0 to 0.21.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/51
• Retrieve user_id from SAML unverified response by @rafa-munoz in https://github.com/grafana/django-saml2-auth/pull/56
• Update config variables to reflect code by @mvbattista in https://github.com/grafana/django-saml2-auth/pull/62

New Contributors

• @mvbattista made their first contribution in https://github.com/grafana/django-saml2-auth/pull/62

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.7.0...v3.8.0

What's Changed

• [Snyk] Security upgrade pyjwt from 2.3.0 to 2.4.0 by @mostafa in https://github.com/grafana/django-saml2-auth/pull/45
• Lots of changes to CI/CD process for creating SBOM artifacts along with using a separate requirements file, and also adding status badges by @mostafa in https://github.com/grafana/django-saml2-auth/commit/6cc22cc5e9f6046501e91bc4d02319169d88d89b https://github.com/grafana/django-saml2-auth/commit/76db85593136b92f37e322ff0293e8f6c540cf69 https://github.com/grafana/django-saml2-auth/commit/c0867a7b3aefd94851ce792b842ffb20b3f32d9d https://github.com/grafana/django-saml2-auth/commit/82e63830300a272549e882598d16973953fe4f17 https://github.com/grafana/django-saml2-auth/commit/7b0f9cf18b75851b3a26827c7c01fda8b227470d https://github.com/grafana/django-saml2-auth/commit/b1c1f8911e6e2364a2080998806d541bcf57bea3

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.6.1...v3.7.0

What's Changed

• Bump pytest from 7.1.1 to 7.1.2 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/39
• Publish an official package to PyPI by @mostafa in https://github.com/grafana/django-saml2-auth/pull/40 (available as grafana-django-saml2-auth)

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.5.1...v3.6.0

This release fixes a tiny bug introduced in #35.

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.5.0...v3.5.1

This release wasn't possible without help from @sgabb and @syre. 🙏

What's Changed

• Bump pysaml2 from 7.1.0 to 7.1.2 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/29
• Bump dictor from 0.1.7 to 0.1.9 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/30
• Use settings.SAML2_AUTH in calls to dictor by @syre in https://github.com/grafana/django-saml2-auth/pull/27
• Bump pytest from 7.0.1 to 7.1.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/31
• Bump pytest from 7.1.0 to 7.1.1 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/32
• Bump responses from 0.19.0 to 0.20.0 by @dependabot in https://github.com/grafana/django-saml2-auth/pull/33
• Custom JWT plugin (& RelayState small fix) by @sgabb in https://github.com/grafana/django-saml2-auth/pull/35

New Contributors

• @dependabot made their first contribution in https://github.com/grafana/django-saml2-auth/pull/29
• @sgabb made their first contribution in https://github.com/grafana/django-saml2-auth/pull/35

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.4.0...v3.5.0

This release adds support for Python >= 3.7 and the latest Django versions: 2.2, 3.2, and 4.0. I also updated the GitHub CI workflow to include tests for various Python and Django versions.

What's Changed

• Feature: Django v4 support by @Menda in https://github.com/grafana/django-saml2-auth/pull/26
• Update dependencies by @mostafa in https://github.com/grafana/django-saml2-auth/pull/28

New Contributors

• @Menda made their first contribution in https://github.com/grafana/django-saml2-auth/pull/26

Full Changelog: https://github.com/grafana/django-saml2-auth/compare/v3.3.0...v3.4.0

In this minor release, PKI support for JWT token encoding/decoding is added #24. As part of the same PR, documentation (readme and authors) are converted to markdown, cleaned up, and updated with a detailed table describing each configuration setting. A new section is also added that explains JWT signing algorithm and settings.

This release includes updates to 2 dependencies (#22):

• pysaml2 to 7.1.0
• PyJWT to 2.3.0.

As the issue is raised in #20, I created a PR #23 and introduced REQUIRE_TOKEN settings (default: True) to make token field optional in the attribute statement.

Since the last release, v3.0.0, there has been some minor issues fixed and enhancements added by @jean-sh and @syre and me. I just tagged this to differentiate from further changes that might happen down the line, like dependency updates and such.

This release includes lots of changes: 71 commits, 92 lines of commit messages and 3 reviewers (thanks to @Griatch, @Menda and @esquonk). This release is backward incompatible and includes refactoring, improving code readability (docstrings, annotations, ...), tests, new shiny features and the like. It started as a task to refactor the code, but ended with many other things.

The biggest change so far was adding tests along with GitHub Actions as CI and the introduction of SP-initiated SSO. The exception and error handling is also greatly improved. For a more detailed description of what happened in this release, please read the changelog.