1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
|
<?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. Following methods may be used to get them:
<itemizedlist>
<listitem>
<para>
Certificates
<orderedlist>
<listitem>
<simpara>
An <classname>OpenSSLCertificate</classname> instance
(or prior to PHP 8.0.0, a &resource; of type <literal>OpenSSL X.509</literal>)
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 <acronym>PEM</acronym> encoded certificate
</simpara>
</listitem>
<listitem>
<simpara>
A string containing the content of a certificate, <acronym>PEM</acronym>
encoded, may start with <literal>-----BEGIN CERTIFICATE-----</literal>
</simpara>
</listitem>
</orderedlist>
</para>
</listitem>
<listitem>
<para>
Certificate Signing Requests (CSRs)
<orderedlist>
<listitem>
<simpara>
An <classname>OpenSSLCertificateSigningRequest</classname> instance
(or prior to PHP 8.0.0, a &resource; of type <literal>OpenSSL X.509 CSR</literal>)
returned from <function>openssl_csr_new</function>
</simpara>
</listitem>
<listitem>
<simpara>A string having the format
<filename>file://path/to/csr.pem</filename>; the named file must
contain a <acronym>PEM</acronym> encoded <acronym>CSR</acronym>
</simpara>
</listitem>
<listitem>
<simpara>
A string containing the content of a <acronym>CSR</acronym>, <acronym>PEM</acronym> encoded,
may start with <literal>-----BEGIN CERTIFICATE REQUEST-----</literal>
</simpara>
</listitem>
</orderedlist>
</para>
</listitem>
<listitem>
<para>
Public/Private Keys
<orderedlist>
<listitem>
<simpara>
An <classname>OpenSSLAsymmetricKey</classname> instance
(or prior to PHP 8.0.0, a &resource; of type <literal>OpenSSL key</literal>)
returned from <function>openssl_get_publickey</function> or
<function>openssl_get_privatekey</function>
</simpara>
</listitem>
<listitem>
<simpara>
For public keys only: an <classname>OpenSSLCertificate</classname> instance
(or prior to PHP 8.0.0, a &resource; of type <literal>OpenSSL X.509</literal>)
</simpara>
</listitem>
<listitem>
<simpara>A string having the format
<filename>file://path/to/file.pem</filename> - the named file must
contain a <acronym>PEM</acronym> encoded certificate/private key (it may contain both)
</simpara>
</listitem>
<listitem>
<simpara>
A string containing the content of a certificate/key,
<acronym>PEM</acronym> encoded, may start with
<literal>-----BEGIN PUBLIC KEY-----</literal>
</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
-->
|