openssl-decrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: e5ab2937efd9b1d7184993e0fdfa957893f7f827 Maintainer: satoruyoshida Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.openssl-decrypt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>openssl_decrypt</refname>
  <refpurpose>データを復号する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>openssl_decrypt</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>passphrase</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>iv</parameter><initializer>""</initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>tag</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>aad</parameter><initializer>""</initializer></methodparam>
  </methodsynopsis>
  <para>
   未加工の、または base64 エンコードされた文字列を受け取り、
   与えられた暗号化方式とパスフレーズを使って文字列を復号します。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       復号化する、暗号化されたメッセージ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algo</parameter></term>
     <listitem>
      <para>
       暗号化方式。利用可能な暗号化方式のリストについては、
       <function>openssl_get_cipher_methods</function> を使用してください。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
       パスフレーズ。
       期待した長さより短かった場合は、
       黙って<literal>NUL</literal> 文字で埋められます。
       期待した長さより長かった場合は、
       黙って切り詰められます。
      </para>
      <caution>
       <simpara>
        <parameter>passphrase</parameter> は、
        その名前から連想されるような安全な鍵生成機能は内包していません。
        唯一行う操作は、期待する鍵長と異なる場合に <literal>NUL</literal> で
        パディングしたり、切り詰めたりするだけです。
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
    <varlistentry>
      <term><parameter>options</parameter></term>
      <listitem>
       <para>
        <constant>OPENSSL_RAW_DATA</constant>,
        <constant>OPENSSL_ZERO_PADDING</constant>,
        <constant>OPENSSL_DONT_ZERO_PAD_KEY</constant> のいずれか。
       </para>
      </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>iv</parameter></term>
     <listitem>
      <para>
       &null; ではない初期化ベクトル。 IV が期待するものよりも短い場合は、
       <literal>NUL</literal> 文字でパディングされ、警告が発生します。
       パスフレーズが期待するものよりも長い場合は、
       切り捨てられ、警告が発生します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>tag</parameter></term>
     <listitem>
      <para>
       AEAD 暗号モードの認証タグ。
       正しくない場合、認証は失敗し、関数は &false; を返します。
      </para>
      <caution>
       <simpara>
        <parameter>tag</parameter> の長さをこの関数はチェックしません。
        この値の長さは <function>openssl_encrypt</function>
        を呼び出した時に取得できるものと一致させなければならず、それは呼び出し側の責任です。
        一致しない場合でも、与えられた値が適切な
        tag の先頭部分と一致した場合に復号が成功するかもしれません。
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>aad</parameter></term>
     <listitem>
      <para>
       追加の認証済みデータ。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合復号化された文字列、&return.falseforfailure;。
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   <parameter>cipher_algo</parameter> パラメータに未知の暗号アルゴリズムが渡された場合、
   <constant>E_WARNING</constant> レベルのエラーが発生します。
  </para>
  <para>
   <parameter>iv</parameter> パラメータに空の値が渡された場合、
   <constant>E_WARNING</constant> レベルのエラーが発生します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.1.0</entry>
      <entry><parameter>tag</parameter> は、nullable になりました。</entry>
     </row>
     <row>
      <entry>7.1.0</entry>
      <entry><parameter>tag</parameter> および <parameter>aad</parameter> パラメータが追加されました。</entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>openssl_encrypt</function></member>
   </simplelist>
  </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
-->