From 18c1481e8f4867ce1099afb39cdb53df45e50063 Mon Sep 17 00:00:00 2001
From: Yves Serrano <y@yas.ch>
Date: Wed, 19 Sep 2018 11:44:20 +0200
Subject: [PATCH] added optional session_info to create_unknow_user, updated
docs for create_unknow_user
---
README.rst | 20 +++++++++++++++-----
djangosaml2/views.py | 6 +++++-
2 files changed, 20 insertions(+), 6 deletions(-)
diff --git a/README.rst b/README.rst
index be59ec7e..60093a82 100644
--- a/README.rst
+++ b/README.rst
@@ -347,18 +347,28 @@ Another option is to use the SAML2 name id as the username by setting::
You can configure djangosaml2 to create such user if it is not already in
the Django database or maybe you don't want to allow users that are not
in your database already. For this purpose there is another option you
-can set in the settings.py file::
+can set in the settings.py file. This setting is True by default. ::
SAML_CREATE_UNKNOWN_USER = True
-This setting is True by default.
+``SAML_CREATE_UNKNOWN_USER`` can also be a callable with or without the session_info,
+for more flexibility. ::
- ACS_DEFAULT_REDIRECT_URL = reverse_lazy('some_url_name')
+ # example without session_info
+ def only_on_monday():
+ import datetime
+ return datetime.datetime.today().weekday() == 0
+ SAML_CREATE_UNKNOWN_USER = only_on_monday
+
+ # example with session_info and lambda
+ SAML_CREATE_UNKNOWN_USER = lambda session_info: True if 'value' in session_info['ava']['o'] else False
-This setting lets you specify a URL for redirection after a successful
+The ``ACS_DEFAULT_REDIRECT_URL`` setting lets you specify a URL for redirection after a successful
authentication. Particularly useful when you only plan to use
IdP initiated login and the IdP does not have a configured RelayState
-parameter. The default is ``/``.
+parameter. The default is ``/``. ::
+
+ ACS_DEFAULT_REDIRECT_URL = reverse_lazy('some_url_name')
The other thing you will probably want to configure is the mapping of
SAML2 user attributes to Django user attributes. By default only the
diff --git a/djangosaml2/views.py b/djangosaml2/views.py
index b71f3218..19e7e573 100644
--- a/djangosaml2/views.py
+++ b/djangosaml2/views.py
@@ -15,6 +15,7 @@
import base64
import logging
+import inspect
from django.conf import settings
from django.contrib import auth
@@ -304,7 +305,10 @@ def assertion_consumer_service(request,
if callable(attribute_mapping):
attribute_mapping = attribute_mapping()
if callable(create_unknown_user):
- create_unknown_user = create_unknown_user()
+ if len(inspect.getargspec(create_unknown_user).args) == 1:
+ create_unknown_user = create_unknown_user(session_info)
+ else:
+ create_unknown_user = create_unknown_user()
logger.debug('Trying to authenticate the user. Session info: %s', session_info)
user = auth.authenticate(request=request,