interface/modules/zend_modules/library/Zend/Authentication/Adapter/Digest.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\Authentication\Adapter;
  11
  12 use Zend\Authentication\Result as AuthenticationResult;
  13 use Zend\Stdlib\ErrorHandler;
  14 use Zend\Crypt\Utils as CryptUtils;
  15
  16 class Digest extends AbstractAdapter
  17 {
  18     /**
  19      * Filename against which authentication queries are performed
  20      *
  21      * @var string
  22      */
  23     protected $filename;
  24
  25     /**
  26      * Digest authentication realm
  27      *
  28      * @var string
  29      */
  30     protected $realm;
  31
  32     /**
  33      * Sets adapter options
  34      *
  35      * @param  mixed $filename
  36      * @param  mixed $realm
  37      * @param  mixed $identity
  38      * @param  mixed $credential
  39      */
  40     public function __construct($filename = null, $realm = null, $identity = null, $credential = null)
  41     {
  42         if ($filename !== null) {
  43             $this->setFilename($filename);
  44         }
  45         if ($realm !== null) {
  46             $this->setRealm($realm);
  47         }
  48         if ($identity !== null) {
  49             $this->setIdentity($identity);
  50         }
  51         if ($credential !== null) {
  52             $this->setCredential($credential);
  53         }
  54     }
  55
  56     /**
  57      * Returns the filename option value or null if it has not yet been set
  58      *
  59      * @return string|null
  60      */
  61     public function getFilename()
  62     {
  63         return $this->filename;
  64     }
  65
  66     /**
  67      * Sets the filename option value
  68      *
  69      * @param  mixed $filename
  70      * @return Digest Provides a fluent interface
  71      */
  72     public function setFilename($filename)
  73     {
  74         $this->filename = (string) $filename;
  75         return $this;
  76     }
  77
  78     /**
  79      * Returns the realm option value or null if it has not yet been set
  80      *
  81      * @return string|null
  82      */
  83     public function getRealm()
  84     {
  85         return $this->realm;
  86     }
  87
  88     /**
  89      * Sets the realm option value
  90      *
  91      * @param  mixed $realm
  92      * @return Digest Provides a fluent interface
  93      */
  94     public function setRealm($realm)
  95     {
  96         $this->realm = (string) $realm;
  97         return $this;
  98     }
  99
 100     /**
 101      * Returns the username option value or null if it has not yet been set
 102      *
 103      * @return string|null
 104      */
 105     public function getUsername()
 106     {
 107         return $this->getIdentity();
 108     }
 109
 110     /**
 111      * Sets the username option value
 112      *
 113      * @param  mixed $username
 114      * @return Digest Provides a fluent interface
 115      */
 116     public function setUsername($username)
 117     {
 118         return $this->setIdentity($username);
 119     }
 120
 121     /**
 122      * Returns the password option value or null if it has not yet been set
 123      *
 124      * @return string|null
 125      */
 126     public function getPassword()
 127     {
 128         return $this->getCredential();
 129     }
 130
 131     /**
 132      * Sets the password option value
 133      *
 134      * @param  mixed $password
 135      * @return Digest Provides a fluent interface
 136      */
 137     public function setPassword($password)
 138     {
 139         return $this->setCredential($password);
 140     }
 141
 142     /**
 143      * Defined by Zend\Authentication\Adapter\AdapterInterface
 144      *
 145      * @throws Exception\ExceptionInterface
 146      * @return AuthenticationResult
 147      */
 148     public function authenticate()
 149     {
 150         $optionsRequired = array('filename', 'realm', 'identity', 'credential');
 151         foreach ($optionsRequired as $optionRequired) {
 152             if (null === $this->$optionRequired) {
 153                 throw new Exception\RuntimeException("Option '$optionRequired' must be set before authentication");
 154             }
 155         }
 156
 157         ErrorHandler::start(E_WARNING);
 158         $fileHandle = fopen($this->filename, 'r');
 159         $error      = ErrorHandler::stop();
 160         if (false === $fileHandle) {
 161             throw new Exception\UnexpectedValueException("Cannot open '$this->filename' for reading", 0, $error);
 162         }
 163
 164         $id       = "$this->identity:$this->realm";
 165         $idLength = strlen($id);
 166
 167         $result = array(
 168             'code'  => AuthenticationResult::FAILURE,
 169             'identity' => array(
 170                 'realm'    => $this->realm,
 171                 'username' => $this->identity,
 172             ),
 173             'messages' => array()
 174         );
 175
 176         while (($line = fgets($fileHandle)) !== false) {
 177             $line = trim($line);
 178             if (empty($line)) {
 179                 break;
 180             }
 181             if (substr($line, 0, $idLength) === $id) {
 182                 if (CryptUtils::compareStrings(substr($line, -32), md5("$this->identity:$this->realm:$this->credential"))) {
 183                     $result['code'] = AuthenticationResult::SUCCESS;
 184                 } else {
 185                     $result['code'] = AuthenticationResult::FAILURE_CREDENTIAL_INVALID;
 186                     $result['messages'][] = 'Password incorrect';
 187                 }
 188                 return new AuthenticationResult($result['code'], $result['identity'], $result['messages']);
 189             }
 190         }
 191
 192         $result['code'] = AuthenticationResult::FAILURE_IDENTITY_NOT_FOUND;
 193         $result['messages'][] = "Username '$this->identity' and realm '$this->realm' combination not found";
 194         return new AuthenticationResult($result['code'], $result['identity'], $result['messages']);
 195     }
 196 }