Merge pull request #337 from g-as/feature/django_4.1

Django 4.1 compat

Author: Giuseppe De Marco

.github/workflows/python-package.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         python-version: ["3.8", "3.9", "3.10"]
-        django-version: ["3.2", "4.0"]
+        django-version: ["3.2", "4.0", "4.1"]
         include:
         - python-version: "3.7"
           django-version: "3.2"

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ exclude: 'docs|migrations'
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
+    rev: v4.3.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
@@ -13,7 +13,7 @@ repos:
       - id: debug-statements
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.31.1
+    rev: v2.34.0
     hooks:
       - id: pyupgrade
         args: [--py37-plus]
@@ -32,12 +32,12 @@ repos:
         args: ['--settings-path=pyproject.toml']
 
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.6.0
     hooks:
       - id: black
 
   - repo: https://github.com/adamchainz/django-upgrade
-    rev: 1.4.0
+    rev: 1.7.0
     hooks:
       - id: django-upgrade
         args: [--target-version, "3.2"]

djangosaml2/__init__.py

@@ -1 +0,0 @@
-default_app_config = "djangosaml2.apps.DjangoSaml2Config"

djangosaml2/tests/__init__.py

@@ -782,6 +782,39 @@ def test_logout_service_global(self):
             "Not a valid Response",
         )
 
+    @override_settings(LOGOUT_REDIRECT_URL="/dashboard/")
+    def test_post_logout_redirection(self):
+        settings.SAML_CONFIG = conf.create_conf(
+            sp_host="sp.example.com",
+            idp_hosts=["idp.example.com"],
+            metadata_file="remote_metadata_one_idp.xml",
+        )
+
+        self.do_login()
+
+        response = self.client.get(reverse("saml2_logout"))
+        self.assertEqual(response.status_code, 302)
+
+        # now simulate a logout response sent by the idp
+        expected_request = """<samlp:LogoutRequest xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol" ID="XXXXXXXXXXXXXXXXXXXXXX" Version="2.0" Destination="https://idp.example.com/simplesaml/saml2/idp/SingleLogoutService.php" Reason=""><saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">http://sp.example.com/saml2/metadata/</saml:Issuer><saml:NameID SPNameQualifier="http://sp.example.com/saml2/metadata/" Format="urn:oasis:names:tc:SAML:2.0:nameid-format:transient">1f87035b4c1325b296a53d92097e6b3fa36d7e30ee82e3fcb0680d60243c1f03</saml:NameID><samlp:SessionIndex>a0123456789abcdef0123456789abcdef</samlp:SessionIndex></samlp:LogoutRequest>"""
+
+        request_id = re.findall(r' ID="(.*?)" ', expected_request)[0]
+        instant = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%SZ")
+
+        saml_response = """<?xml version='1.0' encoding='UTF-8'?>
+<samlp:LogoutResponse xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol" Destination="http://sp.example.com/saml2/ls/" ID="a140848e7ce2bce834d7264ecdde0151" InResponseTo="{}" IssueInstant="{}" Version="2.0"><saml:Issuer Format="urn:oasis:names:tc:SAML:2.0:nameid-format:entity">https://idp.example.com/simplesaml/saml2/idp/metadata.php</saml:Issuer><samlp:Status><samlp:StatusCode Value="urn:oasis:names:tc:SAML:2.0:status:Success" /></samlp:Status></samlp:LogoutResponse>""".format(
+            request_id, instant
+        )
+
+        response = self.client.get(
+            reverse("saml2_ls"),
+            {
+                "SAMLResponse": deflate_and_base64_encode(saml_response),
+            },
+        )
+        self.assertRedirects(response, "/dashboard/")
+        self.assertListEqual(list(self.client.session.keys()), [])
+
     def test_incomplete_logout(self):
         settings.SAML_CONFIG = conf.create_conf(
             sp_host="sp.example.com", idp_hosts=["idp.example.com"]

djangosaml2/views.py

@@ -26,17 +26,18 @@
     HttpResponseRedirect,
     HttpResponseServerError,
 )
-from django.shortcuts import render
+from django.shortcuts import render, resolve_url
 from django.template import TemplateDoesNotExist
 from django.urls import reverse
 from django.utils.decorators import method_decorator
 from django.utils.module_loading import import_string
+from django.utils.translation import gettext_lazy as _
 from django.views.decorators.csrf import csrf_exempt
 from django.views.generic import View
 
 from django.contrib import auth
 from django.contrib.auth.mixins import LoginRequiredMixin
-from django.contrib.auth.views import LogoutView as AuthLogoutView
+from django.contrib.sites.shortcuts import get_current_site
 
 import saml2
 from saml2.client_base import LogoutError
@@ -787,14 +788,29 @@ def do_logout_service(self, request, data, binding):
         return HttpResponseBadRequest("No SAMLResponse or SAMLRequest parameter found")
 
 
-def finish_logout(request, response, next_page=None):
+def finish_logout(request, response):
     if getattr(settings, "SAML_IGNORE_LOGOUT_ERRORS", False) or (
         response and response.status_ok()
     ):
-        if not next_page:
-            next_page = getattr(settings, "LOGOUT_REDIRECT_URL", "/")
-        logger.debug("Performing django logout with a next_page of %s", next_page)
-        return AuthLogoutView.as_view()(request, next_page=next_page)
+        logger.debug("Performing django logout.")
+
+        auth.logout(request)
+
+        if settings.LOGOUT_REDIRECT_URL is not None:
+            return HttpResponseRedirect(resolve_url(settings.LOGOUT_REDIRECT_URL))
+        else:
+            current_site = get_current_site(request)
+            return render(
+                request,
+                "registration/logged_out.html",
+                {
+                    "site": current_site,
+                    "site_name": current_site.name,
+                    "title": _("Logged out"),
+                    "subtitle": None,
+                },
+            )
+
     logger.error("Unknown error during the logout")
     return render(request, "djangosaml2/logout_error.html", {})
 

setup.py

@@ -27,7 +27,7 @@ def read(*rnames):
 
 setup(
     name="djangosaml2",
-    version="1.5.0",
+    version="1.5.1",
     description="pysaml2 integration for Django",
     long_description=read("README.md"),
     long_description_content_type="text/markdown",
@@ -37,6 +37,7 @@ def read(*rnames):
         "Framework :: Django",
         "Framework :: Django :: 3.2",
         "Framework :: Django :: 4.0",
+        "Framework :: Django :: 4.1",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: Apache Software License",
         "Operating System :: OS Independent",

tests/settings.py

@@ -109,6 +109,10 @@
 USE_TZ = True
 
 
+# https://docs.djangoproject.com/en/dev/ref/settings/#default-auto-field
+DEFAULT_AUTO_FIELD = "django.db.models.AutoField"
+
+
 # Static files (CSS, JavaScript, Images)
 # https://docs.djangoproject.com/en/1.10/howto/static-files/
 

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 envlist =
-    py{3.7,3.8,3.9,3.10}-django{3.2,4.0}
+    py{3.7,3.8,3.9,3.10}-django{3.2,4.0,4.1}
 
 [testenv]
 commands =
@@ -10,6 +10,7 @@ commands =
 deps =
     django3.2: django~=3.2
     django4.0: django~=4.0
+    django4.1: django==4.1b1
     djangomaster: https://github.com/django/django/archive/master.tar.gz
     .