<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.sodium-crypto-secretstream-xchacha20poly1305-pull.php',
    1 => 'sodium_crypto_secretstream_xchacha20poly1305_pull',
    2 => 'Descriptografa um peda&ccedil;o de dados de um fluxo criptografado',
  ),
  'up' => 
  array (
    0 => 'ref.sodium.php',
    1 => 'Fun&ccedil;&otilde;es da Sodium',
  ),
  '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' => 'pt_BR',
    '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">Descriptografa um pedaço de dados de um fluxo criptografado</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-pull-description">
  <h3 class="title">Descrição</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">
   Descriptografa um bloco de dados de um fluxo criptografado.
  </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">
      Veja <span class="function"><a href="function.sodium-crypto-secretstream-xchacha20poly1305-init-pull.php" class="function">sodium_crypto_secretstream_xchacha20poly1305_init_pull()</a></span>
      e <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">
      O pedaço de texto cifrado a ser descriptografado.
     </span>
    </dd>
   
   
    <dt><code class="parameter">additional_data</code></dt>
    <dd>
     <span class="simpara">
      Dados adicionais opcionais para incluir na tag de autenticação.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.sodium-crypto-secretstream-xchacha20poly1305-pull-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Um array com dois 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>; O pedaço decifrado
     </span>
    </li>
    <li class="listitem">
     <p class="para">
      <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>; Uma tag opcional (se fornecida durante o push). Valores possíveis:
      <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>:
        a tag mais comum, que não adiciona nenhuma informação sobre a natureza da mensagem.
       </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 a mensagem marca o fim do fluxo e apaga a chave secreta usada para criptografar a sequência 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 a mensagem marca o fim de um conjunto de mensagens, mas não o fim do fluxo.
        Por exemplo, uma string JSON enorme enviada em vários blocos pode usar esta tag para indicar ao aplicativo que a
        string está completa e pode ser decodificada. Mas o fluxo em si não está fechado, e mais dados podem ser enviados.
       </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>:
        "esquece" a chave usada para criptografar esta mensagem e as anteriores, e deriva uma nova chave secreta.
       </li>
      </ul>
     </p>
    </li>
   </ul>
  </p>
 </div>


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