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
95 lines
2.7 KiB
XML
95 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-export">
|
|
<refnamediv>
|
|
<refname>openssl_pkey_export</refname>
|
|
<refpurpose>Gets an exportable representation of a key into a string</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>openssl_pkey_export</methodname>
|
|
<methodparam><type>mixed</type><parameter>key</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter role="reference">out</parameter></methodparam>
|
|
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter>configargs</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>openssl_pkey_export</function> exports
|
|
<parameter>key</parameter> as a PEM encoded string and stores it into
|
|
<parameter>out</parameter> (which is passed by reference).
|
|
</para>
|
|
¬e.openssl.cnf;
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>out</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>passphrase</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The key is optionally protected by <parameter>passphrase</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>configargs</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>configargs</parameter> can be used to fine-tune the export
|
|
process by specifying and/or overriding options for the openssl
|
|
configuration file. See <function>openssl_csr_new</function> for more
|
|
information about <parameter>configargs</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</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
|
|
-->
|