public static function ParagonIE_Sodium_Compat::crypto_secretbox_open in Automatic Updates 7

Same name and namespace in other branches

1. 8 vendor/paragonie/sodium_compat/src/Compat.php \ParagonIE_Sodium_Compat::crypto_secretbox_open()

Decrypts a message previously encrypted with crypto_secretbox().

@psalm-suppress MixedArgument @psalm-suppress MixedInferredReturnType @psalm-suppress MixedReturnStatement

Parameters

string $ciphertext Ciphertext with Poly1305 MAC:

string $nonce A Number to be used Once; must be 24 bytes:

string $key Symmetric encryption key:

Return value

string Original plaintext message

Throws

SodiumException

TypeError

2 calls to ParagonIE_Sodium_Compat::crypto_secretbox_open()

php72compat.php in vendor/paragonie/sodium_compat/lib/php72compat.php

sodium_compat.php in vendor/paragonie/sodium_compat/lib/sodium_compat.php

File

vendor/paragonie/sodium_compat/src/Compat.php, line 2296

Class

ParagonIE_Sodium_Compat

Code

public static function crypto_secretbox_open($ciphertext, $nonce, $key) {

  /* Type checks: */
  ParagonIE_Sodium_Core_Util::declareScalarType($ciphertext, 'string', 1);
  ParagonIE_Sodium_Core_Util::declareScalarType($nonce, 'string', 2);
  ParagonIE_Sodium_Core_Util::declareScalarType($key, 'string', 3);

  /* Input validation: */
  if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_SECRETBOX_NONCEBYTES) {
    throw new SodiumException('Argument 2 must be CRYPTO_SECRETBOX_NONCEBYTES long.');
  }
  if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_SECRETBOX_KEYBYTES) {
    throw new SodiumException('Argument 3 must be CRYPTO_SECRETBOX_KEYBYTES long.');
  }
  if (self::useNewSodiumAPI()) {

    /**
     * @psalm-suppress InvalidReturnStatement
     * @psalm-suppress FalsableReturnStatement
     */
    return sodium_crypto_secretbox_open($ciphertext, $nonce, $key);
  }
  if (self::use_fallback('crypto_secretbox_open')) {
    return call_user_func('\\Sodium\\crypto_secretbox_open', $ciphertext, $nonce, $key);
  }
  if (PHP_INT_SIZE === 4) {
    return ParagonIE_Sodium_Crypto32::secretbox_open($ciphertext, $nonce, $key);
  }
  return ParagonIE_Sodium_Crypto::secretbox_open($ciphertext, $nonce, $key);
}