sodium-crypto-secretstream-xchacha20poly1305-pull.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14e3e35ca0c82b3b5fb3fd71b9dd70e9eb250ab1 Maintainer: lex Status: ready -->
<!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.sodium-crypto-secretstream-xchacha20poly1305-pull">
 <refnamediv>
  <refname>sodium_crypto_secretstream_xchacha20poly1305_pull</refname>
  <refpurpose>Расшифровывает часть данных из зашифрованного потока</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>sodium_crypto_secretstream_xchacha20poly1305_pull</methodname>
   <methodparam><type>string</type><parameter role="reference">state</parameter></methodparam>
   <methodparam><type>string</type><parameter>ciphertext</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>additional_data</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   Расшифровывает часть данных из зашифрованного потока.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>state</parameter></term>
    <listitem>
     <para>
      Смотрите <function>sodium_crypto_secretstream_xchacha20poly1305_init_pull</function>
      и <function>sodium_crypto_secretstream_xchacha20poly1305_init_push</function>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>ciphertext</parameter></term>
    <listitem>
     <para>
      Фрагмент зашифрованного текста, который нужно расшифровать.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>additional_data</parameter></term>
    <listitem>
     <para>
      Необязательные дополнительные данные для включения в тег аутентификации.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

<refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Массив с двумя значениями:
   <itemizedlist>
    <listitem>
     <para>
      Строка (<type>string</type>); Расшифрованный фрагмент
     </para>
    </listitem>
    <listitem>
     <para>
      Целое число (<type>int</type>); Необязательный тег (если предоставляется во время отправки). Возможные значения:
      <simplelist>
       <member>
        <constant>SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE</constant>:
        самый распространённый тег, который не добавляет никакой информации о характере сообщения.
       </member>
       <member>
        <constant>SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL</constant>:
        указывает, что сообщение отмечает конец потока, и стирает секретный ключ, использованный для шифрования предыдущей последовательности.
       </member>
       <member>
        <constant>SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH</constant>:
        указывает, что сообщение отмечает конец набора сообщений, но не конец потока.
       Например, огромная строка JSON, отправленная в виде нескольких фрагментов, может использовать этот тег,
       чтобы указать приложению, что строка завершена и что её можно декодировать.
       Но сам поток не закрывается и могут последовать дополнительные данные.
       </member>
       <member>
        <constant>SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY</constant>:
        "забывает" ключ, использованный для шифрования этого и предыдущих сообщений и получает новый секретный ключ.
       </member>
      </simplelist>
     </para>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>


</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->