<?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 => 'es',
  ),
  'this' => 
  array (
    0 => 'function.sodium-crypto-secretstream-xchacha20poly1305-pull.php',
    1 => 'sodium_crypto_secretstream_xchacha20poly1305_pull',
    2 => 'Desencripta un fragmento de datos de un flujo cifrado',
  ),
  'up' => 
  array (
    0 => 'ref.sodium.php',
    1 => 'Sodium Funciones',
  ),
  'prev' => 
  array (
    0 => 'function.sodium-crypto-secretstream-xchacha20poly1305-keygen.php',
    1 => 'sodium_crypto_secretstream_xchacha20poly1305_keygen',
  ),
  'next' => 
  array (
    0 => 'function.sodium-crypto-secretstream-xchacha20poly1305-push.php',
    1 => 'sodium_crypto_secretstream_xchacha20poly1305_push',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/sodium/functions/sodium-crypto-secretstream-xchacha20poly1305-pull.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.sodium-crypto-secretstream-xchacha20poly1305-pull" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">sodium_crypto_secretstream_xchacha20poly1305_pull</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.2.0, PHP 8)</p><p class="refpurpose"><span class="refname">sodium_crypto_secretstream_xchacha20poly1305_pull</span> &mdash; <span class="dc-title">Desencripta un fragmento de datos de un flujo cifrado</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-pull-description">
  <h3 class="title">Descripción</h3>
  <div class="methodsynopsis dc-description"><span class="methodname"><strong>sodium_crypto_secretstream_xchacha20poly1305_pull</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter reference">&$state</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$ciphertext</code></span>, <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 class="initializer"> = &quot;&quot;</span></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Desencripta un fragmento de datos de un flujo cifrado.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-pull-parameters">
  <h3 class="title">Parámetros</h3>
  <dl>
   
    <dt><code class="parameter">state</code></dt>
    <dd>
     <span class="simpara">
      Ver <span class="function"><a href="function.sodium-crypto-secretstream-xchacha20poly1305-init-pull.php" class="function">sodium_crypto_secretstream_xchacha20poly1305_init_pull()</a></span>
      y <span class="function"><a href="function.sodium-crypto-secretstream-xchacha20poly1305-init-push.php" class="function">sodium_crypto_secretstream_xchacha20poly1305_init_push()</a></span>
     </span>
    </dd>
   
   
    <dt><code class="parameter">ciphertext</code></dt>
    <dd>
     <span class="simpara">
      El fragmento de texto cifrado a desencriptar.
     </span>
    </dd>
   
   
    <dt><code class="parameter">additional_data</code></dt>
    <dd>
     <span class="simpara">
      Opcional de datos adicionales a incluir en la etiqueta de autenticación.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-pull-returnvalues">
  <h3 class="title">Valores devueltos</h3>
  <p class="para">
   Un array con dos valores:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>; el fragmento de texto desencriptado.
     </span>
    </li>
    <li class="listitem">
     <p class="para">
      <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>; Una etiqueta opcional (si se proporciona al enviar). Valores posibles:
      <ul class="simplelist">
       <li>
        <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-message">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE</a></code></strong>:
        la etiqueta más común, que no añade información sobre la naturaleza del mensaje.
       </li>
       <li>
        <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-final">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL</a></code></strong>:
        indica que el mensaje marca el final del flujo, y borra la clave secreta utilizada para cifrar la secuencia anterior.
       </li>
       <li>
        <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-push">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH</a></code></strong>:
        indica que el mensaje marca el final de un conjunto de mensajes, pero no el final del flujo.
        Por ejemplo, una enorme cadena JSON enviada en varios fragmentos puede utilizar esta etiqueta para indicar a la aplicación que
        la cadena está completa y que puede ser decodificada. Pero el flujo mismo no está cerrado, y otros datos pueden seguir.
       </li>
       <li>
        <strong><code><a href="sodium.constants.php#constant.sodium-crypto-secretstream-xchacha20poly1305-tag-rekey">SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY</a></code></strong>:
        "olvidar" la clave utilizada para cifrar este mensaje y los anteriores, y derivar una nueva clave secreta.
       </li>
      </ul>
     </p>
    </li>
   </ul>
  </p>
 </div>


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