Added RepeatMatch

src/Zxcvbn/Classes/Matchers/RepeatMatch.php

@@ -0,0 +1,148 @@
+<?php
+
+    /** @noinspection PhpMissingFieldTypeInspection */
+
+    namespace Zxcvbn\Classes\Matchers;
+
+    use Zxcvbn\Abstracts\BaseMatch;
+    use Zxcvbn\Classes\Matcher;
+    use Zxcvbn\Classes\Scorer;
+    use Zxcvbn\Interfaces\MatchInterface;
+    use Zxcvbn\Objects\Feedback;
+
+    class RepeatMatch extends BaseMatch
+    {
+        public const GREEDY_MATCH = '/(.+)\1+/u';
+        public const LAZY_MATCH = '/(.+?)\1+/u';
+        public const ANCHORED_LAZY_MATCH = '/^(.+?)\1+$/u';
+
+        /**
+         * @var string
+         */
+        public $pattern = 'repeat';
+
+        /**
+         * An array of matches for the repeated section itself.
+         * @var MatchInterface[]
+         */
+        public $baseMatches = [];
+
+        /**
+         * The number of guesses required for the repeated section itself.
+         * @var int
+         */
+        public $baseGuesses;
+
+        /**
+         * The number of times the repeated section is repeated.
+         * @var int
+         */
+        public $repeatCount;
+
+        /**
+         * The string that was repeated in the token.
+         * @var string
+         */
+        public $repeatedChar;
+
+        /**
+         * Match 3 or more repeated characters.
+         *
+         * @param $password
+         * @param array $userInputs
+         * @return RepeatMatch[]
+         */
+        public static function match($password, array $userInputs = []): array
+        {
+            $matches = [];
+            $lastIndex = 0;
+
+            while ($lastIndex < mb_strlen($password))
+            {
+                $greedyMatches = self::findAll($password, self::GREEDY_MATCH, $lastIndex);
+                $lazyMatches = self::findAll($password, self::LAZY_MATCH, $lastIndex);
+
+                if (empty($greedyMatches))
+                {
+                    break;
+                }
+
+                if (mb_strlen($greedyMatches[0][0]['token']) > mb_strlen($lazyMatches[0][0]['token']))
+                {
+                    $match = $greedyMatches[0];
+                    preg_match(self::ANCHORED_LAZY_MATCH, $match[0]['token'], $anchoredMatch);
+                    $repeatedChar = $anchoredMatch[1];
+                }
+                else
+                {
+                    $match = $lazyMatches[0];
+                    $repeatedChar = $match[1]['token'];
+                }
+
+                $scorer = new Scorer();
+                $matcher = new Matcher();
+
+                $baseAnalysis = $scorer->getMostGuessableMatchSequence($repeatedChar, $matcher->getMatches($repeatedChar));
+                $baseMatches = $baseAnalysis['sequence'];
+                $baseGuesses = $baseAnalysis['guesses'];
+
+                $repeatCount = mb_strlen($match[0]['token']) / mb_strlen($repeatedChar);
+
+                $matches[] = new static(
+                    $password,
+                    $match[0]['begin'],
+                    $match[0]['end'],
+                    $match[0]['token'],
+                    [
+                        'repeated_char' => $repeatedChar,
+                        'base_guesses'  => $baseGuesses,
+                        'base_matches'  => $baseMatches,
+                        'repeat_count'  => $repeatCount,
+                    ]
+                );
+
+                $lastIndex = $match[0]['end'] + 1;
+            }
+
+            return $matches;
+        }
+
+        /**
+         * @param $isSoleMatch
+         * @return Feedback
+         * @noinspection PhpUnusedParameterInspection
+         */
+        public function getFeedback($isSoleMatch): Feedback
+        {
+            $warning = mb_strlen($this->repeatedChar) == 1
+                ? 'Repeats like "aaa" are easy to guess'
+                : 'Repeats like "abcabcabc" are only slightly harder to guess than "abc"';
+
+            return new Feedback($warning, [
+                'Avoid repeated words and characters'
+            ]);
+        }
+
+        /**
+         * @param string $password
+         * @param int $begin
+         * @param int $end
+         * @param string $token
+         * @param array $params An array with keys: [repeated_char, base_guesses, base_matches, repeat_count].
+         */
+        public function __construct($password, $begin, $end, $token, array $params = [])
+        {
+            parent::__construct($password, $begin, $end, $token);
+            if (!empty($params)) {
+                $this->repeatedChar = $params['repeated_char'] ?? null;
+                $this->baseGuesses = $params['base_guesses'] ?? null;
+                $this->baseMatches = $params['base_matches'] ?? null;
+                $this->repeatCount = $params['repeat_count'] ?? null;
+            }
+        }
+
+        protected function getRawGuesses()
+        {
+            return $this->baseGuesses * $this->repeatCount;
+        }
+    }

src/Zxcvbn/Classes/Scorer.php

@@ -23,7 +23,7 @@
          * @return GuessableMatchSequence Returns an array with these keys: [password, guesses, guesses_log10, sequence]
          * @noinspection PhpUnused
          */
-        public function getMostGuessableMatchSequence(string $password, array $matches, bool $excludeAdditive): GuessableMatchSequence
+        public function getMostGuessableMatchSequence(string $password, array $matches, bool $excludeAdditive=false): GuessableMatchSequence
         {
             $this->password = $password;
             $this->excludeAdditive = $excludeAdditive;

src/Zxcvbn/package.json

@@ -48,6 +48,10 @@
             "required": true,
             "file": "Classes/Matchers/L33tMatch.php"
         },
+        {
+            "required": true,
+            "file": "Classes/Matchers/RepeatMatch.php"
+        },
         {
             "required": true,
             "file": "Classes/Scorer.php"