\Horde_Imsp_Auth_CramMd5

IMSP authentication class for CRAM-MD5 authentication.

Required parameters:

'username'  Username to logon to IMSP server as.
'password'  Password for current user.
'server'    The hostname of the IMSP server.
'port'      The port of the IMSP server.

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()
getDriverType()
logout()

No public properties found

No constants found

_authenticate()
_hmac()

$_params
$_imsp

N/A

No private methods found

No private properties found

N/A

File: Auth/CramMd5.php
Package: Horde_Imsp
Class hierarchy: \Horde_Imsp_Auth_Base

\Horde_Imsp_Auth_CramMd5

Properties

$_params

$_params :

Type

$_imsp

$_imsp : \Horde_Imsp_Client_Base

Class variable to hold the resulting Horde_Imsp object

Type

\Horde_Imsp_Client_Base

Methods

__construct()

__construct(array  $params = array())

Constructor

Parameters

array

$params

authenticate()

authenticate(\Horde_Imsp_Client_Base  $client, boolean  $login = true) : boolean

Attempts to login to IMSP server.

Parameters

\Horde_Imsp_Client_Base	$client	The Imsp client connection.
boolean	$login	Remain logged in after auth?

Returns

boolean

getDriverType()

getDriverType() : string

Return the driver type

Returns

string —

the type of this IMSP_Auth driver

logout()

logout()

Force a logout command to the imsp stream.

_authenticate()

_authenticate() : boolean

Private authentication function. Provides actual authentication code.

Returns

boolean

_hmac()

_hmac(string  $key, string  $data) : string

RFC 2104 HMAC implementation.

Parameters

string	$key	The HMAC key.
string	$data	The data to hash with the key.

Returns

string —

The MD5 HMAC.