Move PHP 8.4-compat to its own file

paragonie · Apr 17, 2024 · 249d00b · 249d00b
1 parent ef72a25
commit 249d00b
Show file tree

Hide file tree

Showing 5 changed files with 125 additions and 92 deletions.
diff --git a/autoload.php b/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');
diff --git a/lib/php72compat.php b/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()

diff --git a/lib/php84compat.php b/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
+        );
+    }
+}
diff --git a/lib/php84compat_const.php b/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;
diff --git a/tests/phpunit-shim.php b/tests/phpunit-shim.php
@@ -1,7 +1,6 @@
 <?php
 use PHPUnit\Framework\TestCase;
 
-require_once dirname(__DIR__) . '/lib/php72compat.php';
 if (!class_exists('PHPUnit_Framework_TestCase')) {
     class PHPUnit_Framework_TestCase extends TestCase {}
-}
+}