php-doc-en/reference/openssl/functions/openssl-pkey-get-public.xml
Christoph Michael Becker c0dbd1f8b9 Use the proper function names here, not the aliases
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349092 c90b9560-bf6c-de11-be94-00142212c4b1
2020-02-02 17:02:39 +00:00

75 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.openssl-pkey-get-public">
<refnamediv>
<refname>openssl_pkey_get_public</refname>
<refpurpose>Extract public key from certificate and prepare it for use</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>resource</type><methodname>openssl_pkey_get_public</methodname>
<methodparam><type>mixed</type><parameter>certificate</parameter></methodparam>
</methodsynopsis>
<para>
<function>openssl_pkey_get_public</function> extracts the public key from
<parameter>certificate</parameter> and prepares it for use by other
functions.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>certificate</parameter></term>
<listitem>
<para>
<parameter>certificate</parameter> can be one of the following:
<orderedlist>
<listitem><simpara>an X.509 certificate resource</simpara></listitem>
<listitem><simpara>a string having the format
<filename>file://path/to/file.pem</filename>. The named file must
contain a PEM encoded certificate/public key (it may contain both).
</simpara>
</listitem>
<listitem><simpara>A PEM formatted public key.</simpara></listitem>
</orderedlist>
</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
-->