Support PHP 8.4

.github/workflows/ci.yml

@@ -38,8 +38,7 @@ jobs:
     strategy:
       matrix:
         operating-system: ['ubuntu-latest']
-        php-versions: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3']
-        # php-versions: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
+        php-versions: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
 
     steps:
       - name: Checkout

autoload-phpunit.php

@@ -6,3 +6,6 @@
     require_once (dirname(__FILE__) . '/tests/phpunit-shim.php');
 }
 require_once (dirname(__FILE__) . '/autoload.php');
+if (PHP_VERSION_ID >= 50300) {
+    require_once(dirname(__FILE__) . '/lib/php84compat.php');
+}

autoload.php

@@ -54,6 +54,9 @@ function sodiumCompatAutoloader($class)
     // unless PHP >= 5.3.0
     require_once dirname(__FILE__) . '/lib/namespaced.php';
     require_once dirname(__FILE__) . '/lib/sodium_compat.php';
+    if (!defined('SODIUM_CRYPTO_AEAD_AEGIS128L_KEYBYTES')) {
+        require_once dirname(__FILE__) . '/lib/php84compat_const.php';
+    }
 } else {
     require_once dirname(__FILE__) . '/src/PHP52/SplFixedArray.php';
 }
@@ -71,5 +74,8 @@ function sodiumCompatAutoloader($class)
     // Older versions of {PHP, ext/sodium} will not define these
     require_once(dirname(__FILE__) . '/lib/php72compat.php');
 }
+if (PHP_VERSION_ID < 80400 || !extension_loaded('sodium')) {
+    require_once dirname(__FILE__) . '/lib/php84compat.php';
+}
 require_once(dirname(__FILE__) . '/lib/stream-xchacha20.php');
 require_once(dirname(__FILE__) . '/lib/ristretto255.php');

lib/php72compat.php

@@ -14,14 +14,6 @@
     'BASE64_VARIANT_ORIGINAL_NO_PADDING',
     'BASE64_VARIANT_URLSAFE',
     'BASE64_VARIANT_URLSAFE_NO_PADDING',
-    'CRYPTO_AEAD_AESGIS128L_KEYBYTES',
-    'CRYPTO_AEAD_AESGIS128L_NSECBYTES',
-    'CRYPTO_AEAD_AESGIS128L_NPUBBYTES',
-    'CRYPTO_AEAD_AESGIS128L_ABYTES',
-    'CRYPTO_AEAD_AESGIS256_KEYBYTES',
-    'CRYPTO_AEAD_AESGIS256_NSECBYTES',
-    'CRYPTO_AEAD_AESGIS256_NPUBBYTES',
-    'CRYPTO_AEAD_AESGIS256_ABYTES',
     'CRYPTO_AEAD_AES256GCM_KEYBYTES',
     'CRYPTO_AEAD_AES256GCM_NSECBYTES',
     'CRYPTO_AEAD_AES256GCM_NPUBBYTES',
@@ -184,88 +176,6 @@ function sodium_compare($string1, $string2)
         return ParagonIE_Sodium_Compat::compare($string1, $string2);
     }
 }
