SAML2 SSO Auth
SAML2 SSO Auth 3.5.5
Code prechecksHTML | XML
Moodle authentication using exists SimpleSAMLphp Service Provider
You'll need the following pre-requirement:
- A working SimpleSAMLphp Service Provider (SP) installation (https://simplesamlphp.org) working means that the metadata from SP must be registered in Identity Provider (IdP). Can be found in /config/authsources.php
- The absolute path for the SimpleSAMLphp installation on server (autodetected if the Apache enviroment variable is set)
- The authsource name from SP in which your users will authenticate against
You are strongly encouraged to use a SimpleSAMLphp session storage other than the default phpsession.
There are other SAML plugins for Moodle and the panorama could be confusing. Below are the main differences between this plugin, named internally as auth_saml2sso, and the others:
- official Shibboleth plugin - Requires a system-level configuration, uses a long-running process, easily protects resource at Apache level, cannot exploit PHP skill, hard to configure for servers hosting multiple Moodle if requirements of each site are different.
- SAML Authentication (auth_saml) - There's no compatible version with Moodle 3.0+. The code is obsolete and the plugin go beyond the purpose of a authentication plugin, mixing auth and enrol rules.
- SAML2 Single sign on (auth_saml2) - It's a complete solution for those that don't have a working SP installation, but, because it generate its own SP, for every single instance of Moodle that you install, you must exchange the metadata with the owner of the IdP. In a environment that there are more than one IdP, this is unpractical.
- OneLogin SAML SSO (onelogin_saml) - Based on OneLogin libraries, features similar to auth_saml2
The key for this plugin is that you can use your exists Service Provider (SP) without needed to exchange the metadata with the Identity Provider (IdP) for every new Moodle instances. (for instances in the same host name)
The following options can be set in config:
- SimpleSAMLphp installation path
- Dual login (Yes/No) - Can login with manual accounts like admin
- Single Sign Off (Yes/No) - Should we sign off users from Moodle and IdP?
- Username mapping - Which attribute from IdP should be used for username
- Username checking - Where to check if the username exists
- Auto create users - Allow create new users
- SP source name - Generally default-sp in SimpleSAMLphp
- Logout URL to redirect users after logout
- User synchronization source (see below)
- Allow users to edit or not the profile
- ~~Ability to break the full name from IdP into firstname and lastname~~ deprecated, see below
To override the authentication and login directly in Moodle (ex.: using admin account), add the
saml=off parameter in the URL (ex.: https://my.moodle/login/index.php?saml=off)
Split the full name from IdP
One of the distinctive feature of the first release of SAML2 SSO plugin was the ability to break the full name from IdP into the first name and the last name. It was related to the old version of Moodle auth base plugin. Nowadays, adminting there are some IdPs still serving the full name and not the first and last name (such as givenName and sn in LDAP idiom) you can use a SimpleSAMLphp authproc.
For example, in order to replicate the old behaviour if you receive the full name in the attribute urn:oid:22.214.171.124 (e.g. from a Shibboleth IdP) you can add to the authsource or to the IdP metadata:
'authproc' => array( array( 'class' => 'core:PHP', 'code' => ' // First name attribute $attributes["givenName"] = strstr($attributes["urn:oid:126.96.36.199"], " ", true) ? strtoupper(trim(strstr($attributes["urn:oid:188.8.131.52"], " ", true))) : strtoupper(trim($attributes["urn:oid:184.108.40.206"])); // Last name attribute $attributes["sn"] = strstr($attributes["urn:oid:220.127.116.11"], " ") ? strtoupper(trim(strstr($attributes["urn:oid:18.104.22.168"], " "))) : strtoupper(trim($attributes["urn:oid:22.214.171.124"])); ', ),
Or, to emulate it in a compact way:
'authproc' => array( 15 => array( 'class' => 'core:AttributeAlter', 'subject' => 'urn:oid:126.96.36.199', 'pattern' => '/^([^ ]+)/', 'target' => 'givenName', '%replace', ), 16 => array( 'class' => 'core:AttributeAlter', 'subject' => 'urn:oid:188.8.131.52', 'pattern' => '/([^\\s]+)$/', 'target' => 'sn', '%replace', ),
And then mapping the attribute
sn as usual.
See the SimpleSAMLphp documentation on Authproc.
SAML-based authentication services couldn't provide a user list suitable for users synchronization. But, in scenarios with a single IdP within the same organization (no discovery nor federation) is common that the IdP uses LDAP or a SQL DB as authentication backend.
You can configure the LDAP or DB Moodle auth plugin in order to access to that backend, leaving the plugin itself disabled, and configure SAML2 SSO auth to obtain user list from it.
How to migrate users from another plugin to SAML2SSO
A special page handles user migration from plugin based on external backend to SAML2SSO. Users handled by the internal Moodle authentication cannot migrate because no "authority" can guarantee match between Moodle username and SSO one.
As described in the introduction, some plugins is not compatible with recent Moodle releases. The migration feature take in account even users belongin to missing plugins.
Using other authsources
SimpleSAMLphp is more than a SAML library: it is also an adapter layer that can handle several auth sources in a uniform way.
Then SAML2SSO plugin can seamless authenticate against Facebook, LinkedIn, Twitter, advanced LDAP and multi-LDAP sources, .htpasswd files, etc.
See SimpleSAMLphp manual for more documentation.
- Version build number
- Version release name
- Stable version
- MD5 Sum
- Supported software
- Moodle 3.5, Moodle 3.6, Moodle 3.7
Version control information
- Version control system (VCS)
- VCS repository URL
- VCS tag
Default installation instructions for plugins of the type Authentication
- Make sure you have all the required versions.
- Download and unpack the module.
- Place the folder (eg "myauth") in the "auth" subdirectory.
- Visit http://yoursite.com/admin to finish the installation