Linna\Authentication\PasswordGenerator

Complexity

Total Complexity

17

Size/Duplication

Total Lines	163
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getTopology()	0	10	2
A	getFromRandom()	0	11	2
A	getRandomChar()	0	10	3
A	inRanges()	0	9	4
A	getTopologyGroup()	0	12	3
A	getFromTopology()	0	19	3

<?php

/**
 * Linna Framework.
 *
 * @author Sebastian Rapetti <sebastian.rapetti@alice.it>
 * @copyright (c) 2018, Sebastian Rapetti
 * @license http://opensource.org/licenses/MIT MIT License
 */
declare(strict_types=1);

namespace Linna\Authentication;

use InvalidArgumentException;

/**
 * Generate random password with random topology, this class use php7
 * random_int() function for generate random numbers.
 */
class PasswordGenerator
{
    /**
     * @var array Characters intervall utf8 dec rappresentation
     */
    private $chars = [
        [[65, 90]], //u 117
        [[97, 122]], //l 108
        [[48, 57]], //d 100
        [[33, 47], [58, 64], [91, 96], [123, 126]], //s 115
    ];

    /**
     * Generate a random password.
     * <pre><code class="php">use Linna\Auth\PasswordGenerator;
     *
     * $passwordGenerator = new PasswordGenerator();
     * $random = $passwordGenerator->getFromRandom(20);
     *
     * //var_dump result
     * //r4Q,1J*tM7D_99q0u>61
     * var_dump($random);
     * </code></pre>
     *
     * @param int $length Desiderated password length.
     * @return string Random password.
     */
    public function getFromRandom(int $length): string
    {
        $password = [];

        while ($length) {
            $password[] = $this->getRandomChar($this->chars[random_int(0, 3)]);

            $length--;
        }

        return implode($password);
    }

    /**
     * Return topology for given password.
     * <pre><code class="php">use Linna\Auth\PasswordGenerator;
     *
     * $passwordGenerator = new PasswordGenerator();
     * $topology = $passwordGenerator->getTopology('r4Q,1J*tM7D_99q0u>61');
     *
     * //var_dump result
     * //ldusdusludusddldlsdd
     * var_dump($topology);
     * </code></pre>
     * @param string $password Password.
     *
     * @return string Topology for the argument passed password.
     */
    public function getTopology(string $password): string
    {
        $array = (array) str_split($password);
        $topology = [];

        foreach ($array as $char) {
            $topology[] = $this->getTopologyGroup((string)$char);
        }

        return implode($topology);
    }

    /**
     * Return topology group for the given char.
     *
     * @param string $char
     *
     * @return string
     *
     * @throws InvalidArgumentException If char provided isn't inside any group
     */
    private function getTopologyGroup(string $char): string
    {
        $int = ord($char);
        $groups = ['u', 'l', 'd', 's'];

        foreach ($groups as $key => $group) {
            if ($this->inRanges($int, $this->chars[$key])) {
                return $group;
            }
        }

        throw new InvalidArgumentException('Out of group character provided');
    }

    /**
     * Generate a random password corresponding at the given topology.
     * <pre><code class="php">use Linna\Auth\PasswordGenerator;
     *
     * $passwordGenerator = new PasswordGenerator();
     * $random = $passwordGenerator->getFromTopology('ldusdusludusddldlsdd');
     *
     * //var_dump result
     * //r4Q,1J*tM7D_99q0u>61
     * var_dump($random);
     * </code></pre>
     *
     * @param string $topology Topology for generate password.
     * @return string Random password corresponding the given topology.
     *
     * @throws InvalidArgumentException If invalid pattern is provided.
     */
    public function getFromTopology(string $topology): string
    {
        $array = (array) str_split(strtolower($topology));
        $groups = [117 => 0, 108 => 1, 100 => 2, 115 => 3];
        $password = [];

        foreach ($array as $char) {
            $int = ord((string)$char);

            if (isset($groups[$int])) {
                $password[] = $this->getRandomChar($this->chars[$groups[$int]]);

                continue;
            }

            throw new InvalidArgumentException('Invalid pattern provided, accepted only u, l, d and s');
        }

        return implode($password);
    }

    /**
     * Get random char between.
     *
     * @param array $interval
     * @return string
     */
    private function getRandomChar(array $interval): string
    {
        do {
            $int = random_int(33, 122);
            if ($this->inRanges($int, $interval)) {
                break;
            }
        } while (true);

        return chr($int);
    }

    /**
     * Check if value is between given range.
     *
     * @param mixed $value
     * @param array $ranges
     *
     * @return bool
     */
    private function inRanges($value, array $ranges): bool
    {
        foreach ($ranges as $range) {
            if ($value >= $range[0] && $value <= $range[1]) {
                return true;
            }
        }

        return false;
    }
}