Add more precise return types for the openssl cipher functions

Author: stof

conf/config.neon

@@ -1580,6 +1580,11 @@ services:
 		tags:
 			- phpstan.dynamicFunctionThrowTypeExtension
 
+	-
+		class: PHPStan\Type\Php\OpensslCipherFunctionsReturnTypeExtension
+		tags:
+			- phpstan.broker.dynamicFunctionReturnTypeExtension
+
 	-
 		class: PHPStan\Type\Php\OpenSslEncryptParameterOutTypeExtension
 		tags:

src/Type/Php/OpensslCipherFunctionsReturnTypeExtension.php

@@ -0,0 +1,87 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Php;
+
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Analyser\Scope;
+use PHPStan\Php\PhpVersion;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\Constant\ConstantBooleanType;
+use PHPStan\Type\Constant\ConstantStringType;
+use PHPStan\Type\DynamicFunctionReturnTypeExtension;
+use PHPStan\Type\Type;
+use PHPStan\Type\TypeCombinator;
+use function array_map;
+use function array_unique;
+use function count;
+use function in_array;
+use function is_null;
+use function openssl_get_cipher_methods;
+use function strtoupper;
+
+final class OpensslCipherFunctionsReturnTypeExtension implements DynamicFunctionReturnTypeExtension
+{
+
+	/** @var string[]|null */
+	private ?array $supportedAlgorithms = null;
+
+	public function __construct(private PhpVersion $phpVersion)
+	{
+	}
+
+	public function isFunctionSupported(FunctionReflection $functionReflection): bool
+	{
+		return in_array($functionReflection->getName(), ['openssl_cipher_iv_length', 'openssl_cipher_key_length'], true);
+	}
+
+	public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): Type
+	{
+		$returnType = ParametersAcceptorSelector::selectFromArgs(
+			$scope,
+			$functionCall->getArgs(),
+			$functionReflection->getVariants(),
+		)->getReturnType();
+
+		if (!$this->phpVersion->throwsValueErrorForInternalFunctions()) {
+			return $returnType;
+		}
+
+		if (count($functionCall->getArgs()) < 1) {
+			return $returnType;
+		}
+
+		$strings = $scope->getType($functionCall->getArgs()[0]->value)->getConstantStrings();
+		$results = array_unique(array_map(fn (ConstantStringType $algorithm): bool => $this->isSupportedAlgorithm($algorithm->getValue()), $strings));
+
+		if (count($results) === 1) {
+			return $results[0]
+				? TypeCombinator::remove($returnType, new ConstantBooleanType(false))
+				: new ConstantBooleanType(false);
+		}
+
+		return $returnType;
+	}
+
+	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/nsrt/openssl-cipher-php7.php

@@ -0,0 +1,31 @@
+<?php // lint < 8.0
+
+namespace OpensslCipherPhp7;
+
+use function PHPStan\Testing\assertType;
+
+class OpensslCipher
+{
+
+	/**
+	 * @param 'aes-256-cbc'|'aes128'|'aes-128-cbc' $validAlgorithms
+	 * @param 'aes-256-cbc'|'invalid' $validAndInvalidAlgorithms
+	 */
+	public function doFoo(string $s, $validAlgorithms, $validAndInvalidAlgorithms)
+	{
+		assertType('int|false', openssl_cipher_iv_length('aes-256-cbc'));
+		assertType('int|false', openssl_cipher_iv_length('AES-256-CBC'));
+		assertType('int|false', openssl_cipher_iv_length('unsupported'));
+		assertType('int|false', openssl_cipher_iv_length($s));
+		assertType('int|false', openssl_cipher_iv_length($validAlgorithms));
+		assertType('int|false', openssl_cipher_iv_length($validAndInvalidAlgorithms));
+
+		assertType('int|false', openssl_cipher_key_length('aes-256-cbc'));
+		assertType('int|false', openssl_cipher_key_length('AES-256-CBC'));
+		assertType('int|false', openssl_cipher_key_length('unsupported'));
+		assertType('int|false', openssl_cipher_key_length($s));
+		assertType('int|false', openssl_cipher_key_length($validAlgorithms));
+		assertType('int|false', openssl_cipher_key_length($validAndInvalidAlgorithms));
+	}
+
+}

tests/PHPStan/Analyser/nsrt/openssl-cipher-php8.php

@@ -0,0 +1,31 @@
+<?php // lint >= 8.0
+
+namespace OpensslCipherPhp8;
+
+use function PHPStan\Testing\assertType;
+
+class OpensslCipher
+{
+
+	/**
+	 * @param 'aes-256-cbc'|'aes128'|'aes-128-cbc' $validAlgorithms
+	 * @param 'aes-256-cbc'|'invalid' $validAndInvalidAlgorithms
+	 */
+	public function doFoo(string $s, $validAlgorithms, $validAndInvalidAlgorithms)
+	{
+		assertType('int', openssl_cipher_iv_length('aes-256-cbc'));
+		assertType('int', openssl_cipher_iv_length('AES-256-CBC'));
+		assertType('false', openssl_cipher_iv_length('unsupported'));
+		assertType('int|false', openssl_cipher_iv_length($s));
+		assertType('int', openssl_cipher_iv_length($validAlgorithms));
+		assertType('int|false', openssl_cipher_iv_length($validAndInvalidAlgorithms));
+
+		assertType('int', openssl_cipher_key_length('aes-256-cbc'));
+		assertType('int', openssl_cipher_key_length('AES-256-CBC'));
+		assertType('false', openssl_cipher_key_length('unsupported'));
+		assertType('int|false', openssl_cipher_key_length($s));
+		assertType('int', openssl_cipher_key_length($validAlgorithms));
+		assertType('int|false', openssl_cipher_key_length($validAndInvalidAlgorithms));
+	}
+
+}