PHP Class Horde_Auth_Http, horde

Author: Chuck Hagenbuch ([email protected])
Inheritance: extends Horde_Auth_Base
Show file Open project: horde/horde

Protected Properties

Property Type Description
$_capabilities array An array of capabilities, so that the driver can report which operations it supports and which it doesn't.
$_users array Array of usernames and hashed passwords.

Public Methods

Method Description
__construct ( array $params = [] ) Constructor.
listUsers ( boolean $sort = false ) : array Lists all users in the system.
transparent ( ) : boolean Automatic authentication: Find out if the client has HTTP authentication info present.

Protected Methods

Method Description
_authenticate ( string $userId, array $credentials ) Find out if a set of login credentials are valid. Only supports htpasswd files with DES passwords right now.

Method Details

__construct() public method

Constructor.
public __construct ( array $params = [] )
$params array Optional parameters:
'encryption' - (string) Kind of passwords in the .htpasswd file.
               Either 'crypt-des' (standard crypted htpasswd entries)
               [DEFAULT] or 'aprmd5'. This information is used if
               you want to directly authenticate users with this
               driver, instead of relying on transparent auth.
'htpasswd_file' - (string) TODO

_authenticate() protected method

Find out if a set of login credentials are valid. Only supports htpasswd files with DES passwords right now.
protected _authenticate ( string $userId, array $credentials )
$userId string The userId to check.
$credentials array An array of login credentials. For IMAP, this must contain a password entry.

listUsers() public method

Lists all users in the system.
public listUsers ( boolean $sort = false ) : array
$sort boolean Sort the users?
return array The array of userIds.

transparent() public method

Automatic authentication: Find out if the client has HTTP authentication info present.
public transparent ( ) : boolean
return boolean Whether or not the client is allowed.

Property Details

$_capabilities protected property

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

$_users protected property

Array of usernames and hashed passwords.
protected array $_users
return array