openssl-seal.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 110ac43250fdb3531fe26d4d29292e33df7855e8 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.openssl-seal" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_seal</refname>
  <refpurpose>データをシール(暗号化)する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>openssl_seal</methodname>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">sealed_data</parameter></methodparam>
   <methodparam><type>array</type><parameter role="reference">encrypted_keys</parameter></methodparam>
   <methodparam><type>array</type><parameter>public_key</parameter></methodparam>
   <methodparam><type>string</type><parameter>cipher_algo</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">iv</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_seal</function> は、指定された <parameter>cipher_algo</parameter> を使用して
   ランダムに生成された秘密鍵で <parameter>data</parameter> をシール(暗号化)します。
   その鍵は続いて <parameter>public_key</parameter> 配列内の各公開鍵で暗号化され、
   それぞれ暗号化されたエンベロープキーは <parameter>encrypted_keys</parameter> パラメータで返されます。
   これによって、(公開鍵が利用可能なら) 複数の受信者にシールされた
   データを送信できます。各受信者は、シールされたデータと受信者の公開鍵で暗号化されたエンベロープキー
   の両方を受け取らなければいけません。
   生成された IV (初期化ベクトル) は <parameter>iv</parameter> パラメータで返されます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       シールするデータ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sealed_data</parameter></term>
     <listitem>
      <para>
       シール済みのデータ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>encrypted_keys</parameter></term>
     <listitem>
      <para>
       暗号化したキーの配列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>public_key</parameter></term>
     <listitem>
      <para>
       公開鍵を含んだ <classname>OpenSSLAsymmetricKey</classname> 
       クラスのインスタンスの配列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algo</parameter></term>
     <listitem>
      <para>
       暗号化方式
       <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>
      <caution>
       <simpara>
        初期化ベクトルは明示的に設定できません。設定された値はランダムに生成された値で上書きされます。
       </simpara>
      </caution>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功時にシール(暗号化)されたデータの長さ、エラー時に &false;
   を返します。成功時には、暗号化されたデータが
   <parameter>sealed_data</parameter> に、エンベロープキーが
   <parameter>encrypted_keys</parameter> に返されます。
  </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>public_key</parameter> は、
       <classname>OpenSSLAsymmetricKey</classname> クラスのインスタンスの配列を受け入れるようになりました。
       これより前のバージョンでは、
       <literal>OpenSSL key</literal> 型のリソースの配列を受け入れていました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>cipher_algo</parameter> は、オプションではなくなりました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>iv</parameter> は、nullable になりました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>openssl_seal</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// $data には、暗号化されるデータが含まれていると仮定
$data = "test";

// 公開鍵を取得する
$pk1 = openssl_get_publickey("file://cert1.pem");
$pk2 = openssl_get_publickey("file://cert2.pem");

// メッセージを暗号化。$pk1 および $pk2 の所有者のみが、$sealed を
// それぞれ $ekeys[0] および $ekeys[1] で復号することが可能
if (openssl_seal($data, $sealed, $ekeys, array($pk1, $pk2), 'AES256', $iv) > 0) {
    // $sealed と $iv の値を格納し、後で openssl_open で使用することもできます。
    echo "success\n";
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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