cvs: phpdoc /en/appendices transports.xml

pollita Mon Apr 28 18:45:41 2003 EDT Modified files: /phpdoc/en/appendices transports.xml Log: Clarifications and rewordings. Thx Wez Index: phpdoc/en/appendices/transports.xml diff -u phpdoc/en/appendices/transports.xml:1.1 phpdoc/en/appendices/transports.xml:1.2 --- phpdoc/en/appendices/transports.xml:1.1 Sat Apr 26 23:46:16 2003 +++ phpdoc/en/appendices/transports.xml Mon Apr 28 18:45:41 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <appendix id="transports"> <title>List of Supported Socket Transports</title> <para> @@ -17,8 +17,8 @@ </para> <section id="transports.inet"> - <title>Internet Domain: TCP, UDP, and SSL</title> - <simpara>PHP 3, PHP 4. <filename>ssl://</filename> since PHP 4.3</simpara> + <title>Internet Domain: TCP, UDP, SSL, and TLS</title> + <simpara>PHP 3, PHP 4. <literal>ssl://</literal> &amp; <literal>tls://</literal> since PHP 4.3</simpara> <note> <simpara> @@ -35,6 +35,7 @@ <listitem><simpara><literal>tcp://www.example.com</literal></simpara></listitem> <listitem><simpara><literal>udp://www.example.com</literal></simpara></listitem> <listitem><simpara><literal>ssl://www.example.com</literal></simpara></listitem> + <listitem><simpara><literal>tls://www.example.com</literal></simpara></listitem> </itemizedlist> <simpara> @@ -66,21 +67,26 @@ </note> <simpara> - The <literal>ssl://</literal> transport (available only when - openssl support is compiled into PHP) is an extension of the - <literal>tcp://</literal> transport which includes SSL encryption. + The <literal>ssl://</literal> and <literal>tls://</literal> transports + (available only when openssl support is compiled into PHP) are extensions + of the <literal>tcp://</literal> transport which includes SSL encryption. + In <literal>PHP 4.3</literal> OpenSSL support must be statically + compiled into <literal>PHP</literal>, in <literal>PHP 5.0</literal> + it may be compiled as a module or statically. </simpara> <para> <table> - <title>Context options (as of <literal>PHP 4.3.2</literal>)</title> + <title> + Context options for <literal>ssl://</literal> and <literal>tls://</literal> + transports (since <literal>PHP 4.3.2</literal>) + </title> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Usage</entry> <entry>Default</entry> - <entry>Transport</entry> </row> </thead> <tbody> @@ -91,7 +97,14 @@ Require verification of SSL certificate used. </entry> <entry>&false;</entry> - <entry><literal>ssl://</literal></entry> + </row> + <row> + <entry><literal>allow_self_signed</literal></entry> + <entry> + &true; or &false;. + Allow self-signed certificates. + </entry> + <entry>&false;</entry> </row> <row> <entry><literal>cafile</literal></entry> @@ -101,7 +114,15 @@ context option to authenticate the identity of the remote peer. </entry> <entry></entry> - <entry><literal>ssl://</literal></entry> + </row> + <row> + <entry><literal>capath</literal></entry> + <entry> + If <literal>cafile</literal> is not specified or if the certificate + is not found there, the directory pointed to by <literal>capath</literal> + is searched for a suitable certificate. <literal>capath</literal> + must be a correctly hashed certificate directory. + </entry> </row> <row> <entry><literal>local_cert</literal></entry> @@ -111,7 +132,6 @@ It can optionally contain the certificate chain of issuers. </entry> <entry></entry> - <entry><literal>ssl://</literal></entry> </row> <row> <entry><literal>passphrase</literal></entry> @@ -122,19 +142,28 @@ <entry></entry> </row> <row> - <entry><literal>cn_match</literal></entry> + <entry><literal>CN_match</literal></entry> <entry> Common Name we are expecting. PHP will perform limited wildcard matching. If the Common Name does not match this, the connection attempt will fail. </entry> <entry></entry> - <entry><literal>ssl://</literal></entry> </row> </tbody> </tgroup> </table> </para> + + <note> + <simpara> + Because <literal>ssl://</literal> is the underlying transport for the + <link linkend="wrappers.http"><literal>https://</literal></link> and + <link linkend="wrappers.ftp"><literal>ftps://</literal></link> wrappers, + any context options which apply to <literal>ssl://</literal> also apply to + <literal>https://</literal> and <literal>ftps://</literal>. + </simpara> + </note> </section> <section id="transports.unix">