openssl-pkcs12-export.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.openssl-pkcs12-export" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_pkcs12_export</refname>
  <refpurpose><acronym>PKCS</acronym>#12 互換の証明書保存ファイルを変数にエクスポートする</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><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><modifier role="attribute">#[\SensitiveParameter]</modifier><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> は、
   <parameter>certificate</parameter> を <acronym>PKCS</acronym>#12 ファイルフォーマットにしたものを
   <parameter>output</parameter> で指定した文字列に格納します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    &openssl.param.x509;
    <varlistentry>
     <term><parameter>output</parameter></term>
     <listitem>
      <para>
       成功した場合に、ここに <acronym>PKCS</acronym>#12 が保存されます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>private_key</parameter></term>
     <listitem>
      <para>
      <acronym>PKCS</acronym>#12 ファイルのプライベートキーコンポーネント。
      正しい値の一覧については、<link linkend="openssl.certparams">Public/Private Key parameters</link> を参照ください。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
      <acronym>PKCS</acronym>#12 ファイルのロックを解除するためのパスワード。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       オプションの配列。以下に示すキー以外は無視されます。
       <informaltable>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>キー</entry>
           <entry>&Description;</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>"extracerts"</literal></entry>
           <entry><acronym>PKCS</acronym>#12 ファイルに含まれる単一の証明書、または 外部の証明書の配列</entry>
          </row>
          <row>
           <entry><literal>"friendly_name"</literal></entry>
           <entry>与えられた証明書とキーで使われる文字列</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> は、
       <classname>OpenSSLCertificate</classname> クラスのインスタンスを受け入れるようになりました。
       これより前のバージョンでは、
       <literal>OpenSSL X.509 CSR</literal> 型のリソースを受け入れていました。
      </entry>
     </row>
     <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</literal> 型のリソースを受け入れていました。
      </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
-->