<?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-aead-aegis128l-decrypt.php',
    1 => 'sodium_crypto_aead_aegis128l_decrypt',
    2 => 'Verify then decrypt a message with AEGIS-128L',
  ),
  'up' => 
  array (
    0 => 'ref.sodium.php',
    1 => 'Sodium Functions',
  ),
  'prev' => 
  array (
    0 => 'function.sodium-compare.php',
    1 => 'sodium_compare',
  ),
  'next' => 
  array (
    0 => 'function.sodium-crypto-aead-aegis128l-encrypt.php',
    1 => 'sodium_crypto_aead_aegis128l_encrypt',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/sodium/functions/sodium-crypto-aead-aegis128l-decrypt.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.sodium-crypto-aead-aegis128l-decrypt" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">sodium_crypto_aead_aegis128l_decrypt</h1>
  <p class="verinfo">(PHP 8 &gt;= 8.4.0)</p><p class="refpurpose"><span class="refname">sodium_crypto_aead_aegis128l_decrypt</span> &mdash; <span class="dc-title">Verify then decrypt a message with AEGIS-128L</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.sodium-crypto-aead-aegis128l-decrypt-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>sodium_crypto_aead_aegis128l_decrypt</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$ciphertext</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$additional_data</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$nonce</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<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><br>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Verify then decrypt a message with AEGIS-128L.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.sodium-crypto-aead-aegis128l-decrypt-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">ciphertext</code></dt>
    <dd>
     <span class="simpara">
      Must be in the format provided by <span class="function"><a href="function.sodium-crypto-aead-aegis128l-encrypt.php" class="function">sodium_crypto_aead_aegis128l_encrypt()</a></span>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">additional_data</code></dt>
    <dd>
     <span class="simpara">
      Additional, authenticated data. This is used in the verification of the authentication tag
      appended to the ciphertext, but it is not encrypted or stored in the ciphertext.
     </span>
    </dd>
   
   
    <dt><code class="parameter">nonce</code></dt>
    <dd>
     <span class="simpara">
      A number that must be only used once, per message.
     </span>
    </dd>
   
   
    <dt><code class="parameter">key</code></dt>
    <dd>
     <span class="simpara">
      Encryption key (128-bit).
     </span>
    </dd>
   
  </dl>
 </div>


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


 <div class="refsect1 seealso" id="refsect1-function.sodium-crypto-aead-aegis128l-decrypt-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.sodium-crypto-aead-aegis128l-encrypt.php" class="function" rel="rdfs-seeAlso">sodium_crypto_aead_aegis128l_encrypt()</a> - Encrypt then authenticate a message with AEGIS-128L</span></li>
   <li><span class="function"><a href="function.sodium-crypto-aead-aegis128l-keygen.php" class="function" rel="rdfs-seeAlso">sodium_crypto_aead_aegis128l_keygen()</a> - Generate a random AEGIS-128L key</span></li>
  </ul>
 </div>

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