You are here

public static function ParagonIE_Sodium_Compat::crypto_auth in Automatic Updates 8

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

Authenticate a message. Uses symmetric-key cryptography.

Algorithm: HMAC-SHA512-256. Which is HMAC-SHA-512 truncated to 256 bits. Not to be confused with HMAC-SHA-512/256 which would use the SHA-512/256 hash function (uses different initial parameters but still truncates to 256 bits to sidestep length-extension attacks).

@psalm-suppress MixedArgument

Parameters

string $message Message to be authenticated:

string $key Symmetric authentication key:

Return value

string Message authentication code

Throws

SodiumException

TypeError

2 calls to ParagonIE_Sodium_Compat::crypto_auth()
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 956

Class

ParagonIE_Sodium_Compat

Code

public static function crypto_auth($message, $key) {

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

  /* Input validation: */
  if (ParagonIE_Sodium_Core_Util::strlen($key) !== self::CRYPTO_AUTH_KEYBYTES) {
    throw new SodiumException('Argument 2 must be CRYPTO_AUTH_KEYBYTES long.');
  }
  if (self::useNewSodiumAPI()) {
    return (string) sodium_crypto_auth($message, $key);
  }
  if (self::use_fallback('crypto_auth')) {
    return (string) call_user_func('\\Sodium\\crypto_auth', $message, $key);
  }
  if (PHP_INT_SIZE === 4) {
    return ParagonIE_Sodium_Crypto32::auth($message, $key);
  }
  return ParagonIE_Sodium_Crypto::auth($message, $key);
}