php-doc-en/reference/openssl/functions/openssl-spki-export-challenge.xml
Christoph Michael Becker 9e4c917c09 Fix other miscellaneous typos
Detected by codespell

Patch provided by tandre@php.net.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@349709 c90b9560-bf6c-de11-be94-00142212c4b1
2020-04-27 06:50:00 +00:00

118 lines
3.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openssl-spki-export-challenge" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>openssl_spki_export_challenge</refname>
<refpurpose>Exports the challenge associated with a signed public key and challenge</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="procedural">
<type>string</type><methodname>openssl_spki_export_challenge</methodname>
<methodparam><type>string</type><parameter role="reference">spkac</parameter></methodparam>
</methodsynopsis>
<para>
Exports challenge from encoded signed public key and challenge
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>spkac</parameter></term>
<listitem>
<para>
Expects a valid signed public key and challenge
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the associated challenge string or NULL on failure.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Emits an <constant>E_WARNING</constant> level error if an invalid argument
is passed via the <parameter>spkac</parameter> parameter.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example xml:id="openssl_spki_export_challenge.example.basic">
<title><function>openssl_spki_export_challenge</function> example</title>
<para>
Extracts the associated challenge string or NULL on failure.
</para>
<programlisting role="php">
<![CDATA[
<?php
$pkey = openssl_pkey_new('secret password');
$spkac = openssl_spki_new($pkey, 'challenge string');
$challenge = openssl_spki_export_challenge(preg_replace('/SPKAC=/', '', $spkac));
?>
]]>
</programlisting>
</example>
<example xml:id="openssl_spki_export_challenge.example.keygen">
<title><function>openssl_spki_export_challenge</function> example from &lt;keygen&gt;</title>
<para>
Extracts the associated challenge string issued from the &lt;keygen&gt; element
</para>
<programlisting role="php">
<![CDATA[
<?php
$challenge = openssl_spki_export_challenge(preg_replace('/SPKAC=/', '', $_POST['spkac']));
?>
<keygen name="spkac" challenge="challenge string" keytype="RSA">
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>openssl_spki_new</function></member>
<member><function>openssl_spki_verify</function></member>
<member><function>openssl_spki_export</function></member>
<member><function>openssl_get_md_methods</function></member>
<member><function>openssl_csr_new</function></member>
<member><function>openssl_csr_sign</function></member>
</simplelist>
</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
-->