BlowfishSalt.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Saltedpasswords\Salt;

class BlowfishSalt extends \TYPO3\CMS\Saltedpasswords\Salt\Md5Salt {

    const HASH_COUNT = 7;
    const MAX_HASH_COUNT = 17;
    const MIN_HASH_COUNT = 4;
    static protected $hashCount;

    static protected $maxHashCount;

    static protected $minHashCount;

    static protected $saltLengthBlowfish = 16;

    static protected $settingBlowfish = '$2a$';

    protected function applySettingsToSalt($salt) {
        $saltWithSettings = $salt;
        $reqLenBase64 = $this->getLengthBase64FromBytes($this->getSaltLength());
        // salt without setting
        if (strlen($salt) == $reqLenBase64) {
            $saltWithSettings = $this->getSetting() . sprintf('%02u', $this->getHashCount()) . '$' . $salt;
        }
        return $saltWithSettings;
    }

    protected function getCountLog2($setting) {
        $countLog2 = NULL;
        $setting = substr($setting, strlen($this->getSetting()));
        $firstSplitPos = strpos($setting, '$');
        // Hashcount existing
        if ($firstSplitPos !== FALSE && $firstSplitPos <= 2 && is_numeric(substr($setting, 0, $firstSplitPos))) {
            $countLog2 = (int)substr($setting, 0, $firstSplitPos);
        }
        return $countLog2;
    }

    public function getHashCount() {
        return isset(self::$hashCount) ? self::$hashCount : self::HASH_COUNT;
    }

    public function getMaxHashCount() {
        return isset(self::$maxHashCount) ? self::$maxHashCount : self::MAX_HASH_COUNT;
    }

    public function isAvailable() {
        return CRYPT_BLOWFISH;
    }

    public function getMinHashCount() {
        return isset(self::$minHashCount) ? self::$minHashCount : self::MIN_HASH_COUNT;
    }

    public function getSaltLength() {
        return self::$saltLengthBlowfish;
    }

    public function getSetting() {
        return self::$settingBlowfish;
    }

    public function isHashUpdateNeeded($saltedPW) {
        // Check whether this was an updated password.
        if (strncmp($saltedPW, '$2', 2) || !$this->isValidSalt($saltedPW)) {
            return TRUE;
        }
        // Check whether the iteration count used differs from the standard number.
        $countLog2 = $this->getCountLog2($saltedPW);
        return !is_NULL($countLog2) && $countLog2 < $this->getHashCount();
    }

    public function isValidSalt($salt) {
        $isValid = ($skip = FALSE);
        $reqLenBase64 = $this->getLengthBase64FromBytes($this->getSaltLength());
        if (strlen($salt) >= $reqLenBase64) {
            // Salt with prefixed setting
            if (!strncmp('$', $salt, 1)) {
                if (!strncmp($this->getSetting(), $salt, strlen($this->getSetting()))) {
                    $isValid = TRUE;
                    $salt = substr($salt, strrpos($salt, '$') + 1);
                } else {
                    $skip = TRUE;
                }
            }
            // Checking base64 characters
            if (!$skip && strlen($salt) >= $reqLenBase64) {
                if (preg_match('/^[' . preg_quote($this->getItoa64(), '/') . ']{' . $reqLenBase64 . ',' . $reqLenBase64 . '}$/', substr($salt, 0, $reqLenBase64))) {
                    $isValid = TRUE;
                }
            }
        }
        return $isValid;
    }

    public function isValidSaltedPW($saltedPW) {
        $isValid = FALSE;
        $isValid = !strncmp($this->getSetting(), $saltedPW, strlen($this->getSetting())) ? TRUE : FALSE;
        if ($isValid) {
            $isValid = $this->isValidSalt($saltedPW);
        }
        return $isValid;
    }

    public function setHashCount($hashCount = NULL) {
        self::$hashCount = !is_NULL($hashCount) && is_int($hashCount) && $hashCount >= $this->getMinHashCount() && $hashCount <= $this->getMaxHashCount() ? $hashCount : self::HASH_COUNT;
    }

    public function setMaxHashCount($maxHashCount = NULL) {
        self::$maxHashCount = !is_NULL($maxHashCount) && is_int($maxHashCount) ? $maxHashCount : self::MAX_HASH_COUNT;
    }

    public function setMinHashCount($minHashCount = NULL) {
        self::$minHashCount = !is_NULL($minHashCount) && is_int($minHashCount) ? $minHashCount : self::MIN_HASH_COUNT;
    }

}