<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.stream.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.stream-socket-enable-crypto.php',
    1 => 'stream_socket_enable_crypto',
    2 => '接続済みのソケットについて暗号化の on/off を切り替える',
  ),
  'up' => 
  array (
    0 => 'ref.stream.php',
    1 => 'ストリーム 関数',
  ),
  'prev' => 
  array (
    0 => 'function.stream-socket-client.php',
    1 => 'stream_socket_client',
  ),
  'next' => 
  array (
    0 => 'function.stream-socket-get-name.php',
    1 => 'stream_socket_get_name',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/stream/functions/stream-socket-enable-crypto.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<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 &gt;= 5.1.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">stream_socket_enable_crypto</span> &mdash; <span class="dc-title">接続済みのソケットについて暗号化の on/off を切り替える</span></p>
 
 </div>
 
 <div class="refsect1 description" id="refsect1-function.stream-socket-enable-crypto-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>stream_socket_enable_crypto</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$stream</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$enable</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$crypto_method</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></span> <code class="parameter">$session_stream</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>


  <p class="simpara">
   ストリームの暗号化を有効あるいは無効にします。
  </p>

  <p class="simpara">
   暗号化設定が確立されると、それ以降は
   <code class="parameter">enable</code> パラメータに <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> あるいは <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>
   を指定することで暗号化の on/off を動的に切り替えられます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.stream-socket-enable-crypto-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">stream</code></dt>
     <dd>
      <p class="para">
       ストリームリソース。
      </p>
     </dd>
    
    
     <dt><code class="parameter">enable</code></dt>
     <dd>
      <p class="para">
       ストリームの暗号化を有効にするか無効にするか。
      </p>
     </dd>
    
    
     <dt><code class="parameter">crypto_method</code></dt>
     <dd>
      <p class="para">
       ストリームの暗号化の設定。以下の方法が使用できます。
       <ul class="itemizedlist">
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-sslv2-client">STREAM_CRYPTO_METHOD_SSLv2_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-sslv3-client">STREAM_CRYPTO_METHOD_SSLv3_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-sslv23-client">STREAM_CRYPTO_METHOD_SSLv23_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-any-client">STREAM_CRYPTO_METHOD_ANY_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tls-client">STREAM_CRYPTO_METHOD_TLS_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-0-client">STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-1-client">STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-2-client">STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-3-client">STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT</a></code></strong> (PHP 7.4.0 以降)</span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-sslv2-server">STREAM_CRYPTO_METHOD_SSLv2_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-sslv3-server">STREAM_CRYPTO_METHOD_SSLv3_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-sslv23-server">STREAM_CRYPTO_METHOD_SSLv23_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-any-server">STREAM_CRYPTO_METHOD_ANY_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tls-server">STREAM_CRYPTO_METHOD_TLS_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-0-server">STREAM_CRYPTO_METHOD_TLSv1_0_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-1-server">STREAM_CRYPTO_METHOD_TLSv1_1_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-2-server">STREAM_CRYPTO_METHOD_TLSv1_2_SERVER</a></code></strong></span></li>
        <li class="listitem"><span class="simpara"><strong><code><a href="stream.constants.php#constant.stream-crypto-method-tlsv1-3-server">STREAM_CRYPTO_METHOD_TLSv1_3_SERVER</a></code></strong> (PHP 7.4.0 以降)</span></li>
       </ul>
      </p>
      <p class="para">
       省略した場合は、ストリームの SSL コンテキストのオプション <code class="literal">crypto_method</code>
       を利用します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">session_stream</code></dt>
     <dd>
      <p class="para">
       ストリームで <code class="parameter">session_stream</code> からの設定を送信します。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.stream-socket-enable-crypto-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>、ネゴシエーションに失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>、
   十分なデータがないために再試行が必要な場合（非ブロックモード時のみ）
   に <code class="literal">0</code> を返します。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.stream-socket-enable-crypto-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">session_stream</code> は、nullable になりました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.stream-socket-enable-crypto-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="stream-socket-enable-crypto.example.basic">
    <p><strong>例1 <span class="function"><strong>stream_socket_enable_crypto()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">"接続できません: </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">/* ログイン時の暗号化を有効にします */<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">/* それ以外では暗号化を無効にします */<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">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>上の例の出力は、
たとえば以下のようになります。</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode"></pre>
</div>
    </div>
   </div>
  </p>
 </div>

 
 <div class="refsect1 seealso" id="refsect1-function.stream-socket-enable-crypto-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><a href="ref.openssl.php" class="xref">OpenSSL 関数</a></li>
    <li><a href="transports.php" class="xref">サポートされるソケットトランスポートのリスト</a></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>