Use #[\SensitiveParameter] attribute instead of @sensitive-param in stubs

Author: TimWolla

ext/ftp/ftp.stub.php

@@ -75,8 +75,7 @@ function ftp_connect(string $hostname, int $port = 21, int $timeout = 90): FTP\C
     function ftp_ssl_connect(string $hostname, int $port = 21, int $timeout = 90): FTP\Connection|false {}
     #endif
 
-    /** @sensitive-param $password */
-    function ftp_login(FTP\Connection $ftp, string $username, string $password): bool {}
+    function ftp_login(FTP\Connection $ftp, string $username, #[\SensitiveParameter] string $password): bool {}
     function ftp_pwd(FTP\Connection $ftp): string|false {}
     function ftp_cdup(FTP\Connection $ftp): bool {}
     function ftp_chdir(FTP\Connection $ftp, string $directory): bool {}

ext/ftp/ftp_arginfo.h

@@ -15,22 +15,19 @@ function hash(string $algo, string $data, bool $binary = false, array $options =
 function hash_file(string $algo, string $filename, bool $binary = false, array $options = []): string|false {}
 
 /**
- * @sensitive-param $key
  * @refcount 1
  */
-function hash_hmac(string $algo, string $data, string $key, bool $binary = false): string {}
+function hash_hmac(string $algo, string $data, #[\SensitiveParameter] string $key, bool $binary = false): string {}
 
 /**
- * @sensitive-param $key
  * @refcount 1
  */
-function hash_hmac_file(string $algo, string $filename, string $key, bool $binary = false): string|false {}
+function hash_hmac_file(string $algo, string $filename, #[\SensitiveParameter] string $key, bool $binary = false): string|false {}
 
 /**
- * @sensitive-param $key
  * @refcount 1
  */
-function hash_init(string $algo, int $flags = 0, string $key = "", array $options = []): HashContext {}
+function hash_init(string $algo, int $flags = 0, #[\SensitiveParameter] string $key = "", array $options = []): HashContext {}
 
 function hash_update(HashContext $context, string $data): bool {}
 
@@ -59,22 +56,16 @@ function hash_algos(): array {}
 function hash_hmac_algos(): array {}
 
 /**
- * @sensitive-param $password
  * @refcount 1
  */
-function hash_pbkdf2(string $algo, string $password, string $salt, int $iterations, int $length = 0, bool $binary = false): string {}
+function hash_pbkdf2(string $algo, #[\SensitiveParameter] string $password, string $salt, int $iterations, int $length = 0, bool $binary = false): string {}
 
-/**
- * @sensitive-param $known_string
- * @sensitive-param $user_string
- */
-function hash_equals(string $known_string, string $user_string): bool {}
+function hash_equals(#[\SensitiveParameter] string $known_string, #[\SensitiveParameter] string $user_string): bool {}
 
 /**
- * @sensitive-param $key
  * @refcount 1
  */
-function hash_hkdf(string $algo, string $key, int $length = 0, string $info = "", string $salt = ""): string {}
+function hash_hkdf(string $algo, #[\SensitiveParameter] string $key, int $length = 0, string $info = "", string $salt = ""): string {}
 
 #ifdef PHP_MHASH_BC
 /** @deprecated */

ext/hash/hash.stub.php

@@ -405,8 +405,7 @@
      */
     const IMAP_GC_TEXTS = UNKNOWN;
 
-    /** @sensitive-param $password */
-    function imap_open(string $mailbox, string $user, string $password, int $flags = 0, int $retries = 0, array $options = []): IMAP\Connection|false {}
+    function imap_open(string $mailbox, string $user, #[\SensitiveParameter] string $password, int $flags = 0, int $retries = 0, array $options = []): IMAP\Connection|false {}
 
     function imap_reopen(IMAP\Connection $imap, string $mailbox, int $flags = 0, int $retries = 0): bool {}
 

ext/hash/hash_arginfo.h

@@ -610,10 +610,7 @@
 #endif
 
     #ifdef HAVE_ORALDAP
-    /**
-     * @sensitive-param $password
-     */
-    function ldap_connect(?string $uri = null, int $port = 389, string $wallet = UNKNOWN, string $password = UNKNOWN, int $auth_mode = GSLC_SSL_NO_AUTH): LDAP\Connection|false {}
+    function ldap_connect(?string $uri = null, int $port = 389, string $wallet = UNKNOWN, #[\SensitiveParameter] string $password = UNKNOWN, int $auth_mode = GSLC_SSL_NO_AUTH): LDAP\Connection|false {}
     #else
     function ldap_connect(?string $uri = null, int $port = 389): LDAP\Connection|false {}
     #endif
@@ -623,21 +620,12 @@ function ldap_unbind(LDAP\Connection $ldap): bool {}
     /** @alias ldap_unbind */
     function ldap_close(LDAP\Connection $ldap): bool {}
 
-    /**
-     * @sensitive-param $password
-     */
-    function ldap_bind(LDAP\Connection $ldap, ?string $dn = null, ?string $password = null): bool {}
+    function ldap_bind(LDAP\Connection $ldap, ?string $dn = null, #[\SensitiveParameter] ?string $password = null): bool {}
 
-    /**
-     * @sensitive-param $password
-     */
-    function ldap_bind_ext(LDAP\Connection $ldap, ?string $dn = null, ?string $password = null, ?array $controls = null): LDAP\Result|false {}
+    function ldap_bind_ext(LDAP\Connection $ldap, ?string $dn = null, #[\SensitiveParameter] ?string $password = null, ?array $controls = null): LDAP\Result|false {}
 
     #ifdef HAVE_LDAP_SASL
-    /**
-     * @sensitive-param $password
-     */
-    function ldap_sasl_bind(LDAP\Connection $ldap, ?string $dn = null, ?string $password = null, ?string $mech = null, ?string $realm = null, ?string $authc_id = null, ?string $authz_id = null, ?string $props = null): bool {}
+    function ldap_sasl_bind(LDAP\Connection $ldap, ?string $dn = null, #[\SensitiveParameter] ?string $password = null, ?string $mech = null, ?string $realm = null, ?string $authc_id = null, ?string $authz_id = null, ?string $props = null): bool {}
     #endif
 
     /** @param LDAP\Connection|array $ldap */
@@ -791,10 +779,8 @@ function ldap_exop(LDAP\Connection $ldap, string $request_oid, ?string $request_
     #ifdef HAVE_LDAP_PASSWD
     /**
      * @param array $controls
-     * @sensitive-param $old_password
-     * @sensitive-param $new_password
      */
-    function ldap_exop_passwd(LDAP\Connection $ldap, string $user = "", string $old_password = "", string $new_password = "", &$controls = null): string|bool {}
+    function ldap_exop_passwd(LDAP\Connection $ldap, string $user = "", #[\SensitiveParameter] string $old_password = "", #[\SensitiveParameter] string $new_password = "", &$controls = null): string|bool {}
     #endif
 
 

ext/imap/php_imap.stub.php

@@ -126,11 +126,10 @@ class mysqli
      */
     public int $warning_count;
 
-    /** @sensitive-param $password */
     public function __construct(
         ?string $hostname = null,
         ?string $username = null,
-        ?string $password = null,
+        #[\SensitiveParameter] ?string $password = null,
         ?string $database = null,
         ?int $port = null,
         ?string $socket = null
@@ -149,11 +148,10 @@ public function autocommit(bool $enable): bool {}
     public function begin_transaction(int $flags = 0, ?string $name = null): bool {}
 
     /**
-     * @sensitive-param $password
      * @tentative-return-type
      * @alias mysqli_change_user
      */
-    public function change_user(string $username, string $password, ?string $database): bool {}
+    public function change_user(string $username, #[\SensitiveParameter] string $password, ?string $database): bool {}
 
     /**
      * @tentative-return-type
@@ -175,15 +173,14 @@ public function close() {} // TODO make return type void
     public function commit(int $flags = 0, ?string $name = null): bool {}
 
     /**
-     * @sensitive-param $password
      * @tentative-return-type
      * @alias mysqli_connect
      * @no-verify
      */
     public function connect(
         ?string $hostname = null,
         ?string $username = null,
-        ?string $password = null,
+        #[\SensitiveParameter] ?string $password = null,
         ?string $database = null,
         ?int $port = null,
         ?string $socket = null
@@ -289,14 +286,13 @@ public function prepare(string $query): mysqli_stmt|false {}
     public function query(string $query, int $result_mode = MYSQLI_STORE_RESULT): mysqli_result|bool {}
 
     /**
-     * @sensitive-param $password
      * @tentative-return-type
      * @alias mysqli_real_connect
      */
     public function real_connect(
         ?string $hostname = null,
         ?string $username = null,
-        ?string $password = null,
+        #[\SensitiveParameter] ?string $password = null,
         ?string $database = null,
         ?int $port = null,
         ?string $socket = null,
@@ -743,8 +739,7 @@ function mysqli_autocommit(mysqli $mysql, bool $enable): bool {}
 
 function mysqli_begin_transaction(mysqli $mysql, int $flags = 0, ?string $name = null): bool {}
 
-/** @sensitive-param $password */
-function mysqli_change_user(mysqli $mysql, string $username, string $password, ?string $database): bool {}
+function mysqli_change_user(mysqli $mysql, string $username, #[\SensitiveParameter] string $password, ?string $database): bool {}
 
 /** @refcount 1 */
 function mysqli_character_set_name(mysqli $mysql): string {}
@@ -755,12 +750,11 @@ function mysqli_commit(mysqli $mysql, int $flags = 0, ?string $name = null): boo
 
 /**
  * @refcount 1
- * @sensitive-param $password
  */
 function mysqli_connect(
     ?string $hostname = null,
     ?string $username = null,
-    ?string $password = null,
+    #[\SensitiveParameter] ?string $password = null,
     ?string $database = null,
     ?int $port = null,
     ?string $socket = null
@@ -930,11 +924,11 @@ function mysqli_report(int $flags): bool {}
 /** @refcount 1 */
 function mysqli_query(mysqli $mysql, string $query, int $result_mode = MYSQLI_STORE_RESULT): mysqli_result|bool {}
 
-/** @sensitive-param $password */
 function mysqli_real_connect(
     mysqli $mysql,
     ?string $hostname = null,
     ?string $username = null,
+    #[\SensitiveParameter]
     ?string $password = null,
     ?string $database = null,
     ?int $port = null,

ext/imap/php_imap_arginfo.h

@@ -295,46 +295,40 @@ function oci_close($connection): ?bool {}
 function ocilogoff($connection): ?bool {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  */
-function oci_new_connect(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
+function oci_new_connect(string $username, #[\SensitiveParameter] string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  * @alias oci_new_connect
  * @deprecated
  */
-function ocinlogon(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
+function ocinlogon(string $username, #[\SensitiveParameter] string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  */
-function oci_connect(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
+function oci_connect(string $username, #[\SensitiveParameter] string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  * @alias oci_connect
  * @deprecated
  */
-function ocilogon(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
+function ocilogon(string $username, #[\SensitiveParameter] string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  */
-function oci_pconnect(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
+function oci_pconnect(string $username, #[\SensitiveParameter] string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  * @alias oci_pconnect
  * @deprecated
  */
-function ociplogon(string $username, string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
+function ociplogon(string $username, #[\SensitiveParameter] string $password, ?string $connection_string = null, string $encoding = "", int $session_mode = OCI_DEFAULT) {}
 
 /**
  * @param resource|null $connection_or_statement

ext/ldap/ldap.stub.php

@@ -70,16 +70,14 @@ function odbc_result_all($statement, string $format = ""): int|false {}
 function odbc_free_result($statement): bool {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  */
-function odbc_connect(string $dsn, string $user, string $password, int $cursor_option = SQL_CUR_USE_DRIVER) {}
+function odbc_connect(string $dsn, string $user, #[\SensitiveParameter] string $password, int $cursor_option = SQL_CUR_USE_DRIVER) {}
 
 /**
- * @sensitive-param $password
  * @return resource|false
  */
-function odbc_pconnect(string $dsn, string $user, string $password, int $cursor_option = SQL_CUR_USE_DRIVER) {}
+function odbc_pconnect(string $dsn, string $user, #[\SensitiveParameter] string $password, int $cursor_option = SQL_CUR_USE_DRIVER) {}
 
 /** @param resource $odbc */
 function odbc_close($odbc): void {}