接続済みのソケットについて暗号化の on/off を切り替える

# stream_socket_enable_crypto

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

stream_socket_enable_crypto — 接続済みのソケットについて暗号化の on/off を切り替える

### 説明

function stream_socket_enable_crypto(
resource `$stream`,
bool `$enable`,
?int `$crypto_method` = `null`,
?resource `$session_stream` = `null`
): int|bool

ストリームの暗号化を有効あるいは無効にします。

暗号化設定が確立されると、それ以降は `enable` パラメータに `true` あるいは `false` を指定することで暗号化の on/off を動的に切り替えられます。

### パラメータ

`stream`

  ストリームリソース。

`enable`

  ストリームの暗号化を有効にするか無効にするか。

`crypto_method`

  ストリームの暗号化の設定。以下の方法が使用できます。

  - `STREAM_CRYPTO_METHOD_SSLv2_CLIENT`
  - `STREAM_CRYPTO_METHOD_SSLv3_CLIENT`
  - `STREAM_CRYPTO_METHOD_SSLv23_CLIENT`
  - `STREAM_CRYPTO_METHOD_ANY_CLIENT`
  - `STREAM_CRYPTO_METHOD_TLS_CLIENT`
  - `STREAM_CRYPTO_METHOD_TLSv1_0_CLIENT`
  - `STREAM_CRYPTO_METHOD_TLSv1_1_CLIENT`
  - `STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT`
  - `STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT` (PHP 7.4.0 以降)
  - `STREAM_CRYPTO_METHOD_SSLv2_SERVER`
  - `STREAM_CRYPTO_METHOD_SSLv3_SERVER`
  - `STREAM_CRYPTO_METHOD_SSLv23_SERVER`
  - `STREAM_CRYPTO_METHOD_ANY_SERVER`
  - `STREAM_CRYPTO_METHOD_TLS_SERVER`
  - `STREAM_CRYPTO_METHOD_TLSv1_0_SERVER`
  - `STREAM_CRYPTO_METHOD_TLSv1_1_SERVER`
  - `STREAM_CRYPTO_METHOD_TLSv1_2_SERVER`
  - `STREAM_CRYPTO_METHOD_TLSv1_3_SERVER` (PHP 7.4.0 以降)

  省略した場合は、ストリームの SSL コンテキストのオプション `crypto_method` を利用します。

`session_stream`

  ストリームで `session_stream` からの設定を送信します。

### 戻り値

成功した場合に `true`、ネゴシエーションに失敗した場合に `false`、 十分なデータがないために再試行が必要な場合（非ブロックモード時のみ） に `0` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.0.0 | `session_stream` は、nullable になりました。

### 例

例1 stream_socket_enable_crypto() の例

    <?php
    $fp = stream_socket_client("tcp://myproto.example.com:31337", $errno, $errstr, 30);
    if (!$fp) {
        die("接続できません: $errstr ($errno)");
    }

    /* ログイン時の暗号化を有効にします */
    stream_socket_enable_crypto($fp, true, STREAM_CRYPTO_METHOD_SSLv23_CLIENT);
    fwrite($fp, "USER god\r\n");
    fwrite($fp, "PASS secret\r\n");

    /* それ以外では暗号化を無効にします */
    stream_socket_enable_crypto($fp, false);

    while ($motd = fgets($fp)) {
        echo $motd;
    }

    fclose($fp);
    ?>

上の例の出力は、 たとえば以下のようになります。

### 参考

- OpenSSL 関数
- サポートされるソケットトランスポートのリスト

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open