public static function ParagonIE_Sodium_Compat::crypto_box_open in Automatic Updates 8

Same name and namespace in other branches

1. 7 vendor/paragonie/sodium_compat/src/Compat.php \ParagonIE_Sodium_Compat::crypto_box_open()

Decrypt a message previously encrypted with crypto_box().

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

Parameters

string $ciphertext Encrypted message:

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

string $keypair Your secret key and the sender's public key:

Return value

string The original plaintext message

Throws

SodiumException

TypeError

2 calls to ParagonIE_Sodium_Compat::crypto_box_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 1229

Class

ParagonIE_Sodium_Compat

Code

public static function crypto_box_open($ciphertext, $nonce, $keypair) {

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

  /* Input validation: */
  if (ParagonIE_Sodium_Core_Util::strlen($ciphertext) < self::CRYPTO_BOX_MACBYTES) {
    throw new SodiumException('Argument 1 must be at least CRYPTO_BOX_MACBYTES long.');
  }
  if (ParagonIE_Sodium_Core_Util::strlen($nonce) !== self::CRYPTO_BOX_NONCEBYTES) {
    throw new SodiumException('Argument 2 must be CRYPTO_BOX_NONCEBYTES long.');
  }
  if (ParagonIE_Sodium_Core_Util::strlen($keypair) !== self::CRYPTO_BOX_KEYPAIRBYTES) {
    throw new SodiumException('Argument 3 must be CRYPTO_BOX_KEYPAIRBYTES long.');
  }
  if (self::useNewSodiumAPI()) {

    /**
     * @psalm-suppress InvalidReturnStatement
     * @psalm-suppress FalsableReturnStatement
     */
    return sodium_crypto_box_open($ciphertext, $nonce, $keypair);
  }
  if (self::use_fallback('crypto_box_open')) {
    return call_user_func('\\Sodium\\crypto_box_open', $ciphertext, $nonce, $keypair);
  }
  if (PHP_INT_SIZE === 4) {
    return ParagonIE_Sodium_Crypto32::box_open($ciphertext, $nonce, $keypair);
  }
  return ParagonIE_Sodium_Crypto::box_open($ciphertext, $nonce, $keypair);
}