class.ilBcryptPhpPasswordEncoder.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2016 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Password/classes/class.ilBasePasswordEncoder.php';

class ilBcryptPhpPasswordEncoder extends ilBasePasswordEncoder
{
    protected $costs = '08';

    public function __construct(array $config = array())
    {
        if (!empty($config)) {
            foreach ($config as $key => $value) {
                switch (strtolower($key)) {
                    case 'cost':
                        $this->setCosts($value);
                        break;
                }
            }
        }

        if (!isset($config['cost']) && static::class == self::class) {
            // Determine the costs only if they are not passed in constructor
            $this->setCosts($this->benchmarkCost(0.05));
        }

        $this->init();
    }

    protected function init()
    {
    }

    public function benchmarkCost($time_target = 0.05)
    {
        $cost = 8;

        do {
            $cost++;
            $start = microtime(true);
            $encoder = new self(array('cost' => $cost));
            $encoder->encodePassword('test', '');
            $end = microtime(true);
        } while (($end - $start) < $time_target && $cost < 32);

        return $cost;
    }

    public function getName()
    {
        return 'bcryptphp';
    }

    public function isSupportedByRuntime()
    {
        return parent::isSupportedByRuntime() && version_compare(phpversion(), '5.5.0', '>=');
    }

    public function getCosts()
    {
        return $this->costs;
    }

    public function setCosts($costs)
    {
        if (!empty($costs)) {
            $costs = (int) $costs;
            if ($costs < 4 || $costs > 31) {
                require_once 'Services/Password/exceptions/class.ilPasswordException.php';
                throw new ilPasswordException('The costs parameter of bcrypt must be in range 04-31');
            }
            $this->costs = sprintf('%1$02d', $costs);
        }
    }

    public function encodePassword($raw, $salt)
    {
        if ($this->isPasswordTooLong($raw)) {
            require_once 'Services/Password/exceptions/class.ilPasswordException.php';
            throw new ilPasswordException('Invalid password.');
        }

        return password_hash($raw, PASSWORD_BCRYPT, array(
            'cost' => $this->getCosts()
        ));
    }

    public function isPasswordValid($encoded, $raw, $salt)
    {
        return password_verify($raw, $encoded);
    }

    public function requiresReencoding($encoded)
    {
        return password_needs_rehash($encoded, PASSWORD_BCRYPT, array(
            'cost' => $this->getCosts()
        ));
    }
}