Horde_Imap_Client_Auth_Scram
in package
Provides authentication via the SCRAM SASL mechanism (RFC 5802 [3]).
Tags
Table of Contents
- $_authmsg : string
- AuthMessage (RFC 5802 [3]).
- $_hash : string
- Hash name.
- $_iterations : int
- Number of Hi iterations (RFC 5802 [2]).
- $_nonce : string
- Nonce.
- $_pass : string
- Password.
- $_salt : string
- Server salt.
- $_serversig : string
- Calculated server signature value.
- $_user : string
- Username.
- __construct() : mixed
- Constructor.
- getClientFinalMessage() : string
- Return the final client message.
- getClientFirstMessage() : string
- Return the initial client message.
- parseServerFinalMessage() : bool
- Process the final server message response.
- parseServerFirstMessage() : bool
- Process the initial server message response.
Properties
$_authmsg
AuthMessage (RFC 5802 [3]).
protected
string
$_authmsg
$_hash
Hash name.
protected
string
$_hash
$_iterations
Number of Hi iterations (RFC 5802 [2]).
protected
int
$_iterations
$_nonce
Nonce.
protected
string
$_nonce
$_pass
Password.
protected
string
$_pass
$_salt
Server salt.
protected
string
$_salt
$_serversig
Calculated server signature value.
protected
string
$_serversig
$_user
Username.
protected
string
$_user
Methods
__construct()
Constructor.
public
__construct(string $user, string $pass[, string $hash = 'SHA1' ]) : mixed
Parameters
- $user : string
-
Username.
- $pass : string
-
Password.
- $hash : string = 'SHA1'
-
Hash name.
Tags
Return values
mixed —getClientFinalMessage()
Return the final client message.
public
getClientFinalMessage() : string
Return values
string —Final client message.
getClientFirstMessage()
Return the initial client message.
public
getClientFirstMessage() : string
Return values
string —Initial client message.
parseServerFinalMessage()
Process the final server message response.
public
parseServerFinalMessage(string $msg) : bool
Parameters
- $msg : string
-
Final server response.
Return values
bool —False if authentication failed.
parseServerFirstMessage()
Process the initial server message response.
public
parseServerFirstMessage(string $msg) : bool
Parameters
- $msg : string
-
Initial server response.
Return values
bool —False if authentication failed at this stage.