Argon2Password.php

Go to the documentation of this file.

<?php
 
use Wikimedia\Assert\Assert;
 
class Argon2Password extends Password {
    private static $knownOptions = [
        'memory_cost' => null,
        'time_cost' => null,
        'threads' => null,
    ];
 
    protected function isSupported() {
        // It is actually possible to have a PHP build with Argon2i but not Argon2id
        return defined( 'PASSWORD_ARGON2I' ) || defined( 'PASSWORD_ARGON2ID' );
    }
 
    private function prepareParams() {
        switch ( $this->config['algo'] ) {
            case 'argon2i':
                $algo = PASSWORD_ARGON2I;
                break;
            case 'argon2id':
                $algo = PASSWORD_ARGON2ID;
                break;
            case 'auto':
                $algo = defined( 'PASSWORD_ARGON2ID' ) ? PASSWORD_ARGON2ID : PASSWORD_ARGON2I;
                break;
            default:
                throw new LogicException( "Unexpected algo: {$this->config['algo']}" );
 
        }
 
        $params = array_intersect_key( $this->config, self::$knownOptions );
 
        return [ $algo, $params ];
    }
 
    public function crypt( $password ) {
        list( $algo, $params ) = $this->prepareParams();
        $this->hash = password_hash( $password, $algo, $params );
    }
 
    public function equals( $other ) {
        if ( is_string( $other ) ) {
            return $this->verify( $other );
        }
 
        // Argon2 key derivation is not deterministic, can't pass objects to equals()
        return false;
    }
 
    public function verify( $password ) {
        Assert::parameterType( 'string', $password, '$password' );
 
        return password_verify( $password, $this->hash );
    }
 
    public function toString() {
        $res = ":argon2:{$this->hash}";
        $this->assertIsSafeSize( $res );
        return $res;
    }
 
    public function needsUpdate() {
        list( $algo, $params ) = $this->prepareParams();
        return password_needs_rehash( $this->hash, $algo, $params );
    }
}