Documentation

Passwd_Driver
in package

The API for implementing password change systems for Passwd.

Tags
author

Mike Cochrane mike@graftonhall.co.nz

author

Eric Rostetter eric.rostetter@physics.utexas.edu

category

Horde

copyright

2002-2017 Horde LLC

license

http://www.horde.org/licenses/gpl GPL

Table of Contents

$_params  : array<string|int, mixed>
Hash containing configuration parameters.
__construct()  : mixed
Constructor.
changePassword()  : mixed
Changes the user's password.
_changePassword()  : mixed
Changes the user's password.
_comparePasswords()  : mixed
Compares a plaintext password with an encrypted password.
_encryptPassword()  : string
Encrypts a password.

Properties

$_params

Hash containing configuration parameters.

protected array<string|int, mixed> $_params = array()

Methods

__construct()

Constructor.

public __construct([ $params = array() ]) : mixed
Parameters
$params : = array()

A hash containing connection parameters.

Return values
mixed

changePassword()

Changes the user's password.

public changePassword(string $user, string $oldpass, string $newpass) : mixed
Parameters
$user : string

The user for which to change the password.

$oldpass : string

The old (current) user password.

$newpass : string

The new user password to set.

Tags
throws
Passwd_Exception
Return values
mixed

_changePassword()

Changes the user's password.

protected abstract _changePassword(string $user, string $oldpass, string $newpass) : mixed
Parameters
$user : string

The user for which to change the password (converted to backend username).

$oldpass : string

The old (current) user password.

$newpass : string

The new user password to set.

Tags
throws
Passwd_Exception
Return values
mixed

_comparePasswords()

Compares a plaintext password with an encrypted password.

protected _comparePasswords(string $encrypted, string $plaintext) : mixed
Parameters
$encrypted : string

An encrypted password.

$plaintext : string

An unencrypted password.

Tags
throws
Passwd_Exception

if passwords don't match.

Return values
mixed

_encryptPassword()

Encrypts a password.

protected _encryptPassword(string $plaintext) : string
Parameters
$plaintext : string

A plaintext password.

Return values
string

The encrypted password.

Search results