LSauth : Recasted - Creation of LSauthMethod class
[ldapsaisie.git] / public_html / includes / class / class.LSauthMethod.php
1 <?php
2 /*******************************************************************************
3  * Copyright (C) 2007 Easter-eggs
4  * http://ldapsaisie.labs.libre-entreprise.org
5  *
6  * Author: See AUTHORS file in top-level directory.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License version 2
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
20
21 ******************************************************************************/
22
23 /**
24  * Base of a authentication provider for LSauth
25  *
26  * @author Benjamin Renard <brenard@easter-eggs.com>
27  */
28 class LSauthMethod {
29
30   var $authData = array();
31   
32   function LSauthMethod() {
33                 // Load config
34                 LSsession :: includeFile(LS_CONF_DIR."LSauth/config.".get_class($this).".php");
35                 LSdebug(LS_CONF_DIR."LSauth/config.".get_class($this).".php");
36                 return true;
37         }
38
39   /**
40    * Check Auth Data
41    * 
42    * Return authentication data or false
43    * 
44    * @retval Array|false Array of authentication data or False
45    **/
46   public function getAuthData() {
47     // Do nothing in the standard LSauthMethod class
48     // This method have to define $this -> authData['username']
49     return false;
50   }
51   
52   /**
53    * Check authentication
54    *
55    * @retval LSldapObject|false The LSldapObject of the user authificated or false 
56    */
57   public function authenticate() {
58     if (LSsession :: loadLSobject(LSsession :: $ldapServer['authObjectType'])) {
59       $authobject = new LSsession :: $ldapServer['authObjectType']();
60                         $result = $authobject -> searchObject(
61                                 $this -> authData['username'],
62                                 LSsession :: getTopDn(),
63                                 LSsession :: $ldapServer['authObjectFilter']
64                         );
65                         $nbresult=count($result);
66                         
67                         if ($nbresult==0) {
68                                 // incorrect login
69                                 LSdebug('identifiant incorrect');
70                                 LSerror :: addErrorCode('LSauth_01');
71                         }
72                         else if ($nbresult>1) {
73                                 // duplication of identity
74                                 LSerror :: addErrorCode('LSauth_02');
75                         }
76                         else {
77                                 return $result[0];
78                         }
79     }
80     else {
81       LSerror :: addErrorCode('LSauth_03');
82     }
83     return;
84   }
85   
86  /**
87   * Logout
88   * 
89   * @retval boolean True on success or False
90   **/
91   public function logout() {
92      // Do nothing in the standard LSauthMethod class
93      return true;
94   }
95   
96 }
97
98 ?>