openssl-open.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 730fd5c3dd1523bb9330762084ce016d4e58e946 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.openssl-open" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_open</refname>
  <refpurpose>シール(暗号化)されたデータをオープン(復号)する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_open</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter role="reference">output</parameter></methodparam>
   <methodparam><type>string</type><parameter>encrypted_key</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>OpenSSLAsymmetricKey</type><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>private_key</parameter></methodparam>
   <methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>iv</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_open</function> は、 <parameter>private_key</parameter> を使用して
   <parameter>encrypted_key</parameter> から復号されたエンベロープキーによって
   <parameter>data</parameter> をオープン(復号)します。
   復号は <parameter>cipher_algo</parameter> と <parameter>iv</parameter> を使用して行なわれます。
   IV は暗号方式が要求する場合にのみ必要です。復号されたデータは <parameter>output</parameter> に
   格納されます。エンベロープキーは通常、秘密鍵に関連付けられた公開鍵を用いてデータがシール(暗号化)
   されたときに生成されます。
   詳細は <function>openssl_seal</function> を参照ください。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       シール(暗号化)されたデータ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>output</parameter></term>
     <listitem>
      <para>
       成功した場合、オープンしたデータをこのパラメータに格納して返します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encrypted_key</parameter></term>
     <listitem>
      <para>
        <parameter>private_key</parameter> を用いて復号できる暗号化された対称鍵。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>private_key</parameter></term>
     <listitem>
      <para>
        <parameter>encrypted_key</parameter>の復号に用いられる秘密鍵。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algo</parameter></term>
     <listitem>
      <para>
       <parameter>data</parameter>の復号に使用される暗号化方式。
       <caution>
        <simpara>
         PHP 8.0 より前のデフォルト値 (<literal>'RC4'</literal>) は安全ではありません。
         明示的にセキュアな暗号化方式を指定することを強く推奨します。
        </simpara>
       </caution>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>iv</parameter></term>
     <listitem>
      <para>
       <parameter>data</parameter>の復号に用いられる初期化ベクトル。暗号方式が IV を要求する場合に必要です。
       これは <parameter>cipher_algo</parameter> で <function>openssl_cipher_iv_length</function>
       を呼び出すことで確認できます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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.0.0</entry>
      <entry>
       <parameter>private_key</parameter> は、
       <classname>OpenSSLAsymmetricKey</classname> または
       <classname>OpenSSLCertificate</classname> クラスのインスタンスを受け入れるようになりました。
       これより前のバージョンでは、
       <literal>OpenSSL key</literal> または
       <literal>OpenSSL X.509 CSR</literal> 型のリソースを受け入れていました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>cipher_algo</parameter> は、
       オプションではなくなりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>openssl_open</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

// $sealed, $env_key および $iv に暗号化されたデータおよびエンベロープキーと
// IV が含まれていると仮定。すべてシール元(暗号化側)から与えられる。

// private_key.pem に置かれたファイルから秘密鍵を取得する
$pkey = openssl_get_privatekey("file://private_key.pem");

// データを復号化し、$open に保存
if (openssl_open($sealed, $open, $env_key, $pkey, 'AES256', $iv)) {
    echo "Here is the opened data: ", $open;
} else {
    echo "Failed to open data";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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