interface/modules/zend_modules/library/Zend/Mail/Protocol/Smtp/Auth/Crammd5.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Mail\Protocol\Smtp\Auth;
  11
  12 use Zend\Crypt\Hmac;
  13 use Zend\Mail\Protocol\Smtp;
  14
  15 /**
  16  * Performs CRAM-MD5 authentication
  17  */
  18 class Crammd5 extends Smtp
  19 {
  20     /**
  21      * @var string
  22      */
  23     protected $username;
  24
  25
  26     /**
  27      * @var string
  28      */
  29     protected $password;
  30
  31
  32     /**
  33      * Constructor.
  34      *
  35      * All parameters may be passed as an array to the first argument of the
  36      * constructor. If so,
  37      *
  38      * @param  string|array $host   (Default: 127.0.0.1)
  39      * @param  null|int     $port   (Default: null)
  40      * @param  null|array   $config Auth-specific parameters
  41      */
  42     public function __construct($host = '127.0.0.1', $port = null, $config = null)
  43     {
  44         // Did we receive a configuration array?
  45         $origConfig = $config;
  46         if (is_array($host)) {
  47             // Merge config array with principal array, if provided
  48             if (is_array($config)) {
  49                 $config = array_replace_recursive($host, $config);
  50             } else {
  51                 $config = $host;
  52             }
  53         }
  54
  55         if (is_array($config)) {
  56             if (isset($config['username'])) {
  57                 $this->setUsername($config['username']);
  58             }
  59             if (isset($config['password'])) {
  60                 $this->setPassword($config['password']);
  61             }
  62         }
  63
  64         // Call parent with original arguments
  65         parent::__construct($host, $port, $origConfig);
  66     }
  67
  68
  69     /**
  70      * Performs CRAM-MD5 authentication with supplied credentials
  71      */
  72     public function auth()
  73     {
  74         // Ensure AUTH has not already been initiated.
  75         parent::auth();
  76
  77         $this->_send('AUTH CRAM-MD5');
  78         $challenge = $this->_expect(334);
  79         $challenge = base64_decode($challenge);
  80         $digest = $this->_hmacMd5($this->getPassword(), $challenge);
  81         $this->_send(base64_encode($this->getUsername() . ' ' . $digest));
  82         $this->_expect(235);
  83         $this->auth = true;
  84     }
  85
  86     /**
  87      * Set value for username
  88      *
  89      * @param  string $username
  90      * @return Crammd5
  91      */
  92     public function setUsername($username)
  93     {
  94         $this->username = $username;
  95         return $this;
  96     }
  97
  98     /**
  99      * Get username
 100      *
 101      * @return string
 102      */
 103     public function getUsername()
 104     {
 105         return $this->username;
 106     }
 107
 108     /**
 109      * Set value for password
 110      *
 111      * @param  string $password
 112      * @return Crammd5
 113      */
 114     public function setPassword($password)
 115     {
 116         $this->password = $password;
 117         return $this;
 118     }
 119
 120     /**
 121      * Get password
 122      *
 123      * @return string
 124      */
 125     public function getPassword()
 126     {
 127         return $this->password;
 128     }
 129
 130     /**
 131      * Prepare CRAM-MD5 response to server's ticket
 132      *
 133      * @param  string $key   Challenge key (usually password)
 134      * @param  string $data  Challenge data
 135      * @param  int    $block Length of blocks (deprecated; unused)
 136      * @return string
 137      */
 138     protected function _hmacMd5($key, $data, $block = 64)
 139     {
 140         return Hmac::compute($key, 'md5', $data);
 141     }
 142 }