The Auth_ldap class provides an LDAP implementation of the Horde authentication system.

Required parameters:

   'basedn'       The base DN for the LDAP server.
   'hostspec'     The hostname of the LDAP server.
   'uid'          The username search key.
   'filter'       The LDAP formatted search filter to search for users. This
                  setting overrides the 'objectclass' method below.
   'objectclass'  The objectclass filter used to search for users. Can be a
                  single objectclass or an array.

Optional parameters:

   'binddn'       The DN used to bind to the LDAP server
   'password'     The password used to bind to the LDAP server
   'version'      The version of the LDAP protocol to use.
                  DEFAULT: NONE (system default will be used)

$Horde: framework/Auth/Auth/ldap.php,v 1.47.10.33 2009/10/26 11:58:59 jan Exp $

Copyright 1999-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://opensource.org/licenses/lgpl-license.php.

• author: Jon Parise <jon@horde.org>
• since: Horde 1.3

Located in /Auth/Auth/ldap.php (line 33)

Auth
   |
   --Auth_ldap

array $capabilities = array('add' => true,
'update' => true,
'resetpassword' => false,
'remove' => true,
'list' => true,
'transparent' => false) (line 41)

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

---

Redefinition of:

Auth::$capabilities

An array of capabilities, so that the driver can report which operations it supports and which it doesn't.

resource $_ds (line 53)

LDAP connection handle

Inherited Variables

Inherited from Auth

Auth::$_authCredentials
Auth::$_params

Constructor Auth_ldap (line 60)

Constructs a new LDAP authentication object.

Auth_ldap Auth_ldap ([array $params = array()])

• array $params: A hash containing connection parameters.

addUser (line 337)

Add a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed addUser (string $userId, array $credentials)

• string $userId: The userId to add.
• array $credentials: The credentials to be set.

---

Redefinition of:

Auth::addUser()

Adds a set of authentication credentials.

---

Redefined in descendants as:

• Auth_msad::addUser() : Add a set of authentication credentials.

listUsers (line 556)

List Users

• return: List of Users

array listUsers ()

---

Redefinition of:

Auth::listUsers()

Lists all users in the system.

removeUser (line 396)

Remove a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed removeUser (string $userId)

• string $userId: The userId to add.

---

Redefinition of:

Auth::removeUser()

Deletes a set of authentication credentials.

---

Redefined in descendants as:

• Auth_msad::removeUser() : Remove a set of authentication credentials.

updateUser (line 443)

Update a set of authentication credentials.

• return: True on success or a PEAR_Error object on failure.

mixed updateUser (string $oldID, string $newID, array $credentials)

• string $oldID: The old userId.
• string $newID: The new userId.
• array $credentials: The new credentials

---

Redefinition of:

Auth::updateUser()

Updates a set of authentication credentials.

---

Redefined in descendants as:

• Auth_msad::updateUser() : Update a set of authentication credentials.

Inherited Methods

Inherited From Auth

Auth::addHook()
Auth::addLogoutParameters()
Auth::addUser()
Auth::authenticate()
Auth::clearAuth()
Auth::exists()
Auth::factory()
Auth::genRandomPassword()
Auth::getAuth()
Auth::getAuthDomain()
Auth::getBareAuth()
Auth::getCredential()
Auth::getCryptedPassword()
Auth::getDriver()
Auth::getLoginScreen()
Auth::getLogoutReason()
Auth::getLogoutReasonString()
Auth::getParam()
Auth::getProvider()
Auth::getSalt()
Auth::hasCapability()
Auth::isAdmin()
Auth::isAuthenticated()
Auth::isPasswordChangeRequested()
Auth::listUsers()
Auth::readSessionData()
Auth::removeHook()
Auth::removeUser()
Auth::removeUserData()
Auth::setAuth()
Auth::setCredential()
Auth::singleton()
Auth::transparent()
Auth::updateUser()
Auth::_authenticate()
Auth::_isAdmin()