Horde_Core_ActiveSync_Auth
extends Horde_Auth_Base
in package
The Horde_Core_ActiveSync_Auth class provides a way to combine a globally configured configuration driver with a transparent driver like X509 certificates for ActiveSync authentication. Used to mimic Exchange's ability to require one, the other, or layer basic auth on top of client certs.
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Tags
Table of Contents
Methods
- __construct() : mixed
- Constructor.
- _authenticate() : mixed
- authenticate() : bool
- Find out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.
- hasCapability() : bool
- Query the current Auth object to find out if it supports the given capability.
- transparent() : bool
- Automatic authentication.
Methods
__construct()
Constructor.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
Required parameters:
- base_driver: (Horde_Auth_Base) The globally configured horde auth driver. REQUIRED
- transparent_driver: (Horde_Auth_Base) The driver to perform transparent auth, such as X509. OPTIONAL.
Tags
_authenticate()
public
_authenticate(mixed $userId, mixed $credentials) : mixed
Parameters
- $userId : mixed
- $credentials : mixed
authenticate()
Find out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.
public
authenticate(string $userId, array<string|int, mixed> $credentials[, bool $login = true ]) : bool
Parameters
- $userId : string
-
The userId to check.
- $credentials : array<string|int, mixed>
-
The credentials to check.
- $login : bool = true
-
Whether to log the user in. If false, we'll only test the credentials and won't modify the current session. Defaults to true.
Return values
bool —Whether or not the credentials are valid.
hasCapability()
Query the current Auth object to find out if it supports the given capability.
public
hasCapability(string $capability) : bool
Parameters
- $capability : string
-
The capability to test for.
Return values
bool —Whether or not the capability is supported.
transparent()
Automatic authentication.
public
transparent() : bool
Return values
bool —Whether or not the client is allowed.