mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
22c8f44c1a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345163 c90b9560-bf6c-de11-be94-00142212c4b1
201 lines
6.7 KiB
XML
201 lines
6.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.stream-socket-enable-crypto" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>stream_socket_enable_crypto</refname>
|
|
<refpurpose>Turns encryption on/off on an already connected socket</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</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>
|
|
Enable or disable encryption on the stream.
|
|
</simpara>
|
|
|
|
<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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>stream</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The stream resource.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>enable</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Enable/disable cryptography on the stream.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>crypto_type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Setup encryption on the stream.
|
|
Valid methods are
|
|
<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_ANY_CLIENT</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLS_CLIENT</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLSv1_2_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_ANY_SERVER</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLS_SERVER</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</constant></simpara></listitem>
|
|
<listitem><simpara><constant>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</constant></simpara></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<para>
|
|
If omitted, the <literal>crypto_method</literal> context option on
|
|
the stream's SSL context will be used instead.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>session_stream</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Seed the stream with settings from <parameter>session_stream</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true; on success, &false; if negotiation has failed or
|
|
<literal>0</literal> if there isn't enough data and you should try again
|
|
(only for non-blocking sockets).
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.6.0</entry>
|
|
<entry>
|
|
Introduce <constant>STREAM_CRYPTO_METHOD_ANY_CLIENT</constant>, <constant>STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</constant>, <constant>STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</constant>, <constant>STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT</constant>, <constant>STREAM_CRYPTO_METHOD_ANY_SERVER</constant>, <constant>STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</constant>, <constant>STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</constant>, <constant>STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</constant>.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>5.6.0</entry>
|
|
<entry>
|
|
The <parameter>crypto_type</parameter> is now optional.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples"><!-- {{{ -->
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="stream-socket-enable-crypto.example.basic"><!-- {{{ -->
|
|
<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.outputs.similar;
|
|
<screen>
|
|
<![CDATA[
|
|
]]>
|
|
</screen>
|
|
</example><!-- }}} -->
|
|
</para>
|
|
</refsect1><!-- }}} -->
|
|
|
|
<refsect1 role="seealso"><!-- {{{ -->
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><xref linkend="ref.openssl" /></member>
|
|
<member><xref linkend="transports" /></member>
|
|
</simplelist>
|
|
</para>
|
|
</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:"~/.phpdoc/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
|
|
-->
|