PHP Class Horde_Imap_Client_Auth_Scram, horde

Since: 2.29.0
Author: Michael Slusarz ([email protected])
Exibir arquivo Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_authmsg string AuthMessage (RFC 5802 [3]).
$_hash string Hash name.
$_iterations integer 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.

Public Methods

Method Description
__construct ( string $user, string $pass, string $hash = 'SHA1' ) Constructor.
getClientFinalMessage ( ) : string Return the final client message.
getClientFirstMessage ( ) : string Return the initial client message.
parseServerFinalMessage ( string $msg ) : boolean Process the final server message response.
parseServerFirstMessage ( string $msg ) : boolean Process the initial server message response.

Method Details

__construct() public method

Constructor.
public __construct ( string $user, string $pass, string $hash = 'SHA1' )
$user string Username.
$pass string Password.
$hash string Hash name.

getClientFinalMessage() public method

Return the final client message.
public getClientFinalMessage ( ) : string
return string Final client message.

getClientFirstMessage() public method

Return the initial client message.
public getClientFirstMessage ( ) : string
return string Initial client message.

parseServerFinalMessage() public method

Process the final server message response.
public parseServerFinalMessage ( string $msg ) : boolean
$msg string Final server response.
return boolean False if authentication failed.

parseServerFirstMessage() public method

Process the initial server message response.
public parseServerFirstMessage ( string $msg ) : boolean
$msg string Initial server response.
return boolean False if authentication failed at this stage.

Property Details

$_authmsg protected_oe property

AuthMessage (RFC 5802 [3]).
protected string $_authmsg
return string

$_hash protected_oe property

Hash name.
protected string $_hash
return string

$_iterations protected_oe property

Number of Hi iterations (RFC 5802 [2]).
protected int $_iterations
return integer

$_nonce protected_oe property

Nonce.
protected string $_nonce
return string

$_pass protected_oe property

Password.
protected string $_pass
return string

$_salt protected_oe property

Server salt.
protected string $_salt
return string

$_serversig protected_oe property

Calculated server signature value.
protected string $_serversig
return string

$_user protected_oe property

Username.
protected string $_user
return string