Class-based views rework

Author: mhindery

README.rst

@@ -634,7 +634,7 @@ following url::
       #  lots of url definitions here
 
       (r'^saml2/', include('djangosaml2.urls')),
-      (r'^test/', 'djangosaml2.views.echo_attributes'),
+      (r'^test/', 'djangosaml2.views.EchoAttributesView.as_view()'),
 
       #  more url definitions
   )

djangosaml2/backends.py

@@ -68,7 +68,7 @@ def _user_lookup_attribute(self) -> str:
             return settings.SAML_DJANGO_USER_MAIN_ATTRIBUTE
         return getattr(self._user_model, 'USERNAME_FIELD', 'username')
 
-    def _extract_user_identifier_params(self, session_info, attributes, attribute_mapping) -> Tuple[str, Optional[Any]]:
+    def _extract_user_identifier_params(self, session_info: dict, attributes: dict, attribute_mapping: dict) -> Tuple[str, Optional[Any]]:
         """ Returns the attribute to perform a user lookup on, and the value to use for it.
             The value could be the name_id, or any other saml attribute from the request.
         """
@@ -89,7 +89,7 @@ def _extract_user_identifier_params(self, session_info, attributes, attribute_ma
 
         return user_lookup_key, self.clean_user_main_attribute(user_lookup_value)
 
-    def _get_attribute_value(self, django_field, attributes, attribute_mapping):
+    def _get_attribute_value(self, django_field: str, attributes: dict, attribute_mapping: dict):
         saml_attribute = None
         logger.debug('attribute_mapping: %s', attribute_mapping)
         for saml_attr, django_fields in attribute_mapping.items():
@@ -136,7 +136,7 @@ def authenticate(self, request, session_info=None, attribute_mapping=None, creat
 
         return user
 
-    def _update_user(self, user, attributes, attribute_mapping, force_save=False):
+    def _update_user(self, user, attributes: dict, attribute_mapping: dict, force_save: bool = False):
         """ Update a user with a set of attributes and returns the updated user.
 
             By default it uses a mapping defined in the settings constant
@@ -249,11 +249,11 @@ def send_user_update_signal(self, user: settings.AUTH_USER_MODEL, attributes: di
 
     def get_attribute_value(self, django_field, attributes, attribute_mapping):
         warnings.warn("get_attribute_value() is deprecated, look at the Saml2Backend on how to subclass it", DeprecationWarning)
-        self._get_attribute_value(django_field, attributes, attribute_mapping)
+        return self._get_attribute_value(django_field, attributes, attribute_mapping)
 
     def get_django_user_main_attribute(self):
         warnings.warn("get_django_user_main_attribute() is deprecated, look at the Saml2Backend on how to subclass it", DeprecationWarning)
-        self._user_lookup_attribute
+        return self._user_lookup_attribute
 
     def get_django_user_main_attribute_lookup(self):
         warnings.warn("get_django_user_main_attribute_lookup() is deprecated, look at the Saml2Backend on how to subclass it", DeprecationWarning)

djangosaml2/conf.py

@@ -14,7 +14,6 @@
 # limitations under the License.
 
 import copy
-from importlib import import_module
 from typing import Callable, Optional, Union
 
 from django.conf import settings

djangosaml2/templatetags/__init__.py

@@ -37,16 +37,18 @@
 from djangosaml2.middleware import SamlSessionMiddleware
 from djangosaml2.signals import post_authenticated, pre_user_save
 from djangosaml2.tests import conf
-from djangosaml2.tests.auth_response import auth_response
-from djangosaml2.tests.utils import SAMLPostFormParser
-from djangosaml2.utils import (get_idp_sso_supported_bindings,
+from djangosaml2.utils import (get_custom_setting,
+                               get_idp_sso_supported_bindings,
                                get_session_id_from_saml2,
                                get_subject_id_from_saml2,
                                saml2_from_httpredirect_request)
 from djangosaml2.views import finish_logout
 from saml2.config import SPConfig
 from saml2.s_utils import decode_base64_and_inflate, deflate_and_base64_encode
 
+from .auth_response import auth_response
+from .utils import SAMLPostFormParser
+
 User = get_user_model()
 
 PY_VERSION = sys.version_info[:2]
@@ -72,7 +74,7 @@ def test_get_config_nonsense_path(self):
             get_config('lalala.nonexisting.blabla')
 
     def test_get_config_missing_function(self):
-        with self.assertRaisesMessage(ImproperlyConfigured, 'Module "djangosaml2.tests" does not define a "nonexisting_function" config loader'):
+        with self.assertRaisesMessage(ImproperlyConfigured, 'Module "djangosaml2.tests" does not define a "nonexisting_function" attribute/class'):
             get_config('djangosaml2.tests.nonexisting_function')
 
 
@@ -138,7 +140,7 @@ def test_get_idp_sso_supported_bindings_noargs(self):
             metadata_file='remote_metadata_one_idp.xml',
         )
         idp_id = 'https://idp.example.com/simplesaml/saml2/idp/metadata.php'
-        self.assertEqual(list(get_idp_sso_supported_bindings())[0], list(settings.SAML_CONFIG['service']['sp']['idp'][idp_id]['single_sign_on_service'].keys())[0])
+        self.assertEqual(get_idp_sso_supported_bindings()[0], list(settings.SAML_CONFIG['service']['sp']['idp'][idp_id]['single_sign_on_service'].keys())[0])
 
     def test_get_idp_sso_supported_bindings_unknown_idp(self):
         settings.SAML_CONFIG = conf.create_conf(
@@ -592,7 +594,7 @@ def _test_metadata(self):
 
         expected_metadata = expected_metadata % valid_until
 
-        response = self.client.get('/metadata/')
+        response = self.client.get(reverse('saml2_metadata'))
         self.assertEqual(response['Content-type'], 'text/xml; charset=utf8')
         self.assertEqual(response.status_code, 200)
         self.assertEqual(response.content, expected_metadata)
@@ -643,33 +645,6 @@ def signal_handler(sender, instance, attributes, user_modified, **kwargs):
 
         pre_user_save.disconnect(dispatch_uid='test_signal')
 
-    def test_idplist_templatetag(self):
-        settings.SAML_CONFIG = conf.create_conf(
-            sp_host='sp.example.com',
-            idp_hosts=['idp1.example.com',
-                       'idp2.example.com',
-                       'idp3.example.com'],
-            metadata_file='remote_metadata_three_idps.xml',
-        )
-        rendered = self.render_template(
-            '{% load idplist %}'
-            '{% idplist as idps %}'
-            '{% for url, name in idps.items %}'
-            '{{ url }} - {{ name }}; '
-            '{% endfor %}'
-            )
-
-        # the idplist is unordered, so convert the result into a set.
-        rendered = set(rendered.split('; '))
-        expected = set([
-            u'https://idp1.example.com/simplesaml/saml2/idp/metadata.php - idp1.example.com IdP',
-            u'https://idp2.example.com/simplesaml/saml2/idp/metadata.php - idp2.example.com IdP',
-            u'https://idp3.example.com/simplesaml/saml2/idp/metadata.php - idp3.example.com IdP',
-            u'',
-        ])
-
-        self.assertEqual(rendered, expected)
-
     def test_sigalg_not_passed_when_not_signing_request(self):
         # monkey patch SAML configuration
         settings.SAML_CONFIG = conf.create_conf(
@@ -754,7 +729,7 @@ def test_custom_conf_loader_from_view(self):
         saml_session_name = getattr(settings, 'SAML_SESSION_COOKIE_NAME', 'saml_session')
         getattr(request, saml_session_name).save()
 
-        response = views.login(request, config_loader_path)
+        response = views.LoginView.as_view(config_loader_path=config_loader_path)(request)
         self.assertEqual(response.status_code, 302)
         location = response['Location']
 

djangosaml2/templatetags/idplist.py

@@ -15,16 +15,9 @@
 from django.conf.urls import include, url
 from django.contrib import admin
 
-from djangosaml2 import views
-
 
 urlpatterns = [
-    url(r'^login/$', views.login, name='saml2_login'),
-    url(r'^acs/$', views.AssertionConsumerServiceView.as_view(), name='saml2_acs'),
-    url(r'^logout/$', views.logout, name='saml2_logout'),
-    url(r'^ls/$', views.logout_service, name='saml2_ls'),
-    url(r'^ls/post/$', views.logout_service_post, name='saml2_ls_post'),
-    url(r'^metadata/$', views.metadata, name='saml2_metadata'),
+    path('saml2/', include('djangosaml2.urls')),
 
     # this is needed for the tests
     url(r'^admin/', include(admin.site.urls)),

djangosaml2/tests/__init__.py

@@ -20,8 +20,8 @@
 urlpatterns = [
     path('login/', views.LoginView.as_view(), name='saml2_login'),
     path('acs/', views.AssertionConsumerServiceView.as_view(), name='saml2_acs'),
-    path('logout/', views.logout, name='saml2_logout'),
-    path('ls/', views.logout_service, name='saml2_ls'),
-    path('ls/post/', views.logout_service_post, name='saml2_ls_post'),
+    path('logout/', views.LogoutInitView.as_view(), name='saml2_logout'),
+    path('ls/', views.LogoutView.as_view(), name='saml2_ls'),
+    path('ls/post/', views.LogoutView.as_view(), name='saml2_ls_post'),
     path('metadata/', views.MetadataView.as_view(), name='saml2_metadata'),
 ]

djangosaml2/tests/urls.py

@@ -15,19 +15,21 @@
 import re
 import urllib
 import zlib
+from typing import Optional
 
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.utils.http import is_safe_url
 from django.utils.module_loading import import_string
+from saml2.config import SPConfig
 from saml2.s_utils import UnknownSystemEntity
 
 
-def get_custom_setting(name, default=None):
+def get_custom_setting(name: str, default=None):
     return getattr(settings, name, default)
 
 
-def available_idps(config, langpref=None):
+def available_idps(config: SPConfig, langpref=None) -> dict:
     if langpref is None:
         langpref = "en"
 
@@ -44,7 +46,7 @@ def available_idps(config, langpref=None):
     }
 
 
-def get_idp_sso_supported_bindings(idp_entity_id=None, config=None):
+def get_idp_sso_supported_bindings(idp_entity_id: Optional[str] = None, config: Optional[SPConfig] = None) -> list:
     """Returns the list of bindings supported by an IDP
     This is not clear in the pysaml2 code, so wrapping it in a util"""
     if config is None:
@@ -60,7 +62,7 @@ def get_idp_sso_supported_bindings(idp_entity_id=None, config=None):
         except IndexError:
             raise ImproperlyConfigured("No IdP configured!")
     try:
-        return meta.service(idp_entity_id, 'idpsso_descriptor', 'single_sign_on_service').keys()
+        return list(meta.service(idp_entity_id, 'idpsso_descriptor', 'single_sign_on_service').keys())
     except UnknownSystemEntity:
         return []
 
@@ -97,8 +99,7 @@ def validate_referral_url(request, url):
 
     if not is_safe_url(url=url, allowed_hosts=saml_allowed_hosts):
         return settings.LOGIN_REDIRECT_URL
-    else:
-        return url
+    return url
 
 
 def saml2_from_httpredirect_request(url):