<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openssl-pkcs12-export" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_pkcs12_export</refname>
  <refpurpose>Exports a <acronym>PKCS</acronym>#12 Compatible Certificate Store File to variable</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_pkcs12_export</methodname>
   <methodparam><type class="union"><type>OpenSSLCertificate</type><type>string</type></type><parameter>certificate</parameter></methodparam>
   <methodparam><type>string</type><parameter role="reference">output</parameter></methodparam>
   <methodparam><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>passphrase</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter><initializer>[]</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkcs12_export</function> stores
   <parameter>certificate</parameter> into a string named by
   <parameter>output</parameter> in a <acronym>PKCS</acronym>#12 file format.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &openssl.param.x509;
    <varlistentry>
     <term><parameter>output</parameter></term>
     <listitem>
      <para>
       On success, this will hold the <acronym>PKCS</acronym>#12.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>private_key</parameter></term>
     <listitem>
      <para>
      Private key component of <acronym>PKCS</acronym>#12 file.
      See <link linkend="openssl.certparams">Public/Private Key parameters</link> for a list of valid values.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
      Encryption password for unlocking the <acronym>PKCS</acronym>#12 file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Optional array, other keys will be ignored.
       <informaltable>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Key</entry>
           <entry>&Description;</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>"extracerts"</literal></entry>
           <entry>array of extra certificates or a single certificate to be included in the <acronym>PKCS</acronym>#12 file.</entry>
          </row>
          <row>
           <entry><literal>"friendly_name"</literal></entry>
           <entry>string to be used for the supplied certificate and key</entry>
          </row>
         </tbody>
        </tgroup>
       </informaltable>
      </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>certificate</parameter> accepts an <classname>OpenSSLCertificate</classname> instance now;
       previously, a &resource; of type <literal>OpenSSL X.509 CSR</literal> was accepted.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>private_key</parameter> accepts an <classname>OpenSSLAsymmetricKey</classname>
       or <classname>OpenSSLCertificate</classname> instance now;
       previously, a &resource; of type <literal>OpenSSL key</literal> or <literal>OpenSSL X.509</literal>
       was accepted.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </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
-->
