Update to English sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.xml

This commit is contained in:
Mikhail Alferov
2024-05-23 09:17:29 +03:00
committed by GitHub
parent 22424237fd
commit da4c2583cf

View File

@ -1,26 +1,26 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 14e3e35ca0c82b3b5fb3fd71b9dd70e9eb250ab1 Maintainer: lex Status: ready --> <!-- EN-Revision: d76a7fe17dd2488e47d664a8ab38e161b13ac843 Maintainer: lex Status: ready -->
<!-- Reviewed: no --> <!-- Reviewed: no -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.sodium-crypto-aead-xchacha20poly1305-ietf-encrypt"> <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> <refnamediv>
<refname>sodium_crypto_aead_xchacha20poly1305_ietf_encrypt</refname> <refname>sodium_crypto_aead_xchacha20poly1305_ietf_encrypt</refname>
<refpurpose>(Предпочтительно) Шифрует, а затем проверяет подлинность с помощью XChaCha20-Poly1305</refpurpose> <refpurpose>(Предпочтительно) Шифрует, а затем проверяет подлинность алгоритмом XChaCha20-Poly1305</refpurpose>
</refnamediv> </refnamediv>
<refsect1 role="description"> <refsect1 role="description">
&reftitle.description; &reftitle.description;
<methodsynopsis> <methodsynopsis>
<type>string</type><methodname>sodium_crypto_aead_xchacha20poly1305_ietf_encrypt</methodname> <type>string</type><methodname>sodium_crypto_aead_xchacha20poly1305_ietf_encrypt</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam> <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>additional_data</parameter></methodparam>
<methodparam><type>string</type><parameter>nonce</parameter></methodparam> <methodparam><type>string</type><parameter>nonce</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>key</parameter></methodparam>
</methodsynopsis> </methodsynopsis>
<para> <para>
Шифрует, а затем проверяет подлинность с помощью XChaCha20-Poly1305(вариант eXtended-nonce). Функция шифрует, а затем проверяет подлинность алгоритмом XChaCha20-Poly1305(вариант eXtended-nonce).
</para> </para>
<para> <para>
Как правило, XChaCha20-Poly1305 - лучший из имеющихся режимов AEAD для использования. Как правило, алгоритм XChaCha20-Poly1305 лучший из имеющихся режимов AEAD.
</para> </para>
</refsect1> </refsect1>
@ -40,8 +40,9 @@
<term><parameter>additional_data</parameter></term> <term><parameter>additional_data</parameter></term>
<listitem> <listitem>
<para> <para>
Дополнительные проверенные данные. Это используется при проверке тега подлинности, добавленного к зашифрованному тексту, Дополнительные проверенные данные. Функция использует значение при проверке тега
но он не шифруется и не сохраняется в зашифрованном тексте. подлинности, который добавили к зашифрованному тексту,
но не шифрует и не сохраняет в зашифрованном тексте.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -50,7 +51,7 @@
<listitem> <listitem>
<para> <para>
Номер, который необходимо использовать только один раз для каждого сообщения. Длина 24 байта. Номер, который необходимо использовать только один раз для каждого сообщения. Длина 24 байта.
Это достаточно большая граница для случайной генерации (например, <function>random_bytes</function>). Это достаточно большая граница, чтобы её случайным образом (то есть функцией <function>random_bytes</function>).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -58,7 +59,7 @@
<term><parameter>key</parameter></term> <term><parameter>key</parameter></term>
<listitem> <listitem>
<para> <para>
Ключ шифрования (256 бит). Ключ шифрования (256 битов).
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -68,11 +69,10 @@
<refsect1 role="returnvalues"> <refsect1 role="returnvalues">
&reftitle.returnvalues; &reftitle.returnvalues;
<para> <para>
В случае успешного выполнения возвращает зашифрованный текст и тег&return.falseforfailure;. В случае успешного выполнения функция возвращает зашифрованный текст и тег&return.falseforfailure;.
</para> </para>
</refsect1> </refsect1>
</refentry> </refentry>
<!-- Keep this comment at the end of the file <!-- Keep this comment at the end of the file
Local variables: Local variables: