cvs: phpdoc /en/reference/openssl constants.xml /en/reference/openssl/functions openssl-sign.xml openssl-verify.xml

tony2001 Thu Aug 24 20:46:46 2006 UTC Modified files: /phpdoc/en/reference/openssl constants.xml /phpdoc/en/reference/openssl/functions openssl-sign.xml openssl-verify.xml Log: add missing documentation for constants and function arguments http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/openssl/constants.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/openssl/constants.xml diff -u phpdoc/en/reference/openssl/constants.xml:1.4 phpdoc/en/reference/openssl/constants.xml:1.5 --- phpdoc/en/reference/openssl/constants.xml:1.4 Fri Jan 2 14:22:22 2004 +++ phpdoc/en/reference/openssl/constants.xml Thu Aug 24 20:46:46 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <section id="openssl.constants"> &reftitle.constants; &extension.constants; @@ -267,6 +267,61 @@ </note> </section> + <section id="openssl.signature-algos"> + <title>Signature Algorithms</title> + <variablelist> + <varlistentry> + <term> + <constant>OPENSSL_ALGO_SHA1</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + Used as default algorithm by <function>openssl_sign</function> and + <function>openssl_verify</function>. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>OPENSSL_ALGO_MD5</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>OPENSSL_ALGO_MD4</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term> + <constant>OPENSSL_ALGO_MD2</constant> + (<type>integer</type>) + </term> + <listitem> + <simpara> + + </simpara> + </listitem> + </varlistentry> + </variablelist> + + <note> + <para>These constants were added in 5.0.0.</para> + </note> + </section> + <!-- <section id="openssl.ciphers"> <title>Ciphers</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/openssl/functions/openssl-sign.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/openssl/functions/openssl-sign.xml diff -u phpdoc/en/reference/openssl/functions/openssl-sign.xml:1.8 phpdoc/en/reference/openssl/functions/openssl-sign.xml:1.9 --- phpdoc/en/reference/openssl/functions/openssl-sign.xml:1.8 Tue Jul 19 13:41:16 2005 +++ phpdoc/en/reference/openssl/functions/openssl-sign.xml Thu Aug 24 20:46:46 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/openssl.xml, last change in rev 1.1 --> <refentry id="function.openssl-sign"> <refnamediv> @@ -27,6 +27,14 @@ <parameter>priv_key_id</parameter>. Note that the data itself is not encrypted. </para> + <note> + <para> + Optional 4th parameter <parameter>signature_alg</parameter> was added in + version 5.0.0. Its default value is + <constant>OPENSSL_ALGO_SHA1</constant>. For more information see the + list of <link linkend="openssl.signature-algos">Signature Algorithms</link>. + </para> + </note> <para> <example> <title><function>openssl_sign</function> example</title> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/openssl/functions/openssl-verify.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/openssl/functions/openssl-verify.xml diff -u phpdoc/en/reference/openssl/functions/openssl-verify.xml:1.6 phpdoc/en/reference/openssl/functions/openssl-verify.xml:1.7 --- phpdoc/en/reference/openssl/functions/openssl-verify.xml:1.6 Tue Jul 19 13:41:16 2005 +++ phpdoc/en/reference/openssl/functions/openssl-verify.xml Thu Aug 24 20:46:46 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- splitted from ./en/functions/openssl.xml, last change in rev 1.1 --> <refentry id="function.openssl-verify"> <refnamediv> @@ -13,6 +13,7 @@ <methodparam><type>string</type><parameter>data</parameter></methodparam> <methodparam><type>string</type><parameter>signature</parameter></methodparam> <methodparam><type>mixed</type><parameter>pub_key_id</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>signature_alg</parameter></methodparam> </methodsynopsis> <para> Returns 1 if the signature is correct, 0 if it is incorrect, and @@ -25,7 +26,14 @@ <parameter>pub_key_id</parameter>. This must be the public key corresponding to the private key used for signing. </para> - + <note> + <para> + Optional 4th parameter <parameter>signature_alg</parameter> was added in + version 5.2.0. Its default value is + <constant>OPENSSL_ALGO_SHA1</constant>. For more information see the + list of <link linkend="openssl.signature-algos">Signature Algorithms</link>. + </para> + </note> <para> <example> <title><function>openssl_verify</function> example</title>