API Documentation
\

\Horde_Core_ActiveSync_Auth

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.

Summary

Methods
Properties
Constants
__construct()
authenticate()
_authenticate()
hasCapability()
transparent()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(array  $params = array())

Constructor.

Parameters

array $params

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.

Throws

\InvalidArgumentException

authenticate()

authenticate(string  $userId, array  $credentials, boolean  $login = true) : boolean

Find out if a set of login credentials are valid, and if requested, mark the user as logged in in the current session.

Parameters

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.

Returns

boolean —

Whether or not the credentials are valid.

_authenticate()

_authenticate(  $userId,   $credentials)

Parameters

$userId
$credentials

hasCapability()

hasCapability(string  $capability) : boolean

Query the current Auth object to find out if it supports the given capability.

Parameters

string $capability

The capability to test for.

Returns

boolean —

Whether or not the capability is supported.

transparent()

transparent() : boolean

Automatic authentication.

Returns

boolean —

Whether or not the client is allowed.