"Replace mb_* functions with equivalent non-multibyte functions" (#578)

This commit replaces mb_* functions with non-multibyte equivalent functions, which don't require mbstring extension. It also adjusts the required PHP version in composer.json from 8.3 to 8.2. This change reduces dependencies and broadens compatibility without impacting functionality. It is part of an overall code simplification and optimization effort.
web-token · Jul 9, 2024 · 4af252f · 4af252f
1 parent 57c78f2
commit 4af252f
Show file tree

Hide file tree

Showing 64 changed files with 199 additions and 181 deletions.
diff --git a/.github/workflows/integrate.yml b/.github/workflows/integrate.yml
@@ -68,6 +68,7 @@ jobs:
         operating-system:
           - "ubuntu-latest"
         php-version:
+          - "8.2"
           - "8.3"
         dependencies:
           - "lowest"
@@ -196,7 +197,7 @@ jobs:
       - name: "Install dependencies"
         uses: "ramsey/composer-install@v3"
         with:
-          dependency-versions: "highest"
+          dependency-versions: "lowest"
           composer-options: "--optimize-autoloader"
 
       - name: "Execute Rector"

diff --git a/castor.php b/castor.php
@@ -77,10 +77,13 @@ function cs(
 }
 
 #[AsTask(description: 'Running PHPStan')]
-function stan(): void
+function stan(bool $baseline = false): void
 {
     io()->title('Running PHPStan');
     $command = ['php', 'vendor/bin/phpstan', 'analyse'];
+    if ($baseline) {
+        $command[] = '--generate-baseline';
+    }
     $environment = [
         'XDEBUG_MODE' => 'off',
     ];

diff --git a/composer.json b/composer.json
@@ -46,9 +46,8 @@
         }
     },
     "require": {
-        "php": ">=8.3",
+        "php": ">=8.2",
         "ext-json": "*",
-        "ext-mbstring": "*",
         "ext-openssl": "*",
         "brick/math": "^0.12",
         "psr/clock": "^1.0",

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1225,6 +1225,11 @@ parameters:
 			count: 1
 			path: src/Library/Core/JWKSet.php
 
+		-
+			message: "#^Parameter \\#2 \\$mode of function count expects 0\\|1, int given\\.$#"
+			count: 1
+			path: src/Library/Core/JWKSet.php
+
 		-
 			message: "#^Property Jose\\\\Component\\\\Core\\\\JWKSet\\:\\:\\$keys type has no value type specified in iterable type array\\.$#"
 			count: 1
@@ -1346,12 +1351,12 @@ parameters:
 			path: src/Library/Encryption/Algorithm/ContentEncryption/AESCBCHS.php
 
 		-
-			message: "#^Parameter \\#3 \\$length of function mb_substr expects int\\|null, float\\|int\\<1, max\\> given\\.$#"
+			message: "#^Parameter \\#3 \\$length of function substr expects int\\|null, float\\|int\\<1, max\\> given\\.$#"
 			count: 1
 			path: src/Library/Encryption/Algorithm/ContentEncryption/AESCBCHS.php
 
 		-
-			message: "#^Parameter \\#3 \\$length of function mb_substr expects int\\|null, float\\|int\\<min, \\-1\\> given\\.$#"
+			message: "#^Parameter \\#3 \\$length of function substr expects int\\|null, float\\|int\\<min, \\-1\\> given\\.$#"
 			count: 1
 			path: src/Library/Encryption/Algorithm/KeyEncryption/AbstractECDH.php
 
@@ -1761,7 +1766,7 @@ parameters:
 			path: src/Library/KeyManagement/JWKFactory.php
 
 		-
-			message: "#^Parameter \\#3 \\$length of function mb_substr expects int\\|null, float\\|int\\<min, \\-1\\> given\\.$#"
+			message: "#^Parameter \\#3 \\$length of function substr expects int\\|null, float\\|int\\<min, \\-1\\> given\\.$#"
 			count: 1
 			path: src/Library/KeyManagement/JWKFactory.php
 

diff --git a/rector.php b/rector.php
@@ -13,7 +13,7 @@
 
 return static function (RectorConfig $config): void {
     $config->import(SetList::DEAD_CODE);
-    $config->import(LevelSetList::UP_TO_PHP_83);
+    $config->import(LevelSetList::UP_TO_PHP_82);
     $config->import(SymfonySetList::SYMFONY_64);
     $config->import(SymfonySetList::SYMFONY_50_TYPES);
     $config->import(SymfonySetList::SYMFONY_52_VALIDATOR_ATTRIBUTES);
@@ -38,7 +38,7 @@
         __DIR__ . '/src/Bundle/JoseFramework/DependencyInjection/Source/KeyManagement/JWKSource.php',
         __DIR__ . '/src/Bundle/JoseFramework/DependencyInjection/Source/KeyManagement/JWKSetSource.php',
     ]);
