Skip to content

Commit

Permalink
[PHP 8.4] Sodium関数追加分の翻訳 (#178)
Browse files Browse the repository at this point in the history
* Sodium関数追加分の翻訳

* revision修正

* 不要な翻訳の削除
  • Loading branch information
Ippey authored Nov 20, 2024
1 parent c5c503a commit 1bb4baf
Show file tree
Hide file tree
Showing 7 changed files with 599 additions and 1 deletion.
90 changes: 89 additions & 1 deletion reference/sodium/constants.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5671f3fe71c2b96d129896e1f6ed73cf081e5246 Maintainer: mumumu Status: ready -->
<!-- EN-Revision: 01cb7d495c454cea3828d75e181241b6ac3f15ae Maintainer: mumumu Status: ready -->

<appendix xml:id="sodium.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.constants;
Expand Down Expand Up @@ -77,6 +77,94 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis128l-keybytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS128L_KEYBYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP 8.4.0 以降で利用可能です。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis128l-nsecbytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS128L_NSECBYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP 8.4.0 以降で利用可能です。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis128l-npubbytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS128L_NPUBBYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP 8.4.0 以降で利用可能です。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis128l-abytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS128L_ABYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP 8.4.0 以降で利用可能です。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis256-keybytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS256_KEYBYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Available as of PHP 8.4.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis256-nsecbytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS256_NSECBYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP 8.4.0 以降で利用可能です。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis256-npubbytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS256_NPUBBYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP 8.4.0 以降で利用可能です。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aegis256-abytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AEGIS256_ABYTES</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
PHP 8.4.0 以降で利用可能です。
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.sodium-crypto-aead-aes256gcm-keybytes">
<term>
<constant>SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES</constant>
Expand Down
101 changes: 101 additions & 0 deletions reference/sodium/functions/sodium-crypto-aead-aegis128l-decrypt.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 01cb7d495c454cea3828d75e181241b6ac3f15ae Maintainer: Ippey Status: ready -->
<refentry xml:id="function.sodium-crypto-aead-aegis128l-decrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>sodium_crypto_aead_aegis128l_decrypt</refname>
<refpurpose>AEGIS-128L を用いてメッセージを検証し、複合する</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>string</type><type>false</type></type><methodname>sodium_crypto_aead_aegis128l_decrypt</methodname>
<methodparam><type>string</type><parameter>ciphertext</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>
<simpara>
AEGIS-128L を用いてメッセージを検証し、複合します。
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>ciphertext</parameter></term>
<listitem>
<simpara>
<function>sodium_crypto_aead_aegis128l_encrypt</function> が生成したフォーマットでなければなりません。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_data</parameter></term>
<listitem>
<simpara>
追加の認証データ。
これは、
暗号化されたテキストに追加された認証タグを検証するのに用いられますが、
このデータは暗号化されていませんし、
暗号化されたテキストにも保存されていません。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
<simpara>
メッセージごとに一度だけ使われる数値。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<simpara>
暗号化キー(128ビット).
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
成功時にプレーンテキストを返します。
&return.falseforfailure;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>sodium_crypto_aead_aegis128l_encrypt</function></member>
<member><function>sodium_crypto_aead_aegis128l_keygen</function></member>
</simplelist>
</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
-->
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 01cb7d495c454cea3828d75e181241b6ac3f15ae Maintainer: Ippey Status: ready -->
<refentry xml:id="function.sodium-crypto-aead-aegis128l-encrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>sodium_crypto_aead_aegis128l_encrypt</refname>
<refpurpose>AEGIS-128L を使って暗号化し、認証を行う</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sodium_crypto_aead_aegis128l_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>
<simpara>
AEGIS-128L を使って暗号化し、認証を行います。
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem>
<simpara>
暗号化するプレーンテキスト
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>additional_data</parameter></term>
<listitem>
<simpara>
追加の認証データ。
これは、
暗号化されたテキストに追加された認証タグを検証するのに用いられますが、
このデータは暗号化されていませんし、
暗号化されたテキストにも保存されません。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nonce</parameter></term>
<listitem>
<simpara>
メッセージごとに一度だけ使われる数値。
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>key</parameter></term>
<listitem>
<simpara>
暗号化キー(128ビット).
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
暗号化されたテキストと、
認証タグを生のバイナリのバイト列に含めた文字列を返します。
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>sodium_crypto_aead_aegis128l_decrypt</function></member>
<member><function>sodium_crypto_aead_aegis128l_keygen</function></member>
</simplelist>
</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
-->
59 changes: 59 additions & 0 deletions reference/sodium/functions/sodium-crypto-aead-aegis128l-keygen.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 01cb7d495c454cea3828d75e181241b6ac3f15ae Maintainer: Ippey Status: ready -->
<refentry xml:id="function.sodium-crypto-aead-aegis128l-keygen" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>sodium_crypto_aead_aegis128l_keygen</refname>
<refpurpose>Generate a random AEGIS-128L key</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>sodium_crypto_aead_aegis128l_keygen</methodname>
<void/>
</methodsynopsis>
<simpara>
<function>sodium_crypto_aead_aegis128l_encrypt</function>
<function>sodium_crypto_aead_aegis128l_decrypt</function>
で使うランダムな鍵を生成します。
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
128ビット長のランダムな暗号化キーを返します。
</simpara>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>sodium_crypto_aead_aegis128l_decrypt</function></member>
<member><function>sodium_crypto_aead_aegis128l_encrypt</function></member>
</simplelist>
</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
-->
Loading

0 comments on commit 1bb4baf

Please sign in to comment.