Added version notes, corrected a couple of typos.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@44864 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Wez Furlong 2001-04-04 18:44:31 +00:00
parent e7c8cba88b
commit 5057595153

View file

@ -14,12 +14,14 @@
<para>
New for dev/CVS versions of PHP is support for S/MIME email
signing/verification and encryption/decryption. Also, it is now possible
to specify keys/certs in a vareity of ways that should help make your PHP
to specify keys/certs in a variety of ways that should help make your PHP
code easier to write.
These features will most likely make it into PHP 4.0.6.
<emphasis>Please keep in mind that this extension is still considered
experimental!</emphasis>
</para>
<note>
<para>Please keep in mind that this extension is still considered
experimental!</para>
</note>
<para>
OpenSSL offers many features that this module currently doesn't support.
Some of these may be added in the future.
@ -171,6 +173,11 @@
</tgroup>
</table>
</para>
<note>
<para>These constants were added in 4.0.6.</para>
</note>
</sect1>
</partintro>
@ -208,6 +215,11 @@ while($msg = openssl_error_string)
</programlisting>
</example>
</para>
<note>
<para>
This function was added in 4.0.6.
</para>
</note>
</refsect1>
</refentry>
@ -547,9 +559,6 @@ openssl_free_key($pubkeyid);
<para>The decrypted message is output to the
file specified by <parameter>outfilename</parameter>
</para>
<para><emphasis>The parameters/return type of this function may change before
it appears in a release version of PHP</emphasis></para>
<para>
<example>
<title><function>openssl_pkcs7_decrypt</function> example</title>
@ -567,6 +576,10 @@ else
</programlisting>
</example>
</para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>
@ -602,9 +615,6 @@ else
keyed by header name, or an indexed array, where each element contains
a single header line.
</para>
<para><emphasis>The parameters/return type of this function may change before
it appears in a release version of PHP</emphasis></para>
<para>
<example>
<title><function>openssl_pkcs7_encrypt</function> example</title>
@ -638,6 +648,11 @@ if (openssl_pkcs7_encrypt("msg.txt", "enc.txt", "nighthawk.pem",
</programlisting>
</example>
</para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>
@ -684,9 +699,6 @@ if (openssl_pkcs7_encrypt("msg.txt", "enc.txt", "nighthawk.pem",
a bunch of extra certificates to include in the signature which can for
example be used to help the recipient to verify the certificate that you used.
</para>
<para><emphasis>The parameters/return type of this function may change before
it appears in a release version of PHP</emphasis></para>
<para>
<example>
<title><function>openssl_pkcs7_sign</function> example</title>
@ -698,7 +710,6 @@ $data = &lt;&lt;&lt;EOD
You have my authorization to spend $10,000 on dinner expenses.
The CEO
HQ
EOD;
// save message to file
$fp = fopen("msg.txt", "w");
@ -717,6 +728,10 @@ if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
</programlisting>
</example>
</para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>
@ -765,8 +780,10 @@ if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
If the <parameter>extracerts</parameter> is specified, it is the filename
of a file containing a bunch of certificates to use as untrusted CAs.
</para>
<para><emphasis>The parameters/return type of this function may change before
it appears in a release version of PHP</emphasis></para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>
@ -808,8 +825,6 @@ if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
help verify the certificate, although no trust in placed in the
certificates that come from that file.
</para>
<para><emphasis>The parameters/return type of this function may change before
it appears in a release version of PHP</emphasis></para>
<para>
<table>
<title><function>openssl_x509_checkpurpose</function> purposes</title>
@ -857,6 +872,11 @@ if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
</table>
These options are not bitfields - you may specify one only!
</para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>
@ -877,6 +897,11 @@ if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
<function>openssl_x509_free</function> frees the certificate associated
with the specified <parameter>x509cert</parameter> resource from memory.
</para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>
@ -907,6 +932,11 @@ if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
</para>
<para><emphasis>The structure of the returned data is (deliberately) not
yet documented, as it is still subject to change.</emphasis></para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>
@ -929,6 +959,11 @@ if (openssl_pkcs7_sign("msg.txt", "signed.txt", "mycert.pem",
<parameter>x509certdata</parameter> and returns a resource identifier for
it.
</para>
<note>
<para>This function was added in 4.0.6.</para>
</note>
</refsect1>
</refentry>