<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.sodium.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.sodium-crypto-auth-verify.php',
    1 => 'sodium_crypto_auth_verify',
    2 => 'Verifies that the tag is valid for the message',
  ),
  'up' => 
  array (
    0 => 'ref.sodium.php',
    1 => 'Sodium Functions',
  ),
  'prev' => 
  array (
    0 => 'function.sodium-crypto-auth-keygen.php',
    1 => 'sodium_crypto_auth_keygen',
  ),
  'next' => 
  array (
    0 => 'function.sodium-crypto-box.php',
    1 => 'sodium_crypto_box',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/sodium/functions/sodium-crypto-auth-verify.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.sodium-crypto-auth-verify" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">sodium_crypto_auth_verify</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.2.0, PHP 8)</p><p class="refpurpose"><span class="refname">sodium_crypto_auth_verify</span> &mdash; <span class="dc-title">Verifies that the tag is valid for the message</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.sodium-crypto-auth-verify-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>sodium_crypto_auth_verify</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$mac</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$message</code></span>, <span class="methodparam"><span class="attribute"><a href="class.sensitiveparameter.php">#[\SensitiveParameter]</a> </span><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   Verify the authentication tag is valid for a given message and key.
  </p>
  <p class="simpara">
   Unlike with digital signatures (e.g. <span class="function"><a href="function.sodium-crypto-sign-verify-detached.php" class="function">sodium_crypto_sign_verify_detached()</a></span>),
   any party capable of verifying a message is also capable of authenticating
   their own messages. (Hence, symmetric authentication.)
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.sodium-crypto-auth-verify-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">mac</code></dt>
    <dd>
     <span class="simpara">
      Authentication tag produced by <span class="function"><a href="function.sodium-crypto-auth.php" class="function">sodium_crypto_auth()</a></span>
     </span>
    </dd>
   
   
    <dt><code class="parameter">message</code></dt>
    <dd>
     <span class="simpara">
      Message
     </span>
    </dd>
   
   
    <dt><code class="parameter">key</code></dt>
    <dd>
     <span class="simpara">
      Authentication key
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sodium-crypto-auth-verify-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>



</div><?php manual_footer($setup); ?>