-    $config->phpVersion(PhpVersion::PHP_83);
+    $config->phpVersion(PhpVersion::PHP_82);
     $config->parallel();
     $config->importNames();
     $config->importShortClasses();

diff --git a/src/Bundle/Helper/ConfigurationHelper.php b/src/Bundle/Helper/ConfigurationHelper.php
@@ -9,7 +9,7 @@
 
 final readonly class ConfigurationHelper
 {
-    final public const string BUNDLE_ALIAS = 'jose';
+    final public const BUNDLE_ALIAS = 'jose';
 
     /**
      * @param string[] $signatureAlgorithms

diff --git a/src/Bundle/Serializer/JWEEncoder.php b/src/Bundle/Serializer/JWEEncoder.php
@@ -17,7 +17,6 @@
 use Throwable;
 use function in_array;
 use function is_int;
-use function mb_strtolower;
 
 final readonly class JWEEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface
 {
@@ -54,7 +53,7 @@ public function encode(mixed $data, string $format, array $context = []): string
 
         try {
             return $this->serializerManager->serialize(
-                mb_strtolower($format),
+                strtolower($format),
                 $data,
                 $this->getRecipientIndex($context)
             );
@@ -91,6 +90,6 @@ private function getRecipientIndex(array $context): int
     private function formatSupported(?string $format): bool
     {
         return $format !== null
-            && in_array(mb_strtolower($format), $this->serializerManager->names(), true);
+            && in_array(strtolower($format), $this->serializerManager->names(), true);
     }
 }
diff --git a/src/Bundle/Serializer/JWESerializer.php b/src/Bundle/Serializer/JWESerializer.php
@@ -11,11 +11,10 @@
 use Override;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use function in_array;
-use function mb_strtolower;
 
 final readonly class JWESerializer implements DenormalizerInterface
 {
-    private readonly JWESerializerManager $serializerManager;
+    private JWESerializerManager $serializerManager;
 
     public function __construct(
         JWESerializerManagerFactory $serializerManagerFactory,
@@ -63,6 +62,6 @@ public function denormalize(mixed $data, string $type, ?string $format = null, a
     private function formatSupported(?string $format): bool
     {
         return $format !== null
-            && in_array(mb_strtolower($format), $this->serializerManager->names(), true);
+            && in_array(strtolower($format), $this->serializerManager->names(), true);
     }
 }
diff --git a/src/Bundle/Serializer/JWSEncoder.php b/src/Bundle/Serializer/JWSEncoder.php
@@ -16,7 +16,6 @@
 use Symfony\Component\Serializer\Exception\NotEncodableValueException;
 use function in_array;
 use function is_int;
-use function mb_strtolower;
 
 final readonly class JWSEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface
 {
@@ -53,7 +52,7 @@ public function encode($data, $format, array $context = []): string
 
         try {
             return $this->serializerManager->serialize(
-                mb_strtolower($format),
+                strtolower($format),
                 $data,
                 $this->getSignatureIndex($context)
             );
@@ -90,6 +89,6 @@ private function getSignatureIndex(array $context): int
     private function formatSupported(?string $format): bool
     {
         return $format !== null
-            && in_array(mb_strtolower($format), $this->serializerManager->list(), true);
+            && in_array(strtolower($format), $this->serializerManager->list(), true);
     }
 }
diff --git a/src/Bundle/Serializer/JWSSerializer.php b/src/Bundle/Serializer/JWSSerializer.php
@@ -11,7 +11,6 @@
 use Override;
 use Symfony\Component\Serializer\Normalizer\DenormalizerInterface;
 use function in_array;
-use function mb_strtolower;
 
 final readonly class JWSSerializer implements DenormalizerInterface
 {
@@ -63,6 +62,6 @@ public function denormalize(mixed $data, string $type, ?string $format = null, a
     private function formatSupported(?string $format): bool
     {
         return $format !== null
-            && in_array(mb_strtolower($format), $this->serializerManager->list(), true);
+            && in_array(strtolower($format), $this->serializerManager->list(), true);
     }
 }
diff --git a/src/Bundle/composer.json b/src/Bundle/composer.json
@@ -38,7 +38,7 @@
         }
     },
     "require": {
-        "php": ">=8.3",
+        "php": ">=8.2",
         "psr/event-dispatcher": "^1.0",
         "symfony/config": "^7.0",
         "symfony/console": "^7.0",

diff --git a/src/Experimental/KeyEncryption/Chacha20Poly1305.php b/src/Experimental/KeyEncryption/Chacha20Poly1305.php
@@ -13,6 +13,7 @@
 use RuntimeException;
 use function in_array;
 use function is_string;
+use function strlen;
 use const OPENSSL_RAW_DATA;
 
 final readonly class Chacha20Poly1305 implements KeyEncryption
@@ -68,7 +69,7 @@ public function decryptKey(JWK $key, string $encrypted_cek, array $header): stri
         isset($header['nonce']) || throw new InvalidArgumentException('The header parameter "nonce" is missing.');
         is_string($header['nonce']) || throw new InvalidArgumentException('The header parameter "nonce" is not valid.');
         $nonce = Base64UrlSafe::decodeNoPadding($header['nonce']);
-        if (mb_strlen($nonce, '8bit') !== 12) {
+        if (strlen($nonce) !== 12) {
             throw new InvalidArgumentException('The header parameter "nonce" is not valid.');
         }
 

diff --git a/src/Experimental/Signature/Blake2b.php b/src/Experimental/Signature/Blake2b.php
@@ -13,13 +13,14 @@
 use function extension_loaded;
 use function in_array;
 use function is_string;
+use function strlen;
 
 /**
  * @see \Jose\Tests\Component\Signature\Algorithm\Blake2bTest
  */
 final readonly class Blake2b implements MacAlgorithm
 {
-    private const int MINIMUM_KEY_LENGTH = 32;
+    private const MINIMUM_KEY_LENGTH = 32;
 
     public function __construct()
     {
@@ -67,7 +68,7 @@ private function getKey(JWK $key): string
             throw new InvalidArgumentException('The key parameter "k" is invalid.');
         }
         $key = Base64UrlSafe::decodeNoPadding($k);
-        if (mb_strlen($key, '8bit') < self::MINIMUM_KEY_LENGTH) {
+        if (strlen($key) < self::MINIMUM_KEY_LENGTH) {
             throw new InvalidArgumentException('Key provided is shorter than 256 bits.');
         }
 

diff --git a/src/Experimental/Signature/HS256_64.php b/src/Experimental/Signature/HS256_64.php
@@ -15,7 +15,7 @@ public function hash(JWK $key, string $input): string
     {
         $signature = parent::hash($key, $input);
 
-        return mb_substr($signature, 0, 8, '8bit');
+        return substr($signature, 0, 8);
     }
 
     #[Override]

diff --git a/src/Experimental/composer.json b/src/Experimental/composer.json
@@ -38,7 +38,7 @@
         }
     },
     "require": {
-        "php": ">=8.3",
+        "php": ">=8.2",
         "ext-openssl": "*",
         "web-token/jwt-library": "^4.0"
     }

diff --git a/src/Library/Checker/AlgorithmChecker.php b/src/Library/Checker/AlgorithmChecker.php
@@ -15,7 +15,7 @@
  */
 final readonly class AlgorithmChecker implements HeaderChecker
 {
-    private const string HEADER_NAME = 'alg';
+    private const HEADER_NAME = 'alg';
 
     /**
      * @param string[] $supportedAlgorithms

diff --git a/src/Library/Checker/AudienceChecker.php b/src/Library/Checker/AudienceChecker.php
@@ -14,7 +14,7 @@
  */
 final readonly class AudienceChecker implements ClaimChecker, HeaderChecker
 {
-    private const string CLAIM_NAME = 'aud';
+    private const CLAIM_NAME = 'aud';
 
     public function __construct(
         private string $audience,

diff --git a/src/Library/Checker/ExpirationTimeChecker.php b/src/Library/Checker/ExpirationTimeChecker.php
@@ -16,7 +16,7 @@
  */
 final readonly class ExpirationTimeChecker implements ClaimChecker, HeaderChecker
 {
-    private const string NAME = 'exp';
+    private const NAME = 'exp';
 
     public function __construct(
         private ClockInterface $clock,

diff --git a/src/Library/Checker/IssuedAtChecker.php b/src/Library/Checker/IssuedAtChecker.php
@@ -14,7 +14,7 @@
  */
 final readonly class IssuedAtChecker implements ClaimChecker, HeaderChecker
 {
-    private const string NAME = 'iat';
+    private const NAME = 'iat';
 
     public function __construct(
         private ClockInterface $clock,

diff --git a/src/Library/Checker/IssuerChecker.php b/src/Library/Checker/IssuerChecker.php
@@ -15,7 +15,7 @@
  */
 final readonly class IssuerChecker implements ClaimChecker, HeaderChecker
 {
-    private const string CLAIM_NAME = 'iss';
+    private const CLAIM_NAME = 'iss';
 
     public function __construct(
         private array $issuers,

diff --git a/src/Library/Checker/NotBeforeChecker.php b/src/Library/Checker/NotBeforeChecker.php
@@ -14,7 +14,7 @@
  */
 final readonly class NotBeforeChecker implements ClaimChecker, HeaderChecker
 {
-    private const string NAME = 'nbf';
+    private const NAME = 'nbf';
 
     public function __construct(
         private ClockInterface $clock,

diff --git a/src/Library/Checker/UnencodedPayloadChecker.php b/src/Library/Checker/UnencodedPayloadChecker.php
@@ -14,7 +14,7 @@
  */
 final class UnencodedPayloadChecker implements HeaderChecker
 {
-    private const string HEADER_NAME = 'b64';
+    private const HEADER_NAME = 'b64';
 
     #[Override]
     public function checkHeader(mixed $value): void

diff --git a/src/Library/Core/Util/Base64UrlSafe.php b/src/Library/Core/Util/Base64UrlSafe.php
@@ -4,6 +4,8 @@
 
 namespace Jose\Component\Core\Util;
 
+use function strlen;
+
 /**
  *  Copyright (c) 2016 - 2022 Paragon Initiative Enterprises.
  *  Copyright (c) 2014 Steve "Sc00bz" Thomas (steve at tobtu dot com)
@@ -202,14 +204,14 @@ private static function encode6Bits(int $src): string
 
     private static function safeStrlen(string $str): int
     {
-        return mb_strlen($str, '8bit');
+        return strlen($str);
     }
 
     private static function safeSubstr(string $str, int $start = 0, $length = null): string
     {
         if ($length === 0) {
             return '';
         }
-        return mb_substr($str, $start, $length, '8bit');
+        return substr($str, $start, $length);
     }
 }
diff --git a/src/Library/Core/Util/BigInteger.php b/src/Library/Core/Util/BigInteger.php
@@ -7,6 +7,7 @@
 use Brick\Math\BigInteger as BrickBigInteger;
 use InvalidArgumentException;
 use function chr;
+use function strlen;
 
 /**
  * @internal
@@ -49,7 +50,7 @@ public function toBytes(): string
         }
 
         $temp = $this->value->toBase(16);
-        $temp = 0 !== (mb_strlen($temp, '8bit') & 1) ? '0' . $temp : $temp;
+        $temp = 0 !== (strlen($temp) & 1) ? '0' . $temp : $temp;
         $temp = hex2bin($temp);
         if ($temp === false) {
             throw new InvalidArgumentException('Unable to convert the value into bytes');