openssl-pkey-get-private.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5bc68add3da3cd18c40f851e944b15095d3a26aa Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.openssl-pkey-get-private" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>openssl_pkey_get_private</refname>
  <refpurpose>秘密鍵を取得する</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>OpenSSLAsymmetricKey</type><type>false</type></type><methodname>openssl_pkey_get_private</methodname>
   <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 choice="opt"><modifier role="attribute">#[\SensitiveParameter]</modifier><type class="union"><type>string</type><type>null</type></type><parameter>passphrase</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>openssl_pkey_get_private</function> は
   <parameter>private_key</parameter> をパースし、他の関数で使用できるよう準備します。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>private_key</parameter></term>
     <listitem>
      <para>
       <parameter>private_key</parameter> は以下のいずれかです。
       <orderedlist>
        <listitem>
         <simpara>
          <filename>file://path/to/file.pem</filename> 形式の文字列。
          このファイルは、<acronym>PEM</acronym> エンコードされた証明書/秘密鍵である必要が
          あります（両方を含むことも可能です）。
         </simpara>
        </listitem>
        <listitem><simpara><acronym>PEM</acronym> フォーマットの秘密鍵。</simpara></listitem>
       </orderedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passphrase</parameter></term>
     <listitem>
      <para>
       指定されたキーが（パスフレーズを用いて）暗号化されている場合は、
       オプションのパラメータ <parameter>passphrase</parameter> を使用する必要があります。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   成功した場合に、
   <classname>OpenSSLAsymmetricKey</classname> クラスのインスタンスを返します。
   エラー時に &false; を返します。
  </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>
       成功した場合に、
       この関数は <classname>OpenSSLAsymmetricKey</classname> クラスのインスタンスを返すようになりました。
       これより前のバージョンでは、
       <literal>OpenSSL key</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>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>passphrase</parameter> は、nullable になりました。
      </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
-->