API Documentation
\

\Horde_Imap_Client_Auth_Scram

Provides authentication via the SCRAM SASL mechanism (RFC 5802 [3]).

Summary

Methods
Properties
Constants
__construct()
getClientFirstMessage()
parseServerFirstMessage()
getClientFinalMessage()
parseServerFinalMessage()
No public properties found
No constants found
No protected methods found
$_authmsg
$_hash
$_iterations
$_nonce
$_pass
$_salt
$_serversig
$_user
N/A
No private methods found
No private properties found
N/A

Properties

$_authmsg

$_authmsg : string

AuthMessage (RFC 5802 [3]).

Type

string

$_hash

$_hash : string

Hash name.

Type

string

$_iterations

$_iterations : integer

Number of Hi iterations (RFC 5802 [2]).

Type

integer

$_nonce

$_nonce : string

Nonce.

Type

string

$_pass

$_pass : string

Password.

Type

string

$_salt

$_salt : string

Server salt.

Type

string

$_serversig

$_serversig : string

Calculated server signature value.

Type

string

$_user

$_user : string

Username.

Type

string

Methods

__construct()

__construct(string  $user, string  $pass, string  $hash = 'SHA1')

Constructor.

Parameters

string $user

Username.
string $pass

Password.
string $hash

Hash name.

Throws

\Horde_Imap_Client_Exception

getClientFirstMessage()

getClientFirstMessage() : string

Return the initial client message.

Returns

string —

Initial client message.

parseServerFirstMessage()

parseServerFirstMessage(string  $msg) : boolean

Process the initial server message response.

Parameters

string $msg

Initial server response.

Returns

boolean —

False if authentication failed at this stage.

getClientFinalMessage()

getClientFinalMessage() : string

Return the final client message.

Returns

string —

Final client message.

parseServerFinalMessage()

parseServerFinalMessage(string  $msg) : boolean

Process the final server message response.

Parameters

string $msg

Final server response.

Returns

boolean —

False if authentication failed.