Fix hash_*() signatures (#4014)

Functions can return false when an invalid algorithm is supplied
vimeo · Aug 18, 2020 · 7ac6d2e · 7ac6d2e
1 parent 1468a28
commit 7ac6d2e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/src/Psalm/Internal/CallMap.php b/src/Psalm/Internal/CallMap.php
@@ -4251,18 +4251,18 @@
 'HaruPage::stroke' => ['bool', 'close_path='=>'bool'],
 'HaruPage::textOut' => ['bool', 'x'=>'float', 'y'=>'float', 'text'=>'string'],
 'HaruPage::textRect' => ['bool', 'left'=>'float', 'top'=>'float', 'right'=>'float', 'bottom'=>'float', 'text'=>'string', 'align='=>'int'],
-'hash' => ['string', 'algo'=>'string', 'data'=>'string', 'raw_output='=>'bool'],
+'hash' => ['string|false', 'algo'=>'string', 'data'=>'string', 'raw_output='=>'bool'],
 'hash_algos' => ['list<string>'],
 'hash_copy' => ['HashContext', 'context'=>'HashContext|resource'],
 'hash_equals' => ['bool', 'known_string'=>'string', 'user_string'=>'string'],
 'hash_file' => ['string|false', 'algo'=>'string', 'filename'=>'string', 'raw_output='=>'bool'],
 'hash_final' => ['string', 'context'=>'HashContext|resource', 'raw_output='=>'bool'],
 'hash_hkdf' => ['string|false', 'algo'=>'string', 'ikm'=>'string', 'length='=>'int', 'info='=>'string', 'salt='=>'string'],
-'hash_hmac' => ['string', 'algo'=>'string', 'data'=>'string', 'key'=>'string', 'raw_output='=>'bool'],
+'hash_hmac' => ['string|false', 'algo'=>'string', 'data'=>'string', 'key'=>'string', 'raw_output='=>'bool'],
 'hash_hmac_algos' => ['list<string>'],
-'hash_hmac_file' => ['string', 'algo'=>'string', 'filename'=>'string', 'key'=>'string', 'raw_output='=>'bool'],
-'hash_init' => ['HashContext', 'algo'=>'string', 'options='=>'int', 'key='=>'string'],
-'hash_pbkdf2' => ['string', 'algo'=>'string', 'password'=>'string', 'salt'=>'string', 'iterations'=>'int', 'length='=>'int', 'raw_output='=>'bool'],
+'hash_hmac_file' => ['string|false', 'algo'=>'string', 'filename'=>'string', 'key'=>'string', 'raw_output='=>'bool'],
+'hash_init' => ['HashContext|false', 'algo'=>'string', 'options='=>'int', 'key='=>'string'],
+'hash_pbkdf2' => ['string|false', 'algo'=>'string', 'password'=>'string', 'salt'=>'string', 'iterations'=>'int', 'length='=>'int', 'raw_output='=>'bool'],
 'hash_update' => ['bool', 'context'=>'HashContext', 'data'=>'string'],
 'hash_update_file' => ['bool', 'context'=>'HashContext', 'filename'=>'string', 'scontext='=>'?HashContext'],
 'hash_update_stream' => ['int', 'context'=>'HashContext', 'handle'=>'resource', 'length='=>'int'],

diff --git a/tests/FunctionCallTest.php b/tests/FunctionCallTest.php
@@ -873,7 +873,7 @@ class Foo {}
                 '<?php
                     $h = hash_init("sha256");',
                 [
-                    '$h' => 'HashContext',
+                    '$h' => 'HashContext|false',
                 ],
                 [],
                 '7.2',
@@ -882,7 +882,7 @@ class Foo {}
                 '<?php
                     $h = hash_init("sha256");',
                 [
-                    '$h' => 'HashContext',
+                    '$h' => 'HashContext|false',
                 ],
                 [],
                 '7.3',