[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Part of the Joomla Framework Authentication Package
   4   *
   5   * @copyright  Copyright (C) 2005 - 2021 Open Source Matters, Inc. All rights reserved.
   6   * @license    GNU General Public License version 2 or later; see LICENSE
   7   */
   8  
   9  namespace Joomla\Authentication\Password;
  10  
  11  /**
  12   * Interface defining a password handler
  13   *
  14   * @since  1.2.0
  15   */
  16  interface HandlerInterface
  17  {
  18      /**
  19       * Generate a hash for a plaintext password
  20       *
  21       * @param   string  $plaintext  The plaintext password to validate
  22       * @param   array   $options    Options for the hashing operation
  23       *
  24       * @return  string
  25       *
  26       * @since   1.2.0
  27       */
  28  	public function hashPassword($plaintext, array $options = []);
  29  
  30      /**
  31       * Check that the password handler is supported in this environment
  32       *
  33       * @return  boolean
  34       *
  35       * @since   1.2.0
  36       */
  37  	public static function isSupported();
  38  
  39      /**
  40       * Validate a password
  41       *
  42       * @param   string  $plaintext  The plain text password to validate
  43       * @param   string  $hashed     The password hash to validate against
  44       *
  45       * @return  boolean
  46       *
  47       * @since   1.2.0
  48       */
  49  	public function validatePassword($plaintext, $hashed);
  50  }