Guide to Configure Single Sign-On (SSO) between SimpleSAML as IDP and Moodle as SP
SAML Single Sign-On (SSO) for your Moodle site can be achieved using our miniOrange SAML SSO plugin. Our plugin is compatible with all the SAML compliant Identity providers. Here we will go through a step-by-step guide to configure Single Sign-On (SSO) between SimpleSAML as Identity Provider (IdP) and Moodle as Service Provider (SP).
Pre-requisites : Download And Installation
To configure SimpleSAML as IdP with Moodle, you will need to install the miniOrange SAML 2.0 SSO plugin:
miniOrange SAML 2.0 SSO
SSO Single Sign On to Moodle with Azure, Azure B2C, Okta, ADFS, Keycloak, Onelogin, Gsuite, Shibboleth & many SAML IdPs [24/7 SUPPORT]
Tested with 4.0.1
Step 1: Setup SimpleSAML as Identity Provider
Follow the steps below to configure SimpleSAML as IdP
Configure SimpleSAML as IdP
- In the miniOrange SAML 2.0 SSO plugin, navigate to Service Provider Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the Identity Provider.
- In config/config.php, make sure that 'enable.saml20-idp' is true. Example: ‘enable.saml20-idp’ => true
- In metadata/saml20-idp-hosted.php, configure SimpleSAML as Identity Provider like this:
$metadata['__DYNAMIC:1__'] = [
'host' => '__DEFAULT__',
/* X.509 key and certificate. Relative to the cert directory.*/
'privatekey' => '<YOUR_PRIVATE_KEY_FILE_NAME>', //eg. RSA_Private_Key.pem
'certificate' => '<YOUR_PUBLIC_KEY_FILE_NAME>', //eg. RSA_Public_Key.cer
/* Authentication source to use. Configured in 'config/authsources.php'. */
'auth' => '<YOUR_AUTH_SOURCE_NAME>'
]; - In metadata/saml20-sp-remote.php, register your Servider Provider like this:
/* Replace example.com with your wordpress domain name. */
$metadata['https://example.com/miniorange-saml-20-single-sign-on/'] = [
'AssertionConsumerService' => 'https://example.com/',
'SingleLogoutService' => 'https://example.com/',
'NameIDFormat' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress',
'simplesaml.nameidattribute' => 'mail',
'simplesaml.attributes' => true,
'attributes' => array('mail', 'givenname', 'sn', 'memberOf'),
]; - Here, you can also add user attributes you want to send from SimpleSAML to your Service Provider i.e WordPress.
- Go to SimpleSAMLphp homepage of installation.
The URL of an installation can be e.g.: https://service.example.com/simplesaml/ where service.example.com has to be replaced by your SimpleSAMLphp path. (Note: The installation page URL may differ depending on how SimpleSAML installation has been done) - Now go to Federation Tab and click on Show Metadata for SAML 2.0 IdP Metadata.
- You can get the IdP metadata from here which will be required to configure the plugin.
×
![]()
Step 2: Configuring Moodle site as Service Provider
We will go through the steps to setup Moodle as a Service Provider. Here, we will be adding the IdP metadata to configure the plugin.
In the miniOrange SAML SSO plugin, go to the Service Provider Setup tab of the plugin. There are two ways to configure the plugin:
A. By uploading IDP metadata:
- Click on the Upload IDP metadata button.
- Enter the Identity Provider Name.
- You can copy and paste the IdP metadata XML file and click on the Upload Metadata button or use a metadata URL and click on Fetch Metadata.
B.Manual Configuration:
- Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider.
- Click on the Save button to save your configuration.
Step 3: Attribute Mapping
- When the user performs SSO, the NameID value is sent by the Identity Provider. This value is unique for every user.
- To assign by which attribute value the user should authenticate or create, select Email (default) or Username in Login/Create Moodle account by:
- For the plugin to access these attributes, assign the values for Email and Username as 'NameID' (without quotes).
- Click on the Save button to save your configuration.
Step 4: Role Mapping
- In the free plugin, you can choose a default role that will be assigned to all the non-admin users when they perform SSO. [NOTE: Roles will be assigned to new users created by SSO. Existing Moodle users’ roles will not be affected.]
- Go to the Attribute/Role Mapping tab and navigate to the Role Mapping section.
- Select the Default Role and click on the Save button to save your configuration.
Step 5: SSO Settings
- In the plugin, you can add a login widget to enable SP-Initiated SSO on your site.
- Go to the Plugins >> Authentication >> Manage authentication.
- Click on the to enable the plugin visibility.
- Click on the ⬆ to set plugin preference.
In the miniOrange SAML SSO plugin, go to the Service Provider Setup tab of the plugin. There are two ways to configure the plugin:
A. By uploading IDP metadata:
- Click on Upload IDP metadata button.
- Enter the Identity Provider Name
- You can copy and past IdP metadata XML file and click on Upload Metadata button or use a metadata URL and click on Fetch Metadata.
B.Manual Configuration:
- Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider.
- Click on the Save button to save your configuration.
Step 3: Attribute Mapping
- When the user performs SSO, the NameID value is sent by the Identity Provider. This value is unique for every user.
- To assign by which attribute value user should authenticate or create select Email or Username in Login/Create Moodle account by:
- For the plugin to access these attribute assign the Email and Username attribute.
- Addtionally user attributes can be mapped (such as Firstname and Lastname).
- Click on the Save button to save your configuration.
Step 4: Custom Attribute Mapping:
- This feature allows you to map custom attribute sent by the IDP to the Moodle attributes.
- You can add multiple attributes by click on "+" button.
- Click on the Save button to save your configurations.
Step 5: Role Mapping
- This feature allows you to assign and manage roles of the users when they perform SSO. Along with the default Moodle roles, this is compatible with any custom roles as well.
- Group/Role attribute will provide a mapping for the field name which contains role-related information sent by the IDP and will be used for Role Mapping.
- Navigate to role mapping section and provide the mappings for the respective roles.
- For example, If you have a user whose Group/Role attribute value is idp-teacher and you want to assign it to the teacher group then, just provide idp-teacher in the Teacher: field of Role mapping section.
- Click on the Save button to save your configurations.
Step 6: SSO settings
- In the plugin you can add a login widget to enable SP-Initiated SSO on your site.
- Click on Click here link which will redirect to the Manage authentication menu
- Click on the to enable the plugin visibility.
- Click on the ⬆ to set plugin preference.
- To enable auto-redirect from Moodle login page to WordPress site .
- Click on the Enable Auto-redirect to IDP from Moodle login page.
- Note down Backdoor URL it will be useful when SSO fails.
- Click on the Save button to save your configuration.
If you are looking for anything which you cannot find, please drop us an email on samlsupport@xecurify.com
Trending searches:
Hello there!
Need Help? We are right here!
