Filter unsupported OpenSSL cipher methods on PHP 8.0-8.4 (#4982)

Co-authored-by: phpstan-bot <79867460+phpstan-bot@users.noreply.github.com>

Author: VincentLanglet

src/Type/Php/OpenSslCipherMethodsProvider.php

@@ -0,0 +1,57 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Php;
+
+use PHPStan\DependencyInjection\AutowiredService;
+use function array_filter;
+use function array_map;
+use function array_values;
+use function function_exists;
+use function in_array;
+use function openssl_cipher_iv_length;
+use function openssl_get_cipher_methods;
+use function strtolower;
+
+#[AutowiredService]
+final class OpenSslCipherMethodsProvider
+{
+
+	/** @var list<string>|null */
+	private ?array $supportedCipherMethods = null;
+
+	/**
+	 * Returns supported cipher methods in lowercase.
+	 *
+	 * Filters out methods that openssl_get_cipher_methods() reports
+	 * but are not actually usable due to https://github.com/php/php-src/issues/19994
+	 *
+	 * @return list<string>
+	 */
+	public function getSupportedCipherMethods(): array
+	{
+		if ($this->supportedCipherMethods !== null) {
+			return $this->supportedCipherMethods;
+		}
+
+		$methods = [];
+		if (function_exists('openssl_get_cipher_methods')) {
+			// openssl_get_cipher_methods() reports algorithms that are not actually
+			// supported on PHP 8.0-8.4 due to https://github.com/php/php-src/issues/19994
+			// Filter by actually testing each algorithm with openssl_cipher_iv_length().
+			$methods = array_values(array_filter(
+				openssl_get_cipher_methods(true),
+				static fn (string $algorithm): bool => @openssl_cipher_iv_length($algorithm) !== false,
+			));
+		}
+
+		$this->supportedCipherMethods = array_map('strtolower', $methods);
+
+		return $this->supportedCipherMethods;
+	}
+
+	public function isSupportedCipherMethod(string $method): bool
+	{
+		return in_array(strtolower($method), $this->getSupportedCipherMethods(), true);
+	}
+
+}

src/Type/Php/OpenSslEncryptParameterOutTypeExtension.php

@@ -16,14 +16,17 @@
 use PHPStan\Type\TypeCombinator;
 use PHPStan\Type\UnionType;
 use function in_array;
-use function openssl_get_cipher_methods;
 use function strtolower;
 use function substr;
 
 #[AutowiredService]
 final class OpenSslEncryptParameterOutTypeExtension implements FunctionParameterOutTypeExtension
 {
 
+	public function __construct(private OpenSslCipherMethodsProvider $cipherMethodsProvider)
+	{
+	}
+
 	public function isFunctionSupported(FunctionReflection $functionReflection, ParameterReflection $parameter): bool
 	{
 		return $functionReflection->getName() === 'openssl_encrypt' && $parameter->getName() === 'tag';
@@ -44,7 +47,7 @@ public function getParameterOutTypeFromFunctionCall(FunctionReflection $function
 			$cipher = strtolower($cipherType->getValue());
 			$mode = substr($cipher, -3);
 
-			if (!in_array($cipher, openssl_get_cipher_methods(), true)) {
+			if (!$this->cipherMethodsProvider->isSupportedCipherMethod($cipher)) {
 				$tagTypes[] = new NullType();
 				continue;
 			}

src/Type/Php/OpensslCipherFunctionsReturnTypeExtension.php

@@ -16,20 +16,16 @@
 use function array_map;
 use function array_unique;
 use function count;
-use function function_exists;
 use function in_array;
-use function is_null;
-use function openssl_get_cipher_methods;
-use function strtoupper;
 
 #[AutowiredService]
 final class OpensslCipherFunctionsReturnTypeExtension implements DynamicFunctionReturnTypeExtension
 {
 
-	/** @var string[]|null */
-	private ?array $supportedAlgorithms = null;
-
-	public function __construct(private PhpVersion $phpVersion)
+	public function __construct(
+		private PhpVersion $phpVersion,
+		private OpenSslCipherMethodsProvider $cipherMethodsProvider,
+	)
 	{
 	}
 
@@ -49,7 +45,7 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 		}
 
 		$strings = $scope->getType($functionCall->getArgs()[0]->value)->getConstantStrings();
-		$results = array_unique(array_map(fn (ConstantStringType $algorithm): bool => $this->isSupportedAlgorithm($algorithm->getValue()), $strings));
+		$results = array_unique(array_map(fn (ConstantStringType $algorithm): bool => $this->cipherMethodsProvider->isSupportedCipherMethod($algorithm->getValue()), $strings));
 
 		if (count($results) !== 1) {
 			return null;
@@ -66,25 +62,4 @@ public function getTypeFromFunctionCall(FunctionReflection $functionReflection,
 			: new ConstantBooleanType(false);
 	}
 
-	private function isSupportedAlgorithm(string $algorithm): bool
-	{
-		return in_array(strtoupper($algorithm), $this->getSupportedAlgorithms(), true);
-	}
-
-	/** @return string[] */
-	private function getSupportedAlgorithms(): array
-	{
-		if (!is_null($this->supportedAlgorithms)) {
-			return $this->supportedAlgorithms;
-		}
-
-		$supportedAlgorithms = [];
-		if (function_exists('openssl_get_cipher_methods')) {
-			$supportedAlgorithms = openssl_get_cipher_methods(true);
-		}
-		$this->supportedAlgorithms = array_map('strtoupper', $supportedAlgorithms);
-
-		return $this->supportedAlgorithms;
-	}
-
 }

tests/PHPStan/Analyser/NodeScopeResolverTest.php

@@ -39,6 +39,10 @@ private static function findTestFiles(): iterable
 			yield __DIR__ . '/data/enum-reflection-backed.php';
 		}
 
+		if (PHP_VERSION_ID >= 80000 && PHP_VERSION_ID < 80500) {
+			yield __DIR__ . '/data/bug-13692.php';
+		}
+
 		if (PHP_VERSION_ID < 80000) {
 			yield __DIR__ . '/data/bug-4902.php';
 		}

tests/PHPStan/Analyser/data/bug-13692.php

@@ -0,0 +1,24 @@
+<?php // lint >= 8.0
+
+namespace Bug13692;
+
+use function PHPStan\Testing\assertType;
+
+class Foo
+{
+
+	public function doFoo(): void
+	{
+		// aes-128-cbc-cts is reported by openssl_get_cipher_methods() on PHP 8.0-8.4
+		// but is not actually supported by openssl_cipher_iv_length() due to a PHP bug
+		// https://github.com/php/php-src/issues/19994
+		// On PHP 8.4 where PHPStan runs, this should be refined to false
+		// (not incorrectly refined to int)
+		assertType('false', openssl_cipher_iv_length('aes-128-cbc-cts'));
+
+		// These should still work correctly
+		assertType('int', openssl_cipher_iv_length('aes-128-cbc'));
+		assertType('false', openssl_cipher_iv_length('unknown'));
+	}
+
+}

tests/PHPStan/Analyser/nsrt/bug-13692-php85.php

@@ -0,0 +1,17 @@
+<?php // lint >= 8.5
+
+namespace Bug13692Php85;
+
+use function PHPStan\Testing\assertType;
+
+class Foo
+{
+
+	public function doFoo()
+	{
+		assertType('int', openssl_cipher_iv_length('aes-128-cbc-cts'));
+		assertType('int', openssl_cipher_iv_length('aes-128-cbc'));
+		assertType('false', openssl_cipher_iv_length('unknown'));
+	}
+
+}