openssl-spki-export.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.openssl-spki-export" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>openssl_spki_export</refname>
  <refpurpose>Exports a valid <acronym>PEM</acronym> formatted public key signed public key and challenge</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>openssl_spki_export</methodname>
   <methodparam><type>string</type><parameter>spki</parameter></methodparam>
  </methodsynopsis>
  <para>
    Exports <acronym>PEM</acronym> formatted public key from encoded signed public key and challenge
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
    <varlistentry>
     <term><parameter>spki</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 <acronym>PEM</acronym> formatted public key or &false; 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>spki</parameter> parameter.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="openssl_spki_export.example.basic">
   <title><function>openssl_spki_export</function> example</title>
   <para>
      Extracts the associated <acronym>PEM</acronym> formatted public key or &null; on failure.
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$pkey = openssl_pkey_new('secret password');
$spkac = openssl_spki_new($pkey, 'challenge string');
$pubKey = openssl_spki_export(preg_replace('/SPKAC=/', '', $spkac));

if ($pubKey) {
    echo $pubKey;
}
?>
]]>
   </programlisting>
  </example>
  <example xml:id="openssl_spki_export.example.keygen">
   <title><function>openssl_spki_export</function> example from &lt;keygen&gt;</title>
   <para>
      Extracts the associated <acronym>PEM</acronym> formatted public key issued from the &lt;keygen&gt; element
   </para>
   <programlisting role="php">
<![CDATA[
<?php
$spkac = openssl_spki_export(preg_replace('/SPKAC=/', '', $_POST['spkac']));
if ($spkac != NULL) {
    echo $spkac;
} else {
    echo "Extraction of pub key failed";
}
?>
<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_challenge</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
-->