interface/modules/zend_modules/library/Zend/Authentication/Adapter/Http/FileResolver.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\Http;
  11
  12 use Zend\Stdlib\ErrorHandler;
  13
  14 /**
  15  * HTTP Authentication File Resolver
  16  */
  17 class FileResolver implements ResolverInterface
  18 {
  19     /**
  20      * Path to credentials file
  21      *
  22      * @var string
  23      */
  24     protected $file;
  25
  26     /**
  27      * Constructor
  28      *
  29      * @param  string $path Complete filename where the credentials are stored
  30      */
  31     public function __construct($path = '')
  32     {
  33         if (!empty($path)) {
  34             $this->setFile($path);
  35         }
  36     }
  37
  38     /**
  39      * Set the path to the credentials file
  40      *
  41      * @param  string $path
  42      * @return FileResolver Provides a fluent interface
  43      * @throws Exception\InvalidArgumentException if path is not readable
  44      */
  45     public function setFile($path)
  46     {
  47         if (empty($path) || !is_readable($path)) {
  48             throw new Exception\InvalidArgumentException('Path not readable: ' . $path);
  49         }
  50         $this->file = $path;
  51
  52         return $this;
  53     }
  54
  55     /**
  56      * Returns the path to the credentials file
  57      *
  58      * @return string
  59      */
  60     public function getFile()
  61     {
  62         return $this->file;
  63     }
  64
  65     /**
  66      * Resolve credentials
  67      *
  68      * Only the first matching username/realm combination in the file is
  69      * returned. If the file contains credentials for Digest authentication,
  70      * the returned string is the password hash, or h(a1) from RFC 2617. The
  71      * returned string is the plain-text password for Basic authentication.
  72      *
  73      * The expected format of the file is:
  74      *   username:realm:sharedSecret
  75      *
  76      * That is, each line consists of the user's username, the applicable
  77      * authentication realm, and the password or hash, each delimited by
  78      * colons.
  79      *
  80      * @param  string $username Username
  81      * @param  string $realm    Authentication Realm
  82      * @return string|false User's shared secret, if the user is found in the
  83      *         realm, false otherwise.
  84      * @throws Exception\ExceptionInterface
  85      */
  86     public function resolve($username, $realm, $password = null)
  87     {
  88         if (empty($username)) {
  89             throw new Exception\InvalidArgumentException('Username is required');
  90         } elseif (!ctype_print($username) || strpos($username, ':') !== false) {
  91             throw new Exception\InvalidArgumentException('Username must consist only of printable characters, '
  92                                                               . 'excluding the colon');
  93         }
  94         if (empty($realm)) {
  95             throw new Exception\InvalidArgumentException('Realm is required');
  96         } elseif (!ctype_print($realm) || strpos($realm, ':') !== false) {
  97             throw new Exception\InvalidArgumentException('Realm must consist only of printable characters, '
  98                                                               . 'excluding the colon.');
  99         }
 100
 101         // Open file, read through looking for matching credentials
 102         ErrorHandler::start(E_WARNING);
 103         $fp     = fopen($this->file, 'r');
 104         $error = ErrorHandler::stop();
 105         if (!$fp) {
 106             throw new Exception\RuntimeException('Unable to open password file: ' . $this->file, 0, $error);
 107         }
 108
 109         // No real validation is done on the contents of the password file. The
 110         // assumption is that we trust the administrators to keep it secure.
 111         while (($line = fgetcsv($fp, 512, ':')) !== false) {
 112             if ($line[0] == $username && $line[1] == $realm) {
 113                 $password = $line[2];
 114                 fclose($fp);
 115                 return $password;
 116             }
 117         }
 118
 119         fclose($fp);
 120         return false;
 121     }
 122 }