Moodle plugins directory: SAML2 Single sign on | Moodle.org
SAML2 Single sign on
Brendan Heywood, 
Rossco HellmansWhat is this?
This plugin does authentication, user auto creation with field mapping.
Why is it better?
- 100% configured in the Moodle GUI - no installation of a whole separate app, and no touching of config files or generating certificates.
- Minimal configuration needed, in most cases just copy the IdP metadata in and then give the SP metadata to your IdP admin and that's it.
- Fast! - 3 redirects instead of 7
- Supports back channel Single Logout which most big organisations require (unlike OneLogin)
How does it work?
It completely embeds a SimpleSamlPHP instance as an internal dependancy which is dynamically configured the way it should be and inherits almost all of it's configuration from Moodle configuration. In the future we should be able to swap to a different internal SAML implementation and the plugin GUI shouldn't need to change at all.
Features
- Dual login VS forced login for all as an option, with ?saml=off on the login page for manual accounts, and ?saml=on supported everywhere to deep link and force login via saml if dual auth is on.
- SAML attributes to Moodle user field mapping
- Automatic certificate creation
- Optionally auto create users
Features not yet implemented:
- Enrolment - this should be an enrol plugin and not in an auth plugin
- Role mapping - not yet implemented
Installation
1) Install the plugin the same as any standard moodle plugin either via the Moodle plugin directory, or you can use git to clone it into your source:
git clone git@github.com:catalyst/moodle-auth_saml2.git auth/saml2
2) Then run the Moodle upgrade 3) If your IdP has a publicly available XML descriptor, copy this url into the SAML2 auth config settings page 4) If your IdP requires whitelisting each SP then in the settings page is links to download the XML, or you can provide that url to your IdP administrator.
For most simple setups this is enough to get authentication working, there are many more settings to define how to handle new accounts, dual authentication, and to easily debug the plugin if things are not working.
If you have issues please log them in github here:
https://github.com/catalyst/moodle-auth_saml2/issues
Or if you want paid support please contact Catalyst IT Australia:
https://www.catalyst-au.net/contact-us
Testing
This plugin has been tested against:
- SimpleSamlPHP set up as an IdP
- openidp.feide.no
- testshib.org
- An AAF instance of Shibboleth
Other SAML plugins
The diversity and variable quality and features of SAML Moodle plugins is a reflection of a great need for a solid SAML plugin, but the neglect to do it properly in core. SAML2 is by far the most robust and supported protocol across the internet and should be fully integrated into moodle core as both a Service Provider and as an Identity Provider, and without any external dependencies to manage.
Here is a quick run down of the alternatives:
Core:
- /auth/shibboleth - This requires a separately installed and configured Shibbolleth install
One big issue with this, and the category below, is as there is a whole extra application between moodle and the IdP, so the login and logout processes have more latency due to extra redirects. Latency on potentially slow mobile networks is by far the biggest bottle neck for login speed and the biggest complaint by end users in our experience.
Plugins that require SimpleSamlPHP
These are all forks of each other, and unfortunately have diverged quite early or have no common git history making it difficult to cross port features or fixes between them.
Plugins which embed a SAML client lib:
These are generally much easier to manage and configure as they are standalone.
https://moodle.org/plugins/view/auth_onelogin_saml - This one uses it's own embedded saml library which is great and promising, however it doesn't support 'back channel logout' which is critical for security in any large organisation.
This plugin, with an embedded and dynamically configured SimpleSamlPHP instance under the hood
Warm thanks
Thanks to the various authors and contributors to the other plugins above.
Thanks to LaTrobe university in Melbourne for sponsoring the initial creation of this plugin:
Thanks to Centre de gestion informatique de l’éducation in Luxembourg for sponsoring the user autocreation and field mapping work:
This plugin was developed by Catalyst IT Australia:
Screenshots
Contributors
There's a problem with Moodle Mobile Application occured while using SAML2 authentication..
In the SAML2 settings, it si enabled for Dual login and e-mail logins are allowed..
Desktop system is working properly.. But Mobile application could not be logged in..
Moodle 3.7.2 and SAML2 plugin version 2018071100.
Is there any way to fix Mobile application login problem via Saml2?
(Btw, if SAML2 disabled, normal login is working on Mobile app.)
Do you have 'typeoflogin' in your moodle settings set correctly?
See: https://docs.moodle.org/en/Moodle_app_guide_for_admins#Mobile_authentication
Does anyone know if this plugin supports "auto certificate rollover".
If so does this require extra configuration?
auth_saml2 | sspversion
1.15.4). Upgrading Moodle to 3.8, it still works.
However, I am trying to duplicate the setup to a new server, running Moodle 3.8 and the latest SAML2 (1.17.7). Now I get
Exception - Failure Signing Data: error:23077074:PKCS12 routines:PKCS12_pbe_crypt:pkcs12 cipherfinal error - SHA256
Does anyone know what causes such error? Missing dependency?
I checked with the idP, and apparently, the idP is never contacted.
I do notice that there is a new key entry in the SAML2 config page in the last version. Does that need attention?
I´m trying to use this plugin with my moodle instance but I don´t understand what this line is supposed to be set to $CFG->auth_saml2_disco_url = '';
I also get an error when I try to log in saying "Redis server went away". Anyone know what that means?
The Redis server is fine.
Appreciate any help!
Thanks
I am also trying to configure the auto creation of users, the attributes are incorporated correctly, but the user isn't created, it sends me to the user modification website. I have read in your github about this problem and you recommend changing the user provisioning process, but I don't understand, what do you mean by that.
Thanks for your attention and time.
I am unable to install this plugin on version 3.8. It is a Debian VM on Azure. After I enabled debugging it gave me the "maximum execution time of 30 seconds exceeded" so I have increased it to 160 in PHP config file and now the page just throws "This page isn't working..... didn't send any data....ERR_EMPTY_RESPONSE". I have no issues with any other plugins.
Thanks for any suggestions.