API Documentation
\

\Horde_Imap_Client_Auth_DigestMD5

Provides the code needed to authenticate via the DIGEST-MD5 SASL mechanism (defined in RFC 2831). This method has been obsoleted by RFC 6331, but still is in use on legacy servers.

Summary

Methods
Properties
Constants
__construct()
__toString()
__get()
No public properties found
No constants found
_parseChallenge()
_getCnonce()
$_response
N/A
No private methods found
No private properties found
N/A

Properties

$_response

$_response : string

Digest response components.

Type

string

Methods

__construct()

__construct(string  $id, string  $pass, string  $challenge, string  $hostname, string  $service)

Generate the Digest-MD5 response.

Parameters

string $id

Authentication id (username).
string $pass

Password.
string $challenge

The digest challenge sent by the server.
string $hostname

The hostname of the machine connecting to.
string $service

The service name (e.g. 'imap', 'pop3').

Throws

\Horde_Imap_Client_Exception

__toString()

__toString() : string

Cooerce to string.

Returns

string —

The digest response (not base64 encoded).

__get()

__get(  $name) : mixed

Return specific digest response directive.

Parameters

$name

Returns

mixed —

Requested directive, or null if it does not exist.

_parseChallenge()

_parseChallenge(string  $challenge) : array

Parses and verifies the digest challenge.

Parameters

string $challenge

The digest challenge

Throws

\Horde_Imap_Client_Exception

Returns

array —

The parsed challenge as an array with directives as keys.

_getCnonce()

_getCnonce() : string

Creates the client nonce for the response

Returns

string —

The cnonce value.