Auth_SASL_DigestMD5 Class Reference

Inheritance diagram for Auth_SASL_DigestMD5:

[legend]Collaboration diagram for Auth_SASL_DigestMD5:

[legend]List of all members.

Public Member Functions
	getResponse ($authcid, $pass, $challenge, $hostname, $service, $authzid= '')
	_parseChallenge ($challenge)
	_getResponseValue ($authcid, $pass, $realm, $nonce, $cnonce, $digest_uri, $authzid= '')
	_getCnonce ()
	_HMAC_MD5 ($key, $data)

---

Detailed Description

Definition at line 48 of file DigestMD5.php.

---

Member Function Documentation

Auth_SASL_DigestMD5::_getCnonce (   )

Creates the client nonce for the response Returns: string The cnonce value private Definition at line 175 of file DigestMD5.php. Referenced by getResponse(). { if (file_exists('/dev/urandom')) { return base64_encode(fread(fopen('/dev/urandom', 'r'), 32)); } elseif (file_exists('/dev/random')) { return base64_encode(fread(fopen('/dev/random', 'r'), 32)); } else { $str = ''; mt_srand((double)microtime()*10000000); for ($i=0; $i<32; $i++) { $str .= chr(mt_rand(0, 255)); } return base64_encode($str); } }

Auth_SASL_DigestMD5::_getResponseValue (  $  authcid, $  pass, $  realm, $  nonce, $  cnonce, $  digest_uri, $  authzid = '' )

Creates the response= part of the digest response Parameters: string  $authcid Authentication id (username) string  $pass Password string  $realm Realm as provided by the server string  $nonce Nonce as provided by the server string  $cnonce Client nonce string  $digest_uri The digest-uri= value part of the response string  $authzid Authorization id Returns: string The response= part of the digest response private Definition at line 158 of file DigestMD5.php. Referenced by getResponse(). { if ($authzid == '') { $A1 = sprintf('%s:%s:%s', pack('H32', md5(sprintf('%s:%s:%s', $authcid, $realm, $pass))), $nonce, $cnonce); } else { $A1 = sprintf('%s:%s:%s:%s', pack('H32', md5(sprintf('%s:%s:%s', $authcid, $realm, $pass))), $nonce, $cnonce, $authzid); } $A2 = 'AUTHENTICATE:' . $digest_uri; return md5(sprintf('%s:%s:00000001:%s:auth:%s', md5($A1), $nonce, $cnonce, md5($A2))); }

Auth_SASL_Common::_HMAC_MD5 (  $  key, $  data )  [inherited]

Function which implements HMAC MD5 digest Parameters: string  $key The secret key string  $data The data to protect Returns: string The HMAC MD5 digest Definition at line 55 of file Common.php. Referenced by Auth_SASL_CramMD5::getResponse(). { if (strlen($key) > 64) { $key = pack('H32', md5($key)); } if (strlen($key) < 64) { $key = str_pad($key, 64, chr(0)); } $k_ipad = substr($key, 0, 64) ^ str_repeat(chr(0x36), 64); $k_opad = substr($key, 0, 64) ^ str_repeat(chr(0x5C), 64); $inner = pack('H32', md5($k_ipad . $data)); $digest = md5($k_opad . $inner); return $digest; }

Auth_SASL_DigestMD5::_parseChallenge (  $  challenge  )

Parses and verifies the digest challenge* Parameters: string  $challenge The digest challenge Returns: array The parsed challenge as an assoc array in the form "directive => value". private Defaults and required directives Definition at line 91 of file DigestMD5.php. Referenced by getResponse(). { $tokens = array(); while (preg_match('/^([a-z-]+)=("[^"]+(?<!\\\)"|[^,]+)/i', $challenge, $matches)) { // Ignore these as per rfc2831 if ($matches[1] == 'opaque' OR $matches[1] == 'domain') { $challenge = substr($challenge, strlen($matches[0]) + 1); continue; } // Allowed multiple "realm" and "auth-param" if (!empty($tokens[$matches[1]]) AND ($matches[1] == 'realm' OR $matches[1] == 'auth-param')) { if (is_array($tokens[$matches[1]])) { $tokens[$matches[1]][] = preg_replace('/^"(.*)"$/', '\\1', $matches[2]); } else { $tokens[$matches[1]] = array($tokens[$matches[1]], preg_replace('/^"(.*)"$/', '\\1', $matches[2])); } // Any other multiple instance = failure } elseif (!empty($tokens[$matches[1]])) { $tokens = array(); break; } else { $tokens[$matches[1]] = preg_replace('/^"(.*)"$/', '\\1', $matches[2]); } // Remove the just parsed directive from the challenge $challenge = substr($challenge, strlen($matches[0]) + 1); } // Realm if (empty($tokens['realm'])) { $uname = posix_uname(); $tokens['realm'] = $uname['nodename']; } // Maxbuf if (empty($tokens['maxbuf'])) { $tokens['maxbuf'] = 65536; } // Required: nonce, algorithm if (empty($tokens['nonce']) OR empty($tokens['algorithm'])) { return array(); } return $tokens; }

Auth_SASL_DigestMD5::getResponse (  $  authcid, $  pass, $  challenge, $  hostname, $  service, $  authzid = '' )

Provides the (main) client response for DIGEST-MD5 requires a few extra parameters than the other mechanisms, which are unavoidable. Parameters: string  $authcid Authentication id (username) string  $pass Password string  $challenge The digest challenge sent by the server string  $hostname The hostname of the machine you're connecting to string  $service The servicename (eg. imap, pop, acap etc) string  $authzid Authorization id (username to proxy as) Returns: string The digest response (NOT base64 encoded) public Definition at line 64 of file DigestMD5.php. References _getCnonce(), _getResponseValue(), _parseChallenge(), and PEAR::raiseError(). { $challenge = $this->_parseChallenge($challenge); $authzid_string = ''; if ($authzid != '') { $authzid_string = ',authzid="' . $authzid . '"'; } if (!empty($challenge)) { $cnonce = $this->_getCnonce(); $digest_uri = sprintf('%s/%s', $service, $hostname); $response_value = $this->_getResponseValue($authcid, $pass, $challenge['realm'], $challenge['nonce'], $cnonce, $digest_uri, $authzid); return sprintf('username="%s",realm="%s"' . $authzid_string . ',nonce="%s",cnonce="%s",nc="00000001",qop=auth,digest-uri="%s",response=%s,%d', $authcid, $challenge['realm'], $challenge['nonce'], $cnonce, $digest_uri, $response_value, $challenge['maxbuf']); } else { return PEAR::raiseError('Invalid digest challenge'); } }

---

The documentation for this class was generated from the following file:

• pear/Auth/SASL/DigestMD5.php

---