Actions

Difference between revisions of "Authentication plugins"

From LimeSurvey Manual

(newUserSession)
Line 2: Line 2:
  
 
To make creating your own authentication plugin easier, you should extend the abstract [https://github.com/LimeSurvey/LimeSurvey/blob/2.05/application/libraries/PluginManager/AuthPluginBase.php AuthPluginBase] class.
 
To make creating your own authentication plugin easier, you should extend the abstract [https://github.com/LimeSurvey/LimeSurvey/blob/2.05/application/libraries/PluginManager/AuthPluginBase.php AuthPluginBase] class.
 +
 +
To get an idea of the possibilities, check out the three core authentication plugins (check their pages for more information about configuration options):
 +
[https://github.com/LimeSurvey/LimeSurvey/blob/2.05/application/core/plugins/Authdb/Authdb.php Authdb] Database authentication - this is the default method for all new LimeSurvey installations
 +
[https://github.com/LimeSurvey/LimeSurvey/blob/2.05/application/core/plugins/Authwebserver/Authwebserver.php Authwebserver] Webserver authentication
 +
[https://github.com/LimeSurvey/LimeSurvey/blob/2.05/application/core/plugins/AuthLDAP/AuthLDAP.php AuthLDAP] LDAP authentication
  
 
There are 4 events you can subscribe to:
 
There are 4 events you can subscribe to:

Revision as of 15:38, 11 June 2013

An authentication plugin has some additional requirements over a regular plugin. Here we list the requirements.

To make creating your own authentication plugin easier, you should extend the abstract AuthPluginBase class.

To get an idea of the possibilities, check out the three core authentication plugins (check their pages for more information about configuration options): Authdb Database authentication - this is the default method for all new LimeSurvey installations Authwebserver Webserver authentication AuthLDAP LDAP authentication

There are 4 events you can subscribe to:

beforeLogin

This is called first, and can possibly disable the loginform, for example when webserver authentication is used and we trust on that. To do this, use $this->setAuthPlugin()

newLoginForm

Here you can add your own elements to the form. You should add your username/password elements, but could also add a domain selector or anything else you need. This will only be shown when the selected authentication method was chosen on the selector that is added when more then one plugin is present. When your authentication plugin does not need a form, and can not be selected as an option (like webserver authentication) you should not add a form element here.

$this->getEvent()                  // Get the current event
     ->getContent($this)           // Get the content for this plugin
     ->addContent(CHtml::tag(      // And add some content to it
         'li', 
         array(), 
         "<label for='user'>"  . gT("Username") . "</label><input name='user' id='user' type='text' size='40' maxlength='40' value='' />"))
     ->addContent(CHtml::tag(
         'li', 
         array(), 
         "<label for='password'>"  . gT("Password") . "</label><input name='password' id='password' type='password' size='40' maxlength='40' value='' />"));

afterLoginFormSubmit

When the form for this plugin was submitted, this event is called. Here you can handle setting the values to the plugin. This event is also called when there was no form submitted and form display was canceled in the beforeLogin event.

newUserSession

This is where the real authentication takes place. You should use $this->setAuthSuccess($oUser) for a successful attempt and provide a User object. If you fail to do so it will result in an authentication failure. If you need to provide a message about why the authentication failed, you can do so by using $this->setAuthFailure($code, $message) where code is any code other than 0. The code is not used at this moment. The message should be a message in English, localised using the available tools in the plugin api. See the general plugin documenation for more information about that topic.