openssl-pkcs7-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 0773339dce767078f1ee0e55cc1c0428e02ae0ad Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi -->
<refentry xml:id="function.openssl-pkcs7-encrypt" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_pkcs7_encrypt</refname>
  <refpurpose>S/MIME メッセージを暗号化する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_pkcs7_encrypt</methodname>
   <methodparam><type>string</type><parameter>input_filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>output_filename</parameter></methodparam>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>array</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>null</type></type><parameter>headers</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>cipher_algo</parameter><initializer><constant>OPENSSL_CIPHER_AES_128_CBC</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkcs7_encrypt</function> は、
   <parameter>input_filename</parameter> という名前のファイルの内容を
   RC2 40 ビット暗号により暗号化します。この内容は、
   <parameter>certificate</parameter>
   で指定した意図する受信者によってのみ読むことが可能です。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>input_filename</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>output_filename</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>certificate</parameter></term>
     <listitem>
      <para>
       X.509 証明書または X.509 証明書の配列。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>headers</parameter></term>
     <listitem>
      <para>
       <parameter>headers</parameter> は、
       暗号化された後にデータの前に付加されるヘッダの配列です。
      </para>
      <para>
       <parameter>headers</parameter>
       はヘッダ名をキーとする連想配列または添字配列であり、
       各要素には、各ヘッダ行が一行ずつ含まれています。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> は
       オプションとして使用可能であり、エンコード処理を変更するために指定します。
       <link linkend="openssl.pkcs7.flags">PKCS7 定数</link> を参照ください。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipher_algo</parameter></term>
     <listitem>
      <para>
       <link linkend="openssl.ciphers">暗号定数</link>のうちの一つ。
      </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.1.0</entry>
      <entry>
       デフォルトの暗号化アルゴリズム
       (<parameter>cipher_algo</parameter>) 
       が、
       AES-128-CBC (<constant>OPENSSL_CIPHER_AES_128_CBC</constant>)
       になりました。
       これより前のバージョンでは、
       PKCS7/CMS (<constant>OPENSSL_CIPHER_RC2_40</constant>)
       が使われていました。
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>certificate</parameter> は、
       <classname>OpenSSLCertificate</classname> クラスのインスタンスを受け入れるようになりました。
       これより前のバージョンでは、
       <literal>OpenSSL X.509 CSR</literal> 型のリソースを受け入れていました。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>openssl_pkcs7_encrypt</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
// 暗号化するメッセージを nighthawk という名前の外部の秘密の
// エージェントに送信します。送信先の証明書をファイル nighthawk.pem に
// 有しています。
$data = <<<EOD
Nighthawk,

Top secret, for your eyes only!

The enemy is closing in! Meet me at the cafe at 8.30am
to collect your forged passport!

HQ
EOD;

// キーを読み込む
$key = file_get_contents("nighthawk.pem");

// ファイルにメッセージを保存
$fp = fopen("msg.txt", "w");
fwrite($fp, $data);
fclose($fp);

// メッセージを暗号化
if (openssl_pkcs7_encrypt("msg.txt", "enc.txt", $key,
    array("To" => "nighthawk@example.com", // 連想配列の構文
          "From: HQ <hq@example.com>", // 添字配列の構文
          "Subject" => "Eyes only"))) {
    // メッセージを暗号化し、送信します!
    exec(ini_get("sendmail_path") . " < enc.txt");
}
?>
]]>
    </programlisting>
   </example>
  </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
-->