php-doc-en/reference/openssl/functions/openssl-pkcs7-encrypt.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkcs7-encrypt">
 <refnamediv>
  <refname>openssl_pkcs7_encrypt</refname>
  <refpurpose>Encrypt an S/MIME message</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_pkcs7_encrypt</methodname>
   <methodparam><type>string</type><parameter>infile</parameter></methodparam>
   <methodparam><type>string</type><parameter>outfile</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>recipcerts</parameter></methodparam>
   <methodparam><type>array</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>cipherid</parameter><initializer>OPENSSL_CIPHER_RC2_40</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkcs7_encrypt</function> takes the contents of the
   file named <parameter>infile</parameter> and encrypts them using an RC2
   40-bit cipher so that they can only be read by the intended recipients
   specified by <parameter>recipcerts</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>infile</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>outfile</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>recipcerts</parameter></term>
     <listitem>
      <para>
       Either a lone X.509 certificate, or an array of X.509 certificates.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>headers</parameter></term>
     <listitem>
      <para>
       <parameter>headers</parameter> is an array of headers that
       will be prepended to the data after it has been encrypted.
      </para>
      <para>
       <parameter>headers</parameter> can be either an associative array
       keyed by header name, or an indexed array, where each element contains
       a single header line.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       <parameter>flags</parameter> can be used to specify options that affect
       the encoding process - see <link linkend="openssl.pkcs7.flags">PKCS7
       constants</link>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>cipherid</parameter></term>
     <listitem>
      <para>
       One of <link linkend="openssl.ciphers">cipher constants</link>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>openssl_pkcs7_encrypt</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
// the message you want to encrypt and send to your secret agent
// in the field, known as nighthawk.  You have his certificate
// in the file 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;

// load key
$key = file_get_contents("nighthawk.pem");

// save message to file
$fp = fopen("msg.txt", "w");
fwrite($fp, $data);
fclose($fp);

// encrypt it
if (openssl_pkcs7_encrypt("msg.txt", "enc.txt", $key,
    array("To" => "nighthawk@example.com", // keyed syntax
          "From: HQ <hq@example.com>", // indexed syntax
          "Subject" => "Eyes only"))) {
    // message encrypted - send it!
    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
-->