Zend_Mail_Protocol_Smtp_Auth_Crammd5 Class Reference

Inheritance diagram for Zend_Mail_Protocol_Smtp_Auth_Crammd5:

Public Member Functions
	__construct ($host='127.0.0.1', $port=null, $config=null)
	auth ()
Public Member Functions inherited from Zend_Mail_Protocol_Smtp
	__construct ($host='127.0.0.1', $port=null, array $config=array())
	connect ()
	helo ($host='127.0.0.1')
	mail ($from)
	rcpt ($to)
	data ($data)
	rset ()
	noop ()
	vrfy ($user)
	quit ()
	auth ()
	disconnect ()
Public Member Functions inherited from Zend_Mail_Protocol_Abstract
	__construct ($host='127.0.0.1', $port=null)
	__destruct ()
	setMaximumLog ($maximumLog)
	getMaximumLog ()
	connect ()
	getRequest ()
	getResponse ()
	getLog ()
	resetLog ()

Protected Member Functions
	_hmacMd5 ($key, $data, $block=64)
Protected Member Functions inherited from Zend_Mail_Protocol_Smtp
	_ehlo ($host)
	_startSession ()
	_stopSession ()
Protected Member Functions inherited from Zend_Mail_Protocol_Abstract
	_addLog ($value)
	_connect ($remote)
	_disconnect ()
	_send ($request)
	_receive ($timeout=null)
	_expect ($code, $timeout=null)
	_setStreamTimeout ($timeout)

Additional Inherited Members
Data Fields inherited from Zend_Mail_Protocol_Abstract
const	EOL = "\r\n"
const	TIMEOUT_CONNECTION = 30
Protected Attributes inherited from Zend_Mail_Protocol_Smtp
	$_transport = 'tcp'
	$_secure
	$_sess = false
	$_helo = false
	$_auth = false
	$_mail = false
	$_rcpt = false
	$_data = null
Protected Attributes inherited from Zend_Mail_Protocol_Abstract
	$_maximumLog = 64
	$_host
	$_port
	$_validHost
	$_socket
	$_request
	$_response
	$_template = '%d%s'

Detailed Description

Definition at line 39 of file Crammd5.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$host = '127.0.0.1',
			$port = null,
			$config = null
	)

Constructor.

Parameters

string	$host	(Default: 127.0.0.1)
int	$port	(Default: null)
array	$config	Auth-specific parameters

Returns

void

Definition at line 49 of file Crammd5.php.

    {
        if (is_array($config)) {
            if (isset($config['username'])) {
                $this->_username = $config['username'];
            }
            if (isset($config['password'])) {
                $this->_password = $config['password'];
            }
        }

        parent::__construct($host, $port, $config);
    }

Member Function Documentation

_hmacMd5()

_hmacMd5 (   $key,   $data,   $block = 64  )

protected

Prepare CRAM-MD5 response to server's ticket

Parameters

string	$key	Challenge key (usually password)
string	$data	Challenge data
string	$block	Length of blocks

Returns

string

Definition at line 92 of file Crammd5.php.

    {
        if (strlen($key) > 64) {
            $key = pack('H32', md5($key));
        } elseif (strlen($key) < 64) {
            $key = str_pad($key, $block, "\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()

auth

(

)

Todo:

Perform CRAM-MD5 authentication with supplied credentials

Returns

void

Definition at line 69 of file Crammd5.php.

    {
        // Ensure AUTH has not already been initiated.
        parent::auth();

        $this->_send('AUTH CRAM-MD5');
        $challenge = $this->_expect(334);
        $challenge = base64_decode($challenge);
        $digest = $this->_hmacMd5($this->_password, $challenge);
        $this->_send(base64_encode($this->_username . ' ' . $digest));
        $this->_expect(235);
        $this->_auth = true;
    }

---

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

• vendor/magento/zendframework1/library/Zend/Mail/Protocol/Smtp/Auth/Crammd5.php