-if (!is_callable('sodium_crypto_aead_aegis128l_decrypt')) {
-    /**
-     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis128l_decrypt()
-     * @param string $ciphertext
-     * @param string $additional_data
-     * @param string $nonce
-     * @param string $key
-     * @return string
-     * @throws SodiumException
-     */
-    function sodium_crypto_aead_aegis128l_decrypt($ciphertext, $additional_data, $nonce, $key)
-    {
-        return ParagonIE_Sodium_Compat::crypto_aead_aegis128l_decrypt(
-            $ciphertext,
-            $additional_data,
-            $nonce,
-            $key
-        );
-    }
-}
-if (!is_callable('sodium_crypto_aead_aegis128l_encrypt')) {
-    /**
-     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis128l_encrypt()
-     * @param string $message
-     * @param string $additional_data
-     * @param string $nonce
-     * @param string $key
-     * @return string
-     * @throws SodiumException
-     * @throws TypeError
-     */
-    function sodium_crypto_aead_aegis128l_encrypt($message, $additional_data, $nonce, $key)
-    {
-        return ParagonIE_Sodium_Compat::crypto_aead_aegis128l_encrypt(
-            $message,
-            $additional_data,
-            $nonce,
-            $key
-        );
-    }
-}
-if (!is_callable('sodium_crypto_aead_aegis256_decrypt')) {
-    /**
-     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis256_encrypt()
-     * @param string $ciphertext
-     * @param string $additional_data
-     * @param string $nonce
-     * @param string $key
-     * @return string
-     * @throws SodiumException
-     */
-    function sodium_crypto_aead_aegis256_decrypt($ciphertext, $additional_data, $nonce, $key)
-    {
-        return ParagonIE_Sodium_Compat::crypto_aead_aegis256_decrypt(
-            $ciphertext,
-            $additional_data,
-            $nonce,
-            $key
-        );
-    }
-}
-if (!is_callable('sodium_crypto_aead_aegis256_encrypt')) {
-    /**
-     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis256_encrypt()
-     * @param string $message
-     * @param string $additional_data
-     * @param string $nonce
-     * @param string $key
-     * @return string
-     * @throws SodiumException
-     * @throws TypeError
-     */
-    function sodium_crypto_aead_aegis256_encrypt($message, $additional_data, $nonce, $key)
-    {
-        return ParagonIE_Sodium_Compat::crypto_aead_aegis256_encrypt(
-            $message,
-            $additional_data,
-            $nonce,
-            $key
-        );
-    }
-}
 if (!is_callable('sodium_crypto_aead_aes256gcm_decrypt')) {
     /**
      * @see ParagonIE_Sodium_Compat::crypto_aead_aes256gcm_decrypt()

lib/php84compat.php

@@ -0,0 +1,108 @@
+<?php
+
+require_once dirname(dirname(__FILE__)) . '/autoload.php';
+
+/**
+ * This file will monkey patch the pure-PHP implementation in place of the
+ * PECL functions and constants, but only if they do not already exist.
+ *
+ * Thus, the functions or constants just proxy to the appropriate
+ * ParagonIE_Sodium_Compat method or class constant, respectively.
+ */
+foreach (array(
+    'CRYPTO_AEAD_AESGIS128L_KEYBYTES',
+    'CRYPTO_AEAD_AESGIS128L_NSECBYTES',
+    'CRYPTO_AEAD_AESGIS128L_NPUBBYTES',
+    'CRYPTO_AEAD_AESGIS128L_ABYTES',
+    'CRYPTO_AEAD_AESGIS256_KEYBYTES',
+    'CRYPTO_AEAD_AESGIS256_NSECBYTES',
+    'CRYPTO_AEAD_AESGIS256_NPUBBYTES',
+    'CRYPTO_AEAD_AESGIS256_ABYTES',
+    ) as $constant
+) {
+    if (!defined("SODIUM_$constant") && defined("ParagonIE_Sodium_Compat::$constant")) {
+        define("SODIUM_$constant", constant("ParagonIE_Sodium_Compat::$constant"));
+    }
+}
+if (!is_callable('sodium_crypto_aead_aegis128l_decrypt')) {
+    /**
+     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis128l_decrypt()
+     * @param string $ciphertext
+     * @param string $additional_data
+     * @param string $nonce
+     * @param string $key
+     * @return string
+     * @throws SodiumException
+     */
+    function sodium_crypto_aead_aegis128l_decrypt($ciphertext, $additional_data, $nonce, $key)
+    {
+        return ParagonIE_Sodium_Compat::crypto_aead_aegis128l_decrypt(
+            $ciphertext,
+            $additional_data,
+            $nonce,
+            $key
+        );
+    }
+}
+if (!is_callable('sodium_crypto_aead_aegis128l_encrypt')) {
+    /**
+     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis128l_encrypt()
+     * @param string $message
+     * @param string $additional_data
+     * @param string $nonce
+     * @param string $key
+     * @return string
+     * @throws SodiumException
+     * @throws TypeError
+     */
+    function sodium_crypto_aead_aegis128l_encrypt($message, $additional_data, $nonce, $key)
+    {
+        return ParagonIE_Sodium_Compat::crypto_aead_aegis128l_encrypt(
+            $message,
+            $additional_data,
+            $nonce,
+            $key
+        );
+    }
+}
+if (!is_callable('sodium_crypto_aead_aegis256_decrypt')) {
+    /**
+     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis256_encrypt()
+     * @param string $ciphertext
+     * @param string $additional_data
+     * @param string $nonce
+     * @param string $key
+     * @return string
+     * @throws SodiumException
+     */
+    function sodium_crypto_aead_aegis256_decrypt($ciphertext, $additional_data, $nonce, $key)
+    {
+        return ParagonIE_Sodium_Compat::crypto_aead_aegis256_decrypt(
+            $ciphertext,
+            $additional_data,
+            $nonce,
+            $key
+        );
+    }
+}
+if (!is_callable('sodium_crypto_aead_aegis256_encrypt')) {
+    /**
+     * @see ParagonIE_Sodium_Compat::crypto_aead_aegis256_encrypt()
+     * @param string $message
+     * @param string $additional_data
+     * @param string $nonce
+     * @param string $key
+     * @return string
+     * @throws SodiumException
+     * @throws TypeError
+     */
+    function sodium_crypto_aead_aegis256_encrypt($message, $additional_data, $nonce, $key)
+    {
+        return ParagonIE_Sodium_Compat::crypto_aead_aegis256_encrypt(
+            $message,
+            $additional_data,
+            $nonce,
+            $key
+        );
+    }
+}

lib/php84compat_const.php

@@ -0,0 +1,10 @@
+<?php
+const SODIUM_CRYPTO_AEAD_AEGIS128L_KEYBYTES = 16;
+const SODIUM_CRYPTO_AEAD_AEGIS128L_NSECBYTES = 0;
+const SODIUM_CRYPTO_AEAD_AEGIS128L_NPUBBYTES = 32;
+const SODIUM_CRYPTO_AEAD_AEGIS128L_ABYTES = 32;
+
+const SODIUM_CRYPTO_AEAD_AEGIS256_KEYBYTES = 32;
+const SODIUM_CRYPTO_AEAD_AEGIS256_NSECBYTES = 0;
+const SODIUM_CRYPTO_AEAD_AEGIS256_NPUBBYTES = 32;
+const SODIUM_CRYPTO_AEAD_AEGIS256_ABYTES = 32;

src/Core/AES/Block.php

@@ -18,14 +18,20 @@ class ParagonIE_Sodium_Core_AES_Block extends SplFixedArray
      * @var int
      */
     protected $size;
-
+
+    /**
+     * @param int $size
+     */
     public function __construct($size = 8)
     {
         parent::__construct($size);
         $this->size = $size;
         $this->values = array_fill(0, $size, 0);
     }
 
+    /**
+     * @return self
+     */
     public static function init()
     {
         return new self(8);
@@ -37,6 +43,8 @@ public static function init()
      * @param array<int, int> $array
      * @param bool $save_indexes
      * @return self
+     *
+     * @psalm-suppress MethodSignatureMismatch
      */
     #[ReturnTypeWillChange]
     public static function fromArray($array, $save_indexes = null)
@@ -70,6 +78,8 @@ public static function fromArray($array, $save_indexes = null)
      * @param int|null $offset
      * @param int $value
      * @return void
+     *
+     * @psalm-suppress MethodSignatureMismatch
      * @psalm-suppress MixedArrayOffset
      */
     #[ReturnTypeWillChange]
@@ -90,6 +100,8 @@ public function offsetSet($offset, $value)
      *
      * @param int $offset
      * @return bool
+     *
+     * @psalm-suppress MethodSignatureMismatch
      * @psalm-suppress MixedArrayOffset
      */
     #[ReturnTypeWillChange]
@@ -103,6 +115,8 @@ public function offsetExists($offset)
      *
      * @param int $offset
      * @return void
+     *
+     * @psalm-suppress MethodSignatureMismatch
      * @psalm-suppress MixedArrayOffset
      */
     #[ReturnTypeWillChange]
@@ -116,6 +130,8 @@ public function offsetUnset($offset)
      *
      * @param int $offset
      * @return int
+     *
+     * @psalm-suppress MethodSignatureMismatch
      * @psalm-suppress MixedArrayOffset
      */
     #[ReturnTypeWillChange]

src/Core/Curve25519/Ge/Cached.php

@@ -40,26 +40,38 @@ class ParagonIE_Sodium_Core_Curve25519_Ge_Cached
      * @param ParagonIE_Sodium_Core_Curve25519_Fe|null $T2d
      */
     public function __construct(
-        ParagonIE_Sodium_Core_Curve25519_Fe $YplusX = null,
-        ParagonIE_Sodium_Core_Curve25519_Fe $YminusX = null,
-        ParagonIE_Sodium_Core_Curve25519_Fe $Z = null,
-        ParagonIE_Sodium_Core_Curve25519_Fe $T2d = null
+        $YplusX = null,
+        $YminusX = null,
+        $Z = null,
+        $T2d = null
     ) {
         if ($YplusX === null) {
             $YplusX = new ParagonIE_Sodium_Core_Curve25519_Fe();
         }
+        if (!($YplusX instanceof ParagonIE_Sodium_Core_Curve25519_Fe)) {
+            throw new TypeError('Argument 1 must be an instance of ParagonIE_Sodium_Core_Curve25519_Fe');
+        }
         $this->YplusX = $YplusX;
         if ($YminusX === null) {
             $YminusX = new ParagonIE_Sodium_Core_Curve25519_Fe();
         }
+        if (!($YminusX instanceof ParagonIE_Sodium_Core_Curve25519_Fe)) {
+            throw new TypeError('Argument 2 must be an instance of ParagonIE_Sodium_Core_Curve25519_Fe');
+        }
         $this->YminusX = $YminusX;
         if ($Z === null) {
             $Z = new ParagonIE_Sodium_Core_Curve25519_Fe();
         }
+        if (!($Z instanceof ParagonIE_Sodium_Core_Curve25519_Fe)) {
+            throw new TypeError('Argument 3 must be an instance of ParagonIE_Sodium_Core_Curve25519_Fe');
+        }
         $this->Z = $Z;
         if ($T2d === null) {
             $T2d = new ParagonIE_Sodium_Core_Curve25519_Fe();
         }
+        if (!($T2d instanceof ParagonIE_Sodium_Core_Curve25519_Fe)) {
+            throw new TypeError('Argument 4 must be an instance of ParagonIE_Sodium_Core_Curve25519_Fe');
+        }
         $this->T2d = $T2d;
     }
 }