From 1c3ce36b879c92b14ce5545009e1d7c08f7ac9ad Mon Sep 17 00:00:00 2001
From: Sara Golemon <pollita@php.net>
Date: Thu, 22 Jul 2004 21:19:00 +0000
Subject: [PATCH] Document new function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@164036 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/stream-socket-enable-crypto.xml | 106 ++++++++++++++++++
 1 file changed, 106 insertions(+)
 create mode 100644 reference/stream/functions/stream-socket-enable-crypto.xml

diff --git a/reference/stream/functions/stream-socket-enable-crypto.xml b/reference/stream/functions/stream-socket-enable-crypto.xml
new file mode 100644
index 0000000000..8b33d463e7
--- /dev/null
+++ b/reference/stream/functions/stream-socket-enable-crypto.xml
@@ -0,0 +1,106 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.stream-socket-enable-crypto">
+   <refnamediv>
+    <refname>stream_socket_enable_crypto</refname>
+    <refpurpose>
+     Turns encryption on/off on an already connected socket.
+    </refpurpose> 
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>resource</type><methodname>stream_socket_enable_crypto</methodname>
+      <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
+      <methodparam><type>bool</type><parameter>enable</parameter></methodparam>
+      <methodparam choice="opt"><type>int</type><parameter>crypto_type</parameter></methodparam>
+      <methodparam choice="opt"><type>resource</type><parameter>session_stream</parameter></methodparam>
+     </methodsynopsis>
+
+    <simpara>
+     When called with the <parameter>crypto_type</parameter> parameter,
+     <function>stream_socket_enable_crypto</function> will setup
+     encryption on the stream using the specified method.
+    </simpara>
+
+    <para>
+     Valid values for <parameter>crypto_type</parameter>
+     <itemizedlist>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_SSLv2_CLIENT</constant></simpara></listitem>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_SSLv3_CLIENT</constant></simpara></listitem>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_SSLv23_CLIENT</constant></simpara></listitem>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLS_CLIENT</constant></simpara></listitem>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_SSLv2_SERVER</constant></simpara></listitem>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_SSLv3_SERVER</constant></simpara></listitem>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_SSLv23_SERVER</constant></simpara></listitem>
+      <listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLS_SERVER</constant></simpara></listitem>
+     </itemizedlist>
+    </para>
+
+    <simpara>
+     Once the crypto settings are established, cryptography can be turned
+     on and off dynamically by passing &true; or &false; in the
+     <parameter>enable</parameter> parameter.
+    </simpara>
+
+    <simpara>
+     If this stream should be seeded with settings from an already established
+     crypto enabled stream, pass that stream's resource variable
+     in the fourth parameter.
+    </simpara>
+
+    <simpara>
+     &return.success;
+    </simpara>
+
+    <example>
+     <title><function>stream_socket_enable_crypto</function> Example</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+$fp = stream_socket_client("tcp://myproto.example.com:31337", $errno, $errstr, 30);
+if (!$fp) {
+  die("Unable to connect: $errstr ($errno)");
+}
+/* Turn on encryption for login phase */
+stream_socket_enable_crypto($fp, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT);
+fwrite($fp, "USER god\r\n");
+fwrite($fp, "PASS secret\r\n");
+/* Turn off encryption for the rest */
+stream_socket_enable_crypto($fp, false);
+while ($motd = fgets($fp)) {
+  echo $motd;
+}
+fclose($fp);
+?>
+]]>
+     </programlisting>
+    </example>
+
+    <simpara>
+     <xref linkend="ref.openssl"/>, and
+     <xref linkend="transports"/>
+    </simpara>
+   </refsect1>
+  </refentry>
+
+<!-- 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:"../../../../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
+-->