<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Turns encryption on/off on an already connected socket</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-socket-client.html">stream_socket_client</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-socket-get-name.html">stream_socket_get_name</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.stream-socket-enable-crypto" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_socket_enable_crypto</h1>
<p class="verinfo">(PHP 5 >= 5.1.0)</p><p class="refpurpose"><span class="refname">stream_socket_enable_crypto</span> — <span class="dc-title">Turns encryption on/off on an already connected socket</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.stream-socket-enable-crypto-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>stream_socket_enable_crypto</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$stream</code></span>
, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$enable</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$crypto_type</code></span>
[, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session_stream</code></span>
]] )</div>
<p class="simpara">
Enable or disable encryption on the stream.
</p>
<p class="simpara">
Once the crypto settings are established, cryptography can be turned
on and off dynamically by passing <strong><code>TRUE</code></strong> or <strong><code>FALSE</code></strong> in the
<em><code class="parameter">enable</code></em> parameter.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.stream-socket-enable-crypto-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">stream</code></em></span>
<dd>
<p class="para">
The stream resource.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">enable</code></em></span>
<dd>
<p class="para">
Enable/disable cryptography on the stream.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">crypto_type</code></em></span>
<dd>
<p class="para">
Setup encryption on the stream.
Valid methods are
<ul class="itemizedlist">
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_SSLv2_CLIENT</code></strong></span></li>
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_SSLv3_CLIENT</code></strong></span></li>
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_SSLv23_CLIENT</code></strong></span></li>
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_TLS_CLIENT</code></strong></span></li>
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_SSLv2_SERVER</code></strong></span></li>
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_SSLv3_SERVER</code></strong></span></li>
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_SSLv23_SERVER</code></strong></span></li>
<li class="listitem"><span class="simpara"><strong><code>STREAM_CRYPTO_METHOD_TLS_SERVER</code></strong></span></li>
</ul>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">session_stream</code></em></span>
<dd>
<p class="para">
Seed the stream with settings from <em><code class="parameter">session_stream</code></em>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.stream-socket-enable-crypto-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success, <strong><code>FALSE</code></strong> if negotiation has failed or
<em>0</em> if there isn't enough data and you should try again
(only for non-blocking sockets).
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.stream-socket-enable-crypto-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="stream-socket-enable-crypto.example.basic">
<p><strong>Example #1 <span class="function"><strong>stream_socket_enable_crypto()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_socket_client</span><span style="color: #007700">(</span><span style="color: #DD0000">"tcp://myproto.example.com:31337"</span><span style="color: #007700">, </span><span style="color: #0000BB">$errno</span><span style="color: #007700">, </span><span style="color: #0000BB">$errstr</span><span style="color: #007700">, </span><span style="color: #0000BB">30</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">$fp</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">"Unable to connect: </span><span style="color: #0000BB">$errstr</span><span style="color: #DD0000"> (</span><span style="color: #0000BB">$errno</span><span style="color: #DD0000">)"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Turn on encryption for login phase */<br /></span><span style="color: #0000BB">stream_socket_enable_crypto</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_CRYPTO_METHOD_SSLv23_CLIENT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"USER god\r\n"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">"PASS secret\r\n"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Turn off encryption for the rest */<br /></span><span style="color: #0000BB">stream_socket_enable_crypto</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$motd </span><span style="color: #007700">= </span><span style="color: #0000BB">fgets</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #0000BB">$motd</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.stream-socket-enable-crypto-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="ref.openssl.html" class="xref">OpenSSL Functions</a></li>
<li class="member"><a href="transports.html" class="xref">List of Supported Socket Transports</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-socket-client.html">stream_socket_client</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-socket-get-name.html">stream_socket_get_name</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
