Creating an Authentication Plugin for Joomla 1.5 - Revision history

Wilsonge: Add in version

2013-04-19T21:41:07Z

Add in version

Chris Davenport: Reverted edits by MTrapp82 (talk) to last revision by Mvangeest

2011-09-26T20:47:00Z

Reverted edits by MTrapp82 (talk) to last revision by Mvangeest

Show changes

MTrapp82: None

2011-09-26T18:48:30Z

None

Show changes

Mvangeest: Added category

2011-01-14T17:03:52Z

Added category

Mvangeest: Added category and adjusted layout

2011-01-14T17:02:30Z

Added category and adjusted layout

Show changes

Mvangeest: Tutorial:Creating an Authentication Plugin for Joomla 1.5 moved to Creating an Authentication Plugin for Joomla 1.5: Moved page to main namespace because the Tutorial namespace is deprecated

2011-01-14T16:56:49Z

Tutorial:Creating an Authentication Plugin for Joomla 1.5 moved to Creating an Authentication Plugin for Joomla 1.5: Moved page to main namespace because the Tutorial namespace is deprecated

Littlejohn: /* The Complete myauth.php File */

2010-04-29T14:45:46Z

‎The Complete myauth.php File

Littlejohn: /* The onAuthenticate() Method */

2010-04-29T14:39:54Z

‎The onAuthenticate() Method

Leolll: Typo

2009-11-16T23:51:00Z

Typo

Chris Davenport: Fixed bad link.

2009-11-16T23:44:48Z

Fixed bad link.

← Older revision		Revision as of 21:41, 19 April 2013
Line 1:		Line 1:
		+	{{version\|1.5}}
	The new authentication plugin system for Joomla! 1.5 offers a great deal of flexibility and power to the system. Using the new system, it is possible to authenticate users from any source - the Joomla! internal database, the Open ID system, an LDAP directory, or any authentication system that can be accessed using PHP.		The new authentication plugin system for Joomla! 1.5 offers a great deal of flexibility and power to the system. Using the new system, it is possible to authenticate users from any source - the Joomla! internal database, the Open ID system, an LDAP directory, or any authentication system that can be accessed using PHP.

@@ Line 7: / Line 7: @@
 Joomla! 1.5 plugins are created by creating a child class of the JPlugin class. The JPlugin class provides all the infrastructure and basic functionality that is required. All that is necessary is to provide the necessary methods to handle the desired event.
-To create an authentication plugin, the name of the child class must begin with <code>plgAuthentication</code>, and must end with the name of the plugin that is being created. In our case, the plugin is called Myauth, so the class will be called <codeplgAuthenticationMyauth</code>.
+To create an authentication plugin, the name of the child class must begin with <code>plgAuthentication</code>, and must end with the name of the plugin that is being created. In our case, the plugin is called Myauth, so the class will be called <code>plgAuthenticationMyauth</code>.
 The class will have two methods. The first method is the constructor. The second method is the <code>onAuthenticate()</code> method. These methods are actually very simple, as will be demonstrated.
@@ Line 218: / Line 218: @@
 You can also easily test this plugin by packaging it yourself.
 [[Category:Plugin Development]]

@@ Line 129: / Line 129: @@
+      *
       * @access    public
-      * @param    string    $username    Username for authentication
+      * @param     array     $credentials    Array holding the user credentials ('username' and 'password')
-      * @param    string    $password    Password for authentication
+      * @param     array     $options        Array of extra options
-      * @param    object    $response    Authentication response object
+      * @param     object    $response       Authentication response object
       * @return    boolean
       * @since 1.5
       */
-     function onAuthenticate( $username, $password, &$response )
+     function onAuthenticate( $credentials, $options, &$response )
+     {
          /*
@@ Line 147: / Line 147: @@
          $query = 'SELECT `id`'
              . ' FROM #__users'
-             . ' WHERE username=' . $db->quote( $username );
+             . ' WHERE username=' . $db->quote( $credentials['username'] );
          $db->setQuery( $query );
          $result = $db->loadResult();
@@ Line 155: / Line 155: @@
              $response->error_message = 'User does not exist';
+         }
          // to authenticate, the username must exist in the database, and the password should be equal
          // to the reverse of the username (so user joeblow would have password wolbeoj)
-         if($result && ($username == strrev( $password )))
+         if($result && ($credentials['username'] == strrev( $credentials['password'] )))
+         {
              $email = JUser::getInstance($result); // Bring this in line with the rest of the system

@@ Line 38: / Line 38: @@
 $query = 'SELECT `id`'
      . ' FROM #__users'
-     . ' WHERE username=' . $db->quote( $username );
+     . ' WHERE username=' . $db->quote( $credentials['username'] );
 $db->setQuery( $query );
 $result = $db->loadResult();
@@ Line 44: / Line 44: @@
 // to authenticate, the username must exist in the database, and the password should be equal
 // to the reverse of the username (so user joeblow would have password wolbeoj)
-if($result && ($username == strrev( $password )))</source>
+if($result && ($credentials['username'] == strrev( $credentials['password'] )))</source>
 Although this is very basic in our example, this code can be replaced with any code that is necessary to perform the authentication checking that is necessary for your plugin. The flexibility is only limited by what PHP can do.
@@ Line 54: / Line 54: @@
 $query = 'SELECT `id`'
      . ' FROM #__users'
-     . ' WHERE username=' . $db->quote( $username );
+     . ' WHERE username=' . $db->quote( $credentials['username'] );
 $db->setQuery( $query );
 $result = $db->loadResult();
@@ Line 64: / Line 64: @@
 // to authenticate, the username must exist in the database, and the password should be equal
 // to the reverse of the username (so user joeblow would have password wolbeoj)
-if($result && ($username == strrev( $password )))
+if($result && ($credentials['username'] == strrev( $credentials['password'] )))
+{
      $email = JUser::getInstance($result); // Bring this in line with the rest of the system

@@ Line 196: / Line 196: @@
 </install></source>
-You will notice that this file looks very similar to any other Joomla! XML install manifest file. There are a view important things to notice.
+You will notice that this file looks very similar to any other Joomla! XML install manifest file. There are a few important things to notice.
 The first thing to notice is the group attribute on the root element. For authentication plugins, the group attribute must have the value 'authentication'. This tells the Joomla! system to treat your plugin as an authentication plugin.

@@ Line 80: / Line 80: @@
 The error_message property is set in case the authentication is not successful. In our plugin, we set two possible values to this property: "User does not exist", which indicates that our query did not return any results, and "Invalid username and password", which indicates that the password was not the reverse of the username. It should be noted that these values are not returned to the user. For security reasons, the only thing the user will see is a successful login, or a message that says, "Username and password do not match." The Joomla! system can be configured so that these error messages can be stored in a log file for debugging purposes.
-If authentication is successful, we can optionally add information from our authentication source to the response. In this case, we are retrieving the user information from the Joomla! database and storing the email address in the response object. For more information on what data can be stored in the response object, please consult [[http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html|http://api.joomla.org]]. This data can then be used by user plugins in the event it is desired to automatically create users or perform other login tasks.
+If authentication is successful, we can optionally add information from our authentication source to the response. In this case, we are retrieving the user information from the Joomla! database and storing the email address in the response object. For more information on what data can be stored in the response object, please consult [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html http://api.joomla.org]. This data can then be used by user plugins in the event it is desired to automatically create users or perform other login tasks.
 ==== The Complete myauth.php File ====