Password::__construct() - Code Metrics - Inspection of "style fixed" - linna/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fc7aa2...a1b4af )

by Sebastian

created 2020-02-12 18:34 UTC

Password::__construct() A

↳ Parent: Password

Complexity

Conditions	4
Paths	8

Size

Total Lines	28
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	4

Importance

Changes	4
Bugs	2	Features	0

Metric	Value
eloc	16
c	4
b	2
f	0
dl	0
loc	28
ccs	17
cts	17
cp	1
rs	9.7333
cc	4
nc	8
nop	2
crap	4

<?php

/**
 * Linna Framework.
 *
 * @author Sebastian Rapetti <[email protected]>
 * @copyright (c) 2018, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types=1);

namespace Linna\Authentication;

/**
 * Provide methods for manage password, this class use PHP password hashing function,
 * see php documentation for more information.
 * <a href="http://php.net/manual/en/book.password.php">http://php.net/manual/en/book.password.php</a>
 */
class Password
{
    /**
     * @var array An associative array containing options
     *
     * http://php.net/manual/en/function.password-hash.php
     */
    protected array $options = [
        PASSWORD_BCRYPT => ['cost' => 11],
        PASSWORD_DEFAULT => ['cost' => 11]
    ];

    /**
     * @var array An associate array containing algorithm constants
     */
    protected array $algoLists = [
        PASSWORD_BCRYPT,
        PASSWORD_DEFAULT
    ];

    /**
     * @var int|string Password default algorithm
     */
    protected ?string $algo = PASSWORD_BCRYPT;

    /**
     * Class constructor.
     *
     * <p>For password algorithm constants see <a href="http://php.net/manual/en/password.constants.php">Password Constants</a>.</p>
     * <pre><code class="php">use Linna\Authentication\Password;
     *
     * $password = new Password(PASSWORD_DEFAULT, [
     *     'cost' => 11
     * ]);
     * </code></pre>
     *
     * Strict typing removed for $algo because on php 7.4 password hashing
     * algorithm identifiers are nullable strings rather than integers.
     *
     * @param int|string   $algo        Algorithm used for hash passwords.
     * @param array        $options     Options for algoas ['key' => 'value'] array.
     *
     * @throws \InvalidArgumentException
     */
    public function __construct($algo = PASSWORD_BCRYPT, array $options = [])
    {
        //necessary for avoid errors if Argon2 library not enabled
        //PASSWORD_ARGON2ID const only present since 7.3 PHP version
        if (\defined('PASSWORD_ARGON2I')) {
            $this->algoLists[] = PASSWORD_ARGON2I;
            $this->options[PASSWORD_ARGON2I] = [
                'memory_cost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST,
                'time_cost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
                'threads' => PASSWORD_ARGON2_DEFAULT_THREADS
            ];
        }

        if (\defined('PASSWORD_ARGON2ID')) {
            $this->algoLists[] = PASSWORD_ARGON2ID;
            $this->options[PASSWORD_ARGON2ID] = [
                'memory_cost' => PASSWORD_ARGON2_DEFAULT_MEMORY_COST,
                'time_cost' => PASSWORD_ARGON2_DEFAULT_TIME_COST,
                'threads' => PASSWORD_ARGON2_DEFAULT_THREADS
            ];
        }

        if (!\in_array($algo, $this->algoLists, true)) {
            throw new \InvalidArgumentException("The password algorithm {$algo} is invalid");
        }

        $this->algo = $algo;
        $this->options[$algo] = \array_replace_recursive($this->options[$algo], $options);
    }

    /**
     * Verifies if a password matches an hash and return the result as boolean.
     *
     * <pre><code class="php">$storedHash = '$2y$11$cq3ZWO18l68X7pGs9Y1fveTGcNJ/iyehrDZ10BAvbY8LaBXNvnyk6';
     * $password = 'FooPassword';
     *
     * $verified = $password->verify($password, $storedHash);
     * </code></pre>
     *
     * @param string $password  Plaintext password to be compared.
     * @param string $hash      Hashed password.
     *
     * @return bool True if password match, false if not.
     */
    public function verify(string $password, string $hash): bool
    {
        return \password_verify($password, $hash);
    }

    /**
     * Create password hash from the given string and return it.
     *
     * <pre><code class="php">$hash = $password->hash('FooPassword');
     *
     * //var_dump result
     * //$2y$11$cq3ZWO18l68X7pGs9Y1fveTGcNJ/iyehrDZ10BAvbY8LaBXNvnyk6
     * var_dump($hash)
     * </code></pre>
     *
     * @param string $password Plaintext password to be hashed.
     *
     * @return string Hashed password.
     */
    public function hash(string $password): string
    {
        return \password_hash($password, $this->algo, $this->options[$this->algo]);
        return \password_hash($password, /** @scrutinizer ignore-type */ $this->algo, $this->options[$this->algo]);
    }

    /**
     * Checks if the given hash matches the algorithm and the options provided.
     *
     * <pre><code class="php">$hash = '$2y$11$cq3ZWO18l68X7pGs9Y1fveTGcNJ/iyehrDZ10BAvbY8LaBXNvnyk6';
     *
     * //true if rehash is needed, false if no
     * $rehashCheck = $password->needsRehash($hash);
     * </code></pre>
     *
     * @param string $hash Hash to be checked
     *
     * @return bool
     */
    public function needsRehash(string $hash): bool
    {
        return \password_needs_rehash($hash, $this->algo, $this->options[$this->algo]);
        return \password_needs_rehash($hash, /** @scrutinizer ignore-type */ $this->algo, $this->options[$this->algo]);
    }

    /**
     * Returns information about the given hash.
     *
     * <pre><code class="php">$hash = '$2y$11$cq3ZWO18l68X7pGs9Y1fveTGcNJ/iyehrDZ10BAvbY8LaBXNvnyk6';
     *
     * $info = $password->getInfo($hash);
     *
     * //var_dump result
     * //[
     * //    'algo' => 1,
     * //    'algoName' => 'bcrypt',
     * //    'options' => [
     * //        'cost' => int 11
     * //    ]
     * //]
     * var_dump($info);
     * </code></pre>
     *
     * @param string $hash Hash for wich get info.
     *
     * @return array
     */
    public function getInfo(string $hash): array
    {
        return \password_get_info($hash);
    }
}


linna / framework

Push — master ( fc7aa2...a1b4af )

Password::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like