Password.php

Go to the documentation of this file.

<?php
use Wikimedia\Assert\Assert;
 
abstract class Password {
    protected $factory;
 
    protected $hash;
 
    protected $config;
 
    const MAX_HASH_SIZE = 255;
 
    final public function __construct( PasswordFactory $factory, array $config, $hash = null ) {
        if ( !$this->isSupported() ) {
            throw new Exception( 'PHP support not found for ' . get_class( $this ) );
        }
        if ( !isset( $config['type'] ) ) {
            throw new Exception( 'Password configuration must contain a type name.' );
        }
        $this->config = $config;
        $this->factory = $factory;
 
        if ( $hash !== null && strlen( $hash ) >= 3 ) {
            // Strip the type from the hash for parsing
            $hash = substr( $hash, strpos( $hash, ':', 1 ) + 1 );
        }
 
        $this->hash = $hash;
        $this->parseHash( $hash );
    }
 
    final public function getType() {
        return $this->config['type'];
    }
 
    protected function isSupported() {
        return true;
    }
 
    protected function parseHash( $hash ) {
    }
 
    abstract public function needsUpdate();
 
    public function equals( $other ) {
        wfDeprecated( __METHOD__, '1.33' );
 
        if ( is_string( $other ) ) {
            return $this->verify( $other );
        }
 
        return hash_equals( $this->toString(), $other->toString() );
    }
 
    public function verify( $password ) {
        Assert::parameterType( 'string', $password, '$password' );
 
        // No need to use the factory because we're definitely making
        // an object of the same type.
        $obj = clone $this;
        $obj->crypt( $password );
 
        return hash_equals( $this->toString(), $obj->toString() );
    }
 
    public function toString() {
        $result = ':' . $this->config['type'] . ':' . $this->hash;
        $this->assertIsSafeSize( $result );
        return $result;
    }
 
    final protected function assertIsSafeSize( $hash ) {
        if ( strlen( $hash ) > self::MAX_HASH_SIZE ) {
            throw new PasswordError( "Password hash is too big" );
        }
    }
 
    abstract public function crypt( $password );
}