You are here

public static function ParagonIE_Sodium_Compat::crypto_stream_xor in Automatic Updates 7

Same name and namespace in other branches
  1. 8 vendor/paragonie/sodium_compat/src/Compat.php \ParagonIE_Sodium_Compat::crypto_stream_xor()

DANGER! UNAUTHENTICATED ENCRYPTION!

Unless you are following expert advice, do not used this feature.

Algorithm: XSalsa20

This DOES NOT provide ciphertext integrity.

@psalm-suppress MixedArgument

Parameters

string $message Plaintext message:

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

string $key Encryption key:

Return value

string Encrypted text which is vulnerable to chosen- ciphertext attacks unless you implement some other mitigation to the ciphertext (i.e. Encrypt then MAC)

Throws

SodiumException

TypeError

2 calls to ParagonIE_Sodium_Compat::crypto_stream_xor()
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 3014

Class

ParagonIE_Sodium_Compat

Code

public static function crypto_stream_xor($message, $nonce, $key) {

  /* Type checks: */
  ParagonIE_Sodium_Core_Util::declareScalarType($message, '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_STREAM_NONCEBYTES) {
    throw new SodiumException('Argument 2 must be CRYPTO_SECRETBOX_NONCEBYTES long.');
  }
  if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_STREAM_KEYBYTES) {
    throw new SodiumException('Argument 3 must be CRYPTO_SECRETBOX_KEYBYTES long.');
  }
  if (self::useNewSodiumAPI()) {
    return sodium_crypto_stream_xor($message, $nonce, $key);
  }
  if (self::use_fallback('crypto_stream_xor')) {
    return (string) call_user_func('\\Sodium\\crypto_stream_xor', $message, $nonce, $key);
  }
  if (PHP_INT_SIZE === 4) {
    return ParagonIE_Sodium_Core32_XSalsa20::xsalsa20_xor($message, $nonce, $key);
  }
  return ParagonIE_Sodium_Core_XSalsa20::xsalsa20_xor($message, $nonce, $key);
}