certparams.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<appendix xml:id="openssl.certparams" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>Key/Certificate parameters</title>
 <para>
  Quite a few of the openssl functions require a key or a certificate
  parameter. PHP 4.0.5 and earlier have to use a key or certificate
  <type>resource</type> returned by one of the
  <literal>openssl_get_xxx()</literal> functions.
  Later versions may use one of the following methods:
  <itemizedlist>
   <listitem>
    <para>
     Certificates
     <orderedlist>
      <listitem>
       <simpara>
        An X.509 resource returned from
        <function>openssl_x509_read</function>
       </simpara>
      </listitem>
      <listitem>
       <simpara>A string having the format
        <filename>file://path/to/cert.pem</filename>; the named file must
        contain a PEM encoded certificate
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        A string containing the content of a certificate, PEM encoded
       </simpara>
      </listitem>
     </orderedlist>
    </para>
   </listitem>
   
   <listitem>
    <para>
     Public/Private Keys
     <orderedlist>
      <listitem>
       <simpara>A key resource returned from
        <function>openssl_get_publickey</function> or
        <function>openssl_get_privatekey</function>
       </simpara>
      </listitem>
      <listitem>
       <simpara>For public keys only: an X.509 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/private key (it may contain both)
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        A string containing the content of a certificate/key, PEM encoded
       </simpara>
      </listitem>
      <listitem>
       <simpara>
        For private keys, you may also use the syntax
        <literal>array($key, $passphrase)</literal> where <varname>$key</varname> represents a
        key specified using the file:// or textual content notation above, and
        <varname>$passphrase</varname> represents a string containing the passphrase for that
        private key
       </simpara>
      </listitem>
     </orderedlist>
    </para> 
   </listitem>
  </itemizedlist>
 </para>
</appendix>

<!-- 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
-->