Docs For Class Passwd

Description

Passwd_Driver:: defines an API for implementing password change systems for Passwd.

$Horde: passwd/lib/Driver.php,v 1.44.2.10 2009/01/06 15:25:15 jan Exp $

See the enclosed file COPYING for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.php.

author: Eric Rostetter <eric.rostetter@physics.utexas.edu>
author: Mike Cochrane <mike@graftonhall.co.nz>
since: Passwd 2.1

Located in /lib/Driver.php (line 18)

Direct descendents

Class	Description
Passwd_Driver_adsi	The ADSI class changes a user's password on any Windows Machine/NT-Domain using the ADSI COM Interface.
Passwd_Driver_composite	The composite class chains other drivers together to change and a user's password stored on various backends.
Passwd_Driver_expect	The Passwd_expect class provides an expect implementation of the passwd system.
Passwd_Driver_expectpecl	The Passwd_expectpecl class provides an PECL expect implementation of the Passwd system.
Passwd_Driver_http	The http driver attempts to change a user's password via a web based interface and implements the Passwd_Driver API.
Passwd_Driver_kolab	The Kolab class attempts to change a user's password on the designated Kolab backend. Based off the LDAP passwd class.
Passwd_Driver_ldap	The LDAP class attempts to change a user's password stored in an LDAP directory service.
Passwd_Driver_pine	The pine class attempts to change a user's password on a in a pine password file.
Passwd_Driver_poppassd	The poppassd class attempts to change a user's password via a poppassd server.
Passwd_Driver_procopen	The Passwd_procopen class provides a procopen implementation of the passwd system.
Passwd_Driver_pspasswd	The PSPasswd class changes a user's password on any Windows Machine (NT+) using the pspasswd free utility available at Sysinternals website: http://www.sysinternals.com/ntw2k/freeware/pspasswd.shtml
Passwd_Driver_servuftp	The serv-u ftp class attempts to change a user's password via the SITE PSWD command used by Serv-u ftpd for windows.
Passwd_Driver_smbpasswd	The smbpassd class attempts to change a user's password on a samba server.
Passwd_Driver_soap	The SOAP driver attempts to change a user's password through a SOAP request.
Passwd_Driver_sql	The SQL driver attempts to change a user's password stored in an SQL databse and implements the Passwd_Driver API.
Passwd_Driver_vmailmgr	The vmailmgr class attempts to change a user's password on a local vmailmgr daemon
Passwd_Driver_vpopmail	The vpopmail class attempts to change a user's password for vpopmail based servers. It is very similar to the more generic sql driver, and the two should probably be merged into one driver if possible.

Variable Summary

string $_errorstr

array $_params

Method Summary

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

boolean changePassword (string $username, string $oldpassword, string $new_password)

mixed comparePasswords ( $encrypted, $plaintext)

string encryptPassword (string $plaintext)

mixed factory (string $driver, [array $params = array()])

Variables

string $_errorstr (line 32)

Error string that will be returned to the user if an error occurs.

array $_params = array() (line 25)

Hash containing configuration parameters.

Methods

Constructor Passwd_Driver (line 39)

Constructs a new expect Passwd_Driver object.

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

$params $params: A hash containing connection parameters.

changePassword (line 99)

Change the user's password.

return: True or false based on success of the change.

boolean changePassword (string $username, string $oldpassword, string $new_password)

string $username: The user for which to change the password.
string $oldpassword: The old (current) user password.
string $new_password: The new user password to set.

Redefined in descendants as:

Passwd_Driver_adsi::changePassword()
Passwd_Driver_composite::changePassword() : Change the user's password.
Passwd_Driver_expect::changePassword() : Change the users password by executing an expect script.
Passwd_Driver_expectpecl::changePassword() : Changes the users password by executing an expect script.
Passwd_Driver_http::changePassword() : Change the user's password.
Passwd_Driver_kolab::changePassword() : Changes the user's password.
Passwd_Driver_ldap::changePassword() : Changes the user's password.
Passwd_Driver_smbldap::changePassword() : Change the user's password.
Passwd_Driver_pine::changePassword() : Change the user's password.
Passwd_Driver_poppassd::changePassword() : Change the user's password.
Passwd_Driver_procopen::changePassword() : Change the user's password by executing a user supplied command.
Passwd_Driver_pspasswd::changePassword()
Passwd_Driver_servuftp::changePassword()
Passwd_Driver_smbpasswd::changePassword() : Changes the user's password.
Passwd_Driver_soap::changePassword() : Changes the user's password.
Passwd_Driver_sql::changePassword() : Change the user's password.
Passwd_Driver_vmailmgr::changePassword() : Change the user's password.
Passwd_Driver_vpopmail::changePassword() : Change the user's password.

comparePasswords (line 49)

Compare a plaintext password with an encrypted password.

return: True if they match, PEAR_Error if they differe.

mixed comparePasswords ( $encrypted, $plaintext)

$encrypted
$plaintext

encryptPassword (line 82)

Format a password using the current encryption.

return: The crypted password.

string encryptPassword (string $plaintext)

string $plaintext: The plaintext password to encrypt.

factory (line 120)

Attempts to return a concrete Passwd_Driver instance based on $driver.

return: The newly created concrete Passwd_Driver instance, or false on an error.

mixed factory (string $driver, [array $params = array()])

string $driver: The type of concrete passwd_Driver subclass to return. The is based on the passwd driver ($driver). The code is dynamically included.
array $params: (optional) A hash containing any additional configuration or connection parameters a subclass might need.