Password.php
70 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Piwik - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | */ |
| 8 | namespace Piwik\Auth; |
| 9 | |
| 10 | /** |
| 11 | * Main class to handle actions related to password hashing and verification. |
| 12 | * |
| 13 | * @api |
| 14 | */ |
| 15 | class Password |
| 16 | { |
| 17 | /** |
| 18 | * Hashes a password with the configured algorithm. |
| 19 | * |
| 20 | * @param string $password |
| 21 | * @return string |
| 22 | */ |
| 23 | public function hash($password) |
| 24 | { |
| 25 | return password_hash($password, PASSWORD_BCRYPT); |
| 26 | } |
| 27 | |
| 28 | /** |
| 29 | * Returns information about a hashed password (algo, options, ...). |
| 30 | * |
| 31 | * Can be used to verify whether a string is compatible with password_hash(). |
| 32 | * |
| 33 | * @param string |
| 34 | * @return array |
| 35 | */ |
| 36 | public function info($hash) |
| 37 | { |
| 38 | return password_get_info($hash); |
| 39 | } |
| 40 | |
| 41 | /** |
| 42 | * Rehashes a user's password if necessary. |
| 43 | * |
| 44 | * This method expects the password to be pre-hashed by |
| 45 | * \Piwik\Plugins\UsersManager\UsersManager::getPasswordHash(). |
| 46 | * |
| 47 | * @param string $hash |
| 48 | * @return boolean |
| 49 | */ |
| 50 | public function needsRehash($hash) |
| 51 | { |
| 52 | return password_needs_rehash($hash, PASSWORD_BCRYPT); |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * Verifies a user's password against the provided hash. |
| 57 | * |
| 58 | * This method expects the password to be pre-hashed by |
| 59 | * \Piwik\Plugins\UsersManager\UsersManager::getPasswordHash(). |
| 60 | * |
| 61 | * @param string $password |
| 62 | * @param string $hash |
| 63 | * @return boolean |
| 64 | */ |
| 65 | public function verify($password, $hash) |
| 66 | { |
| 67 | return password_verify($password, $hash); |
| 68 | } |
| 69 | } |
| 70 |