mirror of
https://github.com/php/doc-ru.git
synced 2025-08-16 18:22:04 +00:00
97 lines
3.7 KiB
XML
97 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- EN-Revision: d76a7fe17dd2488e47d664a8ab38e161b13ac843 Maintainer: lex Status: ready -->
|
||
<!-- Reviewed: no -->
|
||
<refentry xml:id="function.sodium-crypto-aead-xchacha20poly1305-ietf-encrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>sodium_crypto_aead_xchacha20poly1305_ietf_encrypt</refname>
|
||
<refpurpose>(Предпочтительно) Шифрует, а затем проверяет подлинность алгоритмом XChaCha20-Poly1305</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<methodsynopsis>
|
||
<type>string</type><methodname>sodium_crypto_aead_xchacha20poly1305_ietf_encrypt</methodname>
|
||
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>message</parameter></methodparam>
|
||
<methodparam><type>string</type><parameter>additional_data</parameter></methodparam>
|
||
<methodparam><type>string</type><parameter>nonce</parameter></methodparam>
|
||
<methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Функция шифрует, а затем проверяет подлинность алгоритмом XChaCha20-Poly1305(вариант eXtended-nonce).
|
||
</para>
|
||
<para>
|
||
Как правило, алгоритм XChaCha20-Poly1305 — лучший из имеющихся режимов AEAD.
|
||
</para>
|
||
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>message</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Текстовое сообщение, которое нужно зашифровать.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>additional_data</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Дополнительные проверенные данные. Функция использует значение при проверке тега
|
||
подлинности, который добавили к зашифрованному тексту,
|
||
но не шифрует и не сохраняет в зашифрованном тексте.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>nonce</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Номер, который необходимо использовать только один раз для каждого сообщения. Длина 24 байта.
|
||
Это достаточно большая граница, чтобы её случайным образом (то есть функцией <function>random_bytes</function>).
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>key</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Ключ шифрования (256 битов).
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
В случае успешного выполнения функция возвращает зашифрованный текст и тег&return.falseforfailure;.
|
||
</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
|
||
-->
|