Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 3.05 KB

README.md

File metadata and controls

48 lines (38 loc) · 3.05 KB
Raw

LimeSurvey-SAML

LimeSurvey authentication plugin for authenticating users against an SAML Identity Provider.

Requirements

  • LimeSurvey 3 to 6 version
  • simpleSAMLphp (configurated)

Installation instructions

  • Create folder AuthSAML inside limesurvey/plugins folder
  • Copy AuthSAML.php from repo folder Limesurvey-SAML-Authentication
  • Paste it inside limesurvey/plugins/AuthSAML folder
  • Configure the plugin from the Plugin Manager
  • Go to Admin > Configuration > Plugin Manager or https:/example.com/index.php/admin/pluginmanager/sa/index and Enable the plugin
  • Place your own custom saml_logo.gif image at imesurvey/assets/images. It will be displayed as the login button

You can clone the repository directly git clone https://github.com/Shnoulle/Limesurvey-SAML-Authentication.git AuthSAML in limesurvey plugin directory.

Configuration options

  • Path to the SimpleSAMLphp folder: path to the simpleSAMLphp installation
  • Does simplesamlphp use cookie as a session storage ?: if simpleSAMLPHP is configured to use cookies as session storage set this to true so the code can handle session conficts between simpleSAMLphp and LimeSurvey
  • SAML authentication source: name of simpleSAMLphp service provider configuration from authsources.php
  • SAML attributed used as username: the attribute returned from the IdP that will be the unique username of the user on LimeSurvey. This attribute MUST NOT change on the IdP. WARNING!!! Please do not allow users to aquire the admin username, because is the super user of LimeSurvey
  • SAML attributed used as email: the attribute returned from the IdP that will be used as an email of the user on LimeSurvey
  • SAML attributed used as name: the attribute returned from the IdP that will be the users human friendly name
  • Auto create users: check if the user exists in the local database and if not the plugin creates the user from the SAML metadata
  • Auto update users: check if IdP has different attribute values for email and name and update them on LimeSurvey
  • Force SAML login: if this is set to true the plugin will force the login path to use only simpleSAMLphp
  • Authtype base: LimeSurvey internal configuration options, use it only if you know what you are doing. Configures where the users data are stored.
  • Storage base: LimeSurvey internal configuration options, use it only if you know what you are doing. Configures where the plugin settings are stored.
  • Logout Redirect URL: configures where should the user be redirected after the logout path

Images

Login Page

Login Page with SAML button

Plugin settings at plugin manager Plugin settings at plugin manager

External material