Merge branch release/v2.4.0

.github/workflows/run-test.yml

@@ -19,7 +19,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-version: ['8.1', '8.2', '8.3']
+                php-version: ['8.2', '8.3']
         steps:
             - uses: shivammathur/setup-php@v2
               with:
@@ -35,7 +35,5 @@ jobs:
                       ${{ runner.os }}-php-${{ matrix.php-version }}-
             - name: Install Dependencies
               run: composer install --no-scripts --no-ansi --no-interaction --no-progress
-            - name: Run PHP Code Sniffer
-              run: vendor/bin/phpcs --extensions=php --warning-severity=0 --standard=PSR12 -p ./src
             - name: Run PHPStan
               run: vendor/bin/phpstan analyse --no-progress -c phpstan.neon

composer.json

@@ -12,13 +12,12 @@
         }
     ],
     "require": {
-        "php": ">=8.1",
+        "php": ">=8.2",
         "psr/log": ">=1.1",
         "ext-openssl": "*"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.5.3",
-        "squizlabs/php_codesniffer": "^3.5"
+        "phpstan/phpstan": "^1.5.3"
     },
     "autoload": {
         "psr-4": {
@@ -27,8 +26,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-main": "2.3.x-dev",
-            "dev-develop": "2.4.x-dev"
+            "dev-main": "2.4.x-dev",
+            "dev-develop": "2.5.x-dev"
         }
     }
 }

src/PasswordGenerator.php

@@ -11,21 +11,18 @@ class PasswordGenerator extends RandomGenerator implements PasswordGeneratorInte
      * one uppercase letter, one digit, and one special character. The remaining characters
      * in the password are chosen at random from those four sets.
      *
-     * The available characters in each set are user friendly - there are no ambiguous
+     * The available characters in each set are user-friendly - there are no ambiguous
      * characters such as i, l, 1, o, 0, etc.
      *
-     * @param int $length
-     * @return string
-     *
      * @see https://gist.github.com/tylerhall/521810
      */
-    public function generatePassword(int $length = 12)
+    public function generatePassword(int $length = 16): string
     {
         $sets = [];
         $sets[] = 'abcdefghjkmnpqrstuvwxyz';
         $sets[] = 'ABCDEFGHJKMNPQRSTUVWXYZ';
         $sets[] = '23456789';
-        $sets[] = '!@#$%&*?';
+        $sets[] = '!@#$%&*?-';
 
         $all = '';
         $password = '';
@@ -35,12 +32,10 @@ public function generatePassword(int $length = 12)
         }
 
         $all = \mb_str_split($all);
-        for ($i = 0; $i < $length - count($sets); $i++) {
+        for ($i = 0; $i < $length - count($sets); ++$i) {
             $password .= $all[array_rand($all)];
         }
 
-        $password = str_shuffle($password);
-
-        return $password;
+        return str_shuffle($password);
     }
 }

src/PasswordGeneratorInterface.php

@@ -6,9 +6,5 @@
 
 interface PasswordGeneratorInterface
 {
-    /**
-     * @param int $length
-     * @return string
-     */
-    public function generatePassword(int $length = 12);
+    public function generatePassword(int $length = 16): string;
 }

src/RandomGenerator.php

@@ -8,47 +8,22 @@
 
 class RandomGenerator
 {
-    protected ?LoggerInterface $logger;
-    protected bool $useOpenSsl;
-
-    /**
-     * @param LoggerInterface|null $logger
-     */
-    public function __construct(LoggerInterface $logger = null)
+    public function __construct(protected readonly LoggerInterface $logger)
     {
-        $this->logger = $logger;
-        // determine whether to use OpenSSL
-        if (defined('PHP_WINDOWS_VERSION_BUILD') && version_compare(PHP_VERSION, '5.3.4', '<')) {
-            $this->useOpenSsl = false;
-        } elseif (!function_exists('openssl_random_pseudo_bytes')) {
-            if (null !== $this->logger) {
-                $this->logger->notice('It is recommended that you enable the "openssl" extension for random number generation.');
-            }
-            $this->useOpenSsl = false;
-        } else {
-            $this->useOpenSsl = true;
+        if (!function_exists('openssl_random_pseudo_bytes')) {
+            throw new \RuntimeException('You must enable the "openssl" extension for secure random number generation.');
         }
     }
 
-    /**
-     * @param int $nbBytes
-     * @return string
-     */
     public function getRandomNumber(int $nbBytes = 32): string
     {
         // try OpenSSL
-        if ($this->useOpenSsl) {
-            $bytes = \openssl_random_pseudo_bytes($nbBytes, $strong);
-
-            if (false !== $bytes && true === $strong) {
-                return $bytes;
-            }
+        $bytes = \openssl_random_pseudo_bytes($nbBytes, $strong);
 
-            if (null !== $this->logger) {
-                $this->logger->info('OpenSSL did not produce a secure random number.');
-            }
+        if (false !== $bytes && true === $strong) {
+            return $bytes;
         }
 
-        return hash('sha256', uniqid((string) mt_rand(), true), true);
+        throw new \RuntimeException('Unable to generate a secure random number.');
     }
 }

src/SaltGenerator.php

@@ -6,10 +6,7 @@
 
 class SaltGenerator extends RandomGenerator implements SaltGeneratorInterface
 {
-    /**
-     * @return string
-     */
-    public function generateSalt()
+    public function generateSalt(): string
     {
         return strtr(base64_encode($this->getRandomNumber(24)), '{}', '-_');
     }

src/SaltGeneratorInterface.php

@@ -6,8 +6,5 @@
 
 interface SaltGeneratorInterface
 {
-    /**
-     * @return string
-     */
-    public function generateSalt();
+    public function generateSalt(): string;
 }

src/TokenGenerator.php

@@ -6,10 +6,7 @@
 
 class TokenGenerator extends RandomGenerator implements TokenGeneratorInterface
 {
-    /**
-     * @return string
-     */
-    public function generateToken()
+    public function generateToken(): string
     {
         return rtrim(strtr(base64_encode($this->getRandomNumber()), '+/', '-_'), '=');
     }

src/TokenGeneratorInterface.php

@@ -6,8 +6,5 @@
 
 interface TokenGeneratorInterface
 {
-    /**
-     * @return string
-     */
-    public function generateToken();
+    public function generateToken(): string;
 }