$_capabilities
$_capabilities : array
An array of capabilities, so that the driver can report which operations it supports and which it doesn't.
The Horde_Auth_Radius class provides a RADIUS implementation of the Horde authentication system.
This class requires the 'radius' PECL extension: http://pecl.php.net/package/radius
__construct(array $params = array())
Constructor.
| array | $params | Connection parameters.
'host' - (string) [REQUIRED] The RADIUS host to use (IP address or
fully qualified hostname).
'method' - (string) [REQUIRED] The RADIUS method to use for validating
the request.
Either: 'PAP', 'CHAP_MD5', 'MSCHAPv1', or 'MSCHAPv2'.
** CURRENTLY, only 'PAP' is supported. **
'nas' - (string) The RADIUS NAS identifier to use.
DEFAULT: The value of $_SERVER['HTTP_HOST'] or, if not
defined, then 'localhost'.
'port' - (integer) The port to use on the RADIUS server.
DEFAULT: Whatever the local system identifies as the
'radius' UDP port
'retries' - (integer) The maximum number of repeated requests to make
before giving up.
DEFAULT: 3
'secret' - (string) [REQUIRED] The RADIUS shared secret string for the
host. The RADIUS protocol ignores all but the leading 128
bytes of the shared secret.
'suffix' - (string) The domain name to add to unqualified user names.
DEFAULT: NONE
'timeout' - (integer) The timeout for receiving replies from the server
(in seconds).
DEFAULT: 3
|
authenticate(string $userId, array $credentials, boolean $login = true) : boolean
Finds out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.
| string | $userId | The userId to check. |
| array | $credentials | The credentials to check. |
| boolean | $login | Whether to log the user in. If false, we'll only test the credentials and won't modify the current session. Defaults to true. |
Whether or not the credentials are valid.
isLocked(string $userId, boolean $show_details = false) : boolean|array
Returns whether a user is currently locked.
| string | $userId | The user to check. |
| boolean | $show_details | Return timeout too? |
If $show_details is a true, an array with 'locked' and 'lock_timeout' values. Whether the user is locked, otherwise.
transparent() : boolean
Automatic authentication.
Transparent authentication should set 'userId', 'credentials', or 'params' in $this->_credentials as needed - these values will be used to set the credentials in the session.
Transparent authentication should normally never throw an error - false should be returned.
Whether transparent login is supported.
getCredential(mixed $name = null) : mixed
Returns internal credential value(s).
| mixed | $name | The credential value to get. If null, will return the entire credential list. Valid names:
|
The credential information, or null if the credential doesn't exist.
_sort(array $users, boolean $sort) : array
Basic sort implementation.
If the backend has listUsers and doesn't have a native sorting option, fall back to this method.
| array | $users | An array of usernames. |
| boolean | $sort | Whether to sort or not. |
the users, sorted or not
_authenticate(string $username, array $credentials)
Find out if a set of login credentials are valid.
On failure, Horde_Auth_Exception should pass a message string (if any) in the message field, and the HordeAuth::REASON* constant in the code field (defaults to Horde_Auth::REASON_MESSAGE).
| string | $username | The userId to check. |
| array | $credentials | An array of login credentials. For radius, this must contain a password entry. |