sodium: Use opaque objects for SHAKE state (#24351)

* sodium: Use opaque objects for SHAKE state

* sodium: Make `sodium_crypto_xof_*shake*_update()` void

* sodium: Fix error message phrasing when requesting invalid lengths from SHAKE

* NEWS

Author: TimWolla

NEWS

@@ -73,6 +73,10 @@ PHP                                                                        NEWS
   . Fixed infinite loop in sapi_header_op() for headers of 4 GiB or more.
     (Martin Mirchev)
 
+- Sodium:
+  . Pass sodium_crypto_xof_*() state via objects instead of by-ref strings.
+    (timwolla)
+
 - SPL:
   . Fixed bug GH-24264 (Unwind/GracefulExit discarded in spl_iterators.c).
     (Lazizbek Ergashev)

ext/sodium/libsodium.c

@@ -936,35 +936,67 @@ function sodium_ip2bin(string $ip): string {}
 
 function sodium_crypto_xof_shake128(int $length, string $message): string {}
 
-function sodium_crypto_xof_shake128_init(?int $domain = null): string {}
+function sodium_crypto_xof_shake128_init(?int $domain = null): SodiumCryptoXofShake128State {}
 
-function sodium_crypto_xof_shake128_update(string &$state, string $message): true {}
+function sodium_crypto_xof_shake128_update(SodiumCryptoXofShake128State $state, string $message): void {}
 
-function sodium_crypto_xof_shake128_squeeze(string &$state, int $length): string {}
+function sodium_crypto_xof_shake128_squeeze(SodiumCryptoXofShake128State $state, int $length): string {}
+
+/**
+ * @strict-properties
+ * @not-serializable
+ */
+final class SodiumCryptoXofShake128State {
+
+}
 
 function sodium_crypto_xof_shake256(int $length, string $message): string {}
 
-function sodium_crypto_xof_shake256_init(?int $domain = null): string {}
+function sodium_crypto_xof_shake256_init(?int $domain = null): SodiumCryptoXofShake256State {}
 
-function sodium_crypto_xof_shake256_update(string &$state, string $message): true {}
+function sodium_crypto_xof_shake256_update(SodiumCryptoXofShake256State $state, string $message): void {}
+
+function sodium_crypto_xof_shake256_squeeze(SodiumCryptoXofShake256State $state, int $length): string {}
+
+/**
+ * @strict-properties
+ * @not-serializable
+ */
+final class SodiumCryptoXofShake256State {
 
-function sodium_crypto_xof_shake256_squeeze(string &$state, int $length): string {}
+}
 
 function sodium_crypto_xof_turboshake128(int $length, string $message): string {}
 
-function sodium_crypto_xof_turboshake128_init(?int $domain = null): string {}
+function sodium_crypto_xof_turboshake128_init(?int $domain = null): SodiumCryptoXofTurboshake128State {}
 
-function sodium_crypto_xof_turboshake128_update(string &$state, string $message): true {}
+function sodium_crypto_xof_turboshake128_update(SodiumCryptoXofTurboshake128State $state, string $message): void {}
 
-function sodium_crypto_xof_turboshake128_squeeze(string &$state, int $length): string {}
+function sodium_crypto_xof_turboshake128_squeeze(SodiumCryptoXofTurboshake128State $state, int $length): string {}
+
+/**
+ * @strict-properties
+ * @not-serializable
+ */
+final class SodiumCryptoXofTurboshake128State {
+
+}
 
 function sodium_crypto_xof_turboshake256(int $length, string $message): string {}
 
-function sodium_crypto_xof_turboshake256_init(?int $domain = null): string {}
+function sodium_crypto_xof_turboshake256_init(?int $domain = null): SodiumCryptoXofTurboshake256State {}
 
-function sodium_crypto_xof_turboshake256_update(string &$state, string $message): true {}
+function sodium_crypto_xof_turboshake256_update(SodiumCryptoXofTurboshake256State $state, string $message): void {}
+
+function sodium_crypto_xof_turboshake256_squeeze(SodiumCryptoXofTurboshake256State $state, int $length): string {}
+
+/**
+ * @strict-properties
+ * @not-serializable
+ */
+final class SodiumCryptoXofTurboshake256State {
 
-function sodium_crypto_xof_turboshake256_squeeze(string &$state, int $length): string {}
+}
 #endif
 
 #ifdef crypto_kem_PUBLICKEYBYTES

ext/sodium/libsodium.stub.php

@@ -78,13 +78,6 @@ try {
     echo $e->getMessage() . "\n";
 }
 
-/* Error: bad state */
-try {
-    $bad = "not_a_state";
-    sodium_crypto_xof_shake128_update($bad, "test");
-} catch (SodiumException $e) {
-    echo $e->getMessage() . "\n";
-}
 ?>
 --EXPECT--
 string(64) "7f9c2ba4e88f827d616045507605853ed73b8093f6efbc88eb1a6eacfa66ef26"
@@ -97,8 +90,7 @@ string(64) "5881092dd818bf5cf8a3ddb793fbcba74097d5c526a6d35f97b83351940f2cc8"
 string(64) "5881092dd818bf5cf8a3ddb793fbcba74097d5c526a6d35f97b83351940f2cc8"
 string(64) "f3a3a89c329e644a7d2351744d9a28c953698b64102e912085ce1f6d79fa311e"
 bool(true)
-sodium_crypto_xof_shake128(): Argument #1 ($length) must be a positive integer
-sodium_crypto_xof_shake128(): Argument #1 ($length) must be a positive integer
+sodium_crypto_xof_shake128(): Argument #1 ($length) must be greater than 0
+sodium_crypto_xof_shake128(): Argument #1 ($length) must be greater than 0
 sodium_crypto_xof_shake128_init(): Argument #1 ($domain) must be between 0x01 and 0x7f
 sodium_crypto_xof_shake128_init(): Argument #1 ($domain) must be between 0x01 and 0x7f
-sodium_crypto_xof_shake128_update(): Argument #1 ($state) must have a correct state length

ext/sodium/libsodium_arginfo.h

@@ -49,14 +49,6 @@ try {
     echo $e->getMessage() . "\n";
 }
 
-/* Error: bad state */
-try {
-    $bad = "not_a_state";
-    sodium_crypto_xof_shake256_update($bad, "test");
-} catch (SodiumException $e) {
-    echo $e->getMessage() . "\n";
-}
-
 /* Error: squeeze bad length */
 try {
     $state = sodium_crypto_xof_shake256_init();
@@ -75,6 +67,5 @@ bool(true)
 string(64) "483366601360a8771c6863080cc4114d8db44530f8f1e1ee4f94ea37e78b5739"
 string(64) "483366601360a8771c6863080cc4114d8db44530f8f1e1ee4f94ea37e78b5739"
 string(64) "1259d63c872d50fee4500685419f489966971c0a77e2058fab0e48dfb12d24bc"
-sodium_crypto_xof_shake256(): Argument #1 ($length) must be a positive integer
-sodium_crypto_xof_shake256_update(): Argument #1 ($state) must have a correct state length
-sodium_crypto_xof_shake256_squeeze(): Argument #2 ($length) must be a positive integer
+sodium_crypto_xof_shake256(): Argument #1 ($length) must be greater than 0
+sodium_crypto_xof_shake256_squeeze(): Argument #2 ($length) must be greater than 0

ext/sodium/tests/crypto_xof_shake128.phpt

@@ -72,14 +72,6 @@ try {
     echo $e->getMessage() . "\n";
 }
 
-/* TurboSHAKE256 error: bad state */
-try {
-    $bad = "not_a_state";
-    sodium_crypto_xof_turboshake256_update($bad, "test");
-} catch (SodiumException $e) {
-    echo $e->getMessage() . "\n";
-}
-
 /* TurboSHAKE128 error: domain out of range */
 try {
     sodium_crypto_xof_turboshake128_init(0);
@@ -106,7 +98,6 @@ string(64) "0137a7e8cca0b99e9bdd557a7caac1f21d65bc2a2ccbde1e1f8c702352a2bf30"
 int(16)
 int(64)
 bool(true)
-sodium_crypto_xof_turboshake128(): Argument #1 ($length) must be a positive integer
-sodium_crypto_xof_turboshake256_update(): Argument #1 ($state) must have a correct state length
+sodium_crypto_xof_turboshake128(): Argument #1 ($length) must be greater than 0
 sodium_crypto_xof_turboshake128_init(): Argument #1 ($domain) must be between 0x01 and 0x7f
 sodium_crypto_xof_turboshake256_init(): Argument #1 ($domain) must be between 0x01 and 0x7f