openssl-pkcs12-read.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: takagi Status: ready -->
<refentry xml:id="function.openssl-pkcs12-read" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_pkcs12_read</refname>
  <refpurpose><acronym>PKCS</acronym>#12 認証ストアをパースして配列形式にする</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>openssl_pkcs12_read</methodname>
   <methodparam><type>string</type><parameter>pkcs12</parameter></methodparam>
   <methodparam><type>array</type><parameter role="reference">certificates</parameter></methodparam>
   <methodparam><modifier role="attribute">#[\SensitiveParameter]</modifier><type>string</type><parameter>passphrase</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkcs12_read</function> は、
   <parameter>pkcs12</parameter> で指定した <acronym>PKCS</acronym>#12 認証ストアをパースして
   <parameter>certificates</parameter> で指定した配列に格納します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>pkcs12</parameter></term>
     <listitem>
      <para>
       認証ストアの内容。ファイル名ではありません。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>certificates</parameter></term>
     <listitem>
      <para>
       成功した場合に、ここに認証ストアデータが格納されます。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
      <acronym>PKCS</acronym>#12 ファイルのロックを解除するためのパスワード。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>openssl_pkcs12_read</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
if (!$cert_store = file_get_contents("/certs/file.p12")) {
    echo "Error: Unable to read the cert file\n";
    exit;
}

if (openssl_pkcs12_read($cert_store, $cert_info, "my_secret_pass")) {
    echo "Certificate Information\n";
    print_r($cert_info);
} else {
    echo "Error: Unable to read the cert store.\n";
    exit;
}
?>
]]>
   </programlisting>
  </example>
 </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
-->