Add stub for $tag of openssl_encrypt()

phpstan · Dec 22, 2024 · 1663a9f · 1663a9f
1 parent b5fc9ec
commit 1663a9f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/conf/config.neon b/conf/config.neon
@@ -201,6 +201,7 @@ parameters:
 		- ../stubs/arrayFunctions.stub
 		- ../stubs/core.stub
 		- ../stubs/typeCheckingFunctions.stub
+		- ../stubs/openssl.stub
 	earlyTerminatingMethodCalls: []
 	earlyTerminatingFunctionCalls: []
 	memoryLimitFile: %tmpDir%/.memory_limit

diff --git a/stubs/openssl.stub b/stubs/openssl.stub
@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * @param-out string $tag
+ *
+ * @return string|false
+ */
+function openssl_encrypt(
+    #[\SensitiveParameter] string $data,
+    string $cipher_algo,
+    #[\SensitiveParameter] string $passphrase,
+    int $options = 0,
+    string $iv = "",
+    ?string &$tag = null,
+    string $aad = "",
+    int $tag_length = 16
+) {}
diff --git a/tests/PHPStan/Analyser/nsrt/openssl.php b/tests/PHPStan/Analyser/nsrt/openssl.php
@@ -0,0 +1,8 @@
+<?php
+
+use function PHPStan\Testing\assertType;
+
+$ciphertext = openssl_encrypt('plain text', 'aes-256-gcm', 'key', OPENSSL_RAW_DATA, 'iv', $tag, '', 16);
+
+assertType('string|false', $ciphertext);
+assertType('string', $tag);