Documentation

Horde_Imap_Client_Auth_DigestMD5
in package

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.

Tags
author

Richard Heyes richard@php.net

author

Michael Slusarz slusarz@horde.org

copyright

2002-2003 Richard Heyes

copyright

2011-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$_response  : string
Digest response components.
__construct()  : mixed
Generate the Digest-MD5 response.
__get()  : mixed
Return specific digest response directive.
__toString()  : string
Cooerce to string.
_getCnonce()  : string
Creates the client nonce for the response
_parseChallenge()  : array<string|int, mixed>
Parses and verifies the digest challenge.

Properties

$_response

Digest response components.

protected string $_response

Methods

__construct()

Generate the Digest-MD5 response.

public __construct(string $id, string $pass, string $challenge, string $hostname, string $service) : mixed
Parameters
$id : string

Authentication id (username).

$pass : string

Password.

$challenge : string

The digest challenge sent by the server.

$hostname : string

The hostname of the machine connecting to.

$service : string

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

Tags
throws
Horde_Imap_Client_Exception
Return values
mixed

__get()

Return specific digest response directive.

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

Requested directive, or null if it does not exist.

__toString()

Cooerce to string.

public __toString() : string
Return values
string

The digest response (not base64 encoded).

_getCnonce()

Creates the client nonce for the response

protected _getCnonce() : string
Return values
string

The cnonce value.

_parseChallenge()

Parses and verifies the digest challenge.

protected _parseChallenge(string $challenge) : array<string|int, mixed>
Parameters
$challenge : string

The digest challenge

Tags
throws
Horde_Imap_Client_Exception
Return values
array<string|int, mixed>

The parsed challenge as an array with directives as keys.

Search results