mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 21:08:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
83 lines
2.4 KiB
XML
83 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-get-private">
|
|
<refnamediv>
|
|
<refname>openssl_pkey_get_private</refname>
|
|
<refpurpose>Get a private key</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>openssl_pkey_get_private</methodname>
|
|
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter><initializer>""</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>openssl_get_privatekey</function> parses
|
|
<parameter>key</parameter> and prepares it for use by other functions.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>key</parameter> can be one of the following:
|
|
<orderedlist>
|
|
<listitem><simpara>a string having the format
|
|
<filename>file://path/to/file.pem</filename>. The named file must
|
|
contain a PEM encoded certificate/private key (it may contain both).
|
|
</simpara>
|
|
</listitem>
|
|
<listitem><simpara>A PEM formatted private key.</simpara></listitem>
|
|
</orderedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>passphrase</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The optional parameter <parameter>passphrase</parameter> must be used
|
|
if the specified key is encrypted (protected by a passphrase).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns a positive key resource identifier on success, or &false; on error.
|
|
</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
|
|
-->
|