sodium-crypto-aead-aes256gcm-decrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: d76a7fe17dd2488e47d664a8ab38e161b13ac843 Maintainer: mumumu Status: ready -->
<refentry xml:id="function.sodium-crypto-aead-aes256gcm-decrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>sodium_crypto_aead_aes256gcm_decrypt</refname>
  <refpurpose>AES-256-GCM を用いてメッセージを検証し、復号する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>sodium_crypto_aead_aes256gcm_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>
  <para>
   AES-256-GCM を用いてメッセージを検証し、復号します。
   <function>sodium_crypto_aead_aes256gcm_is_available</function>
   が &true; を返す場合にのみ利用可能です。
  </para>

 </refsect1>

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