<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/context.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'context.ssl.php',
    1 => 'SSL コンテキストオプション',
    2 => 'SSL コンテキストオプションの一覧',
  ),
  'up' => 
  array (
    0 => 'context.php',
    1 => 'コンテキストオプションとパラメータ',
  ),
  'prev' => 
  array (
    0 => 'context.ftp.php',
    1 => 'FTP コンテキストオプション',
  ),
  'next' => 
  array (
    0 => 'context.phar.php',
    1 => 'Phar コンテキストオプション',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'language/context/ssl.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="context.ssl" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SSL コンテキストオプション</h1>
  <p class="refpurpose"><span class="refname">SSL コンテキストオプション</span> &mdash; <span class="dc-title">SSL コンテキストオプションの一覧</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-context.ssl-description">
  <h3 class="title">説明</h3>
  <p class="para">
   <code class="literal">ssl://</code> および <code class="literal">tls://</code>
   トランスポート用のコンテキストオプションです。
  </p>
 </div>


 <div class="refsect1 options" id="refsect1-context.ssl-options">
  <h3 class="title">オプション</h3>
  <p class="para">
   <dl>
    
     <dt id="context.ssl.peer-name">
      <code class="parameter">peer_name</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       使用するピア名。省略した場合は、ストリームをオープンしたときに使ったホスト名をもとに、名前を推測します。
      </p>
     </dd>
    
    
     <dt id="context.ssl.verify-peer">
      <code class="parameter">verify_peer</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       SSL サーバー証明書の検証を要求するかどうか。
      </p>
      <p class="para">
       デフォルトは <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> です。
      </p>
     </dd>
    
    
     <dt id="context.ssl.verify-peer-name">
      <code class="parameter">verify_peer_name</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       ピア名の検証を要求するかどうか。
      </p>
      <p class="para">
       デフォルトは <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> です。
      </p>
     </dd>
    
    
     <dt id="context.ssl.allow-self-signed">
      <code class="parameter">allow_self_signed</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       自己証明の証明書を許可するかどうか。
       <a href="context.ssl.php#context.ssl.verify-peer" class="link"><code class="parameter">verify_peer</code></a>
       が必要です。
      </p>
      <p class="para">
       デフォルトは <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> です。
      </p>
     </dd>
    
    
     <dt id="context.ssl.cafile">
      <code class="parameter">cafile</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       ローカルファイルシステム上の証明書ファイルの場所。
       <code class="literal">verify_peer</code> オプションでリモートサーバーとの
       認証の際に使用する。
      </p>
     </dd>
    
    
     <dt id="context.ssl.capath">
      <code class="parameter">capath</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       <code class="literal">cafile</code> が指定されていなかったりその場所にファイルが
       見つからなかったりした場合、<code class="literal">capath</code> が指す
       ディレクトリを検索して認証ファイルを探します。<code class="literal">capath</code>
       は認証ファイルのディレクトリを正確に指している必要があります。
      </p>
     </dd>
    
    
     <dt id="context.ssl.local-cert">
      <code class="parameter">local_cert</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       ファイルシステム上のローカル証明書ファイルのパス。
       あなたの証明書とプライベートキーを含み、<abbr title="Privacy-Enhanced Mail">PEM</abbr> エンコードされた
       ファイルである必要があります。オプションで、発行者の
       認証チェーンを含めることも可能です。
       プライベートキーは、
       <code class="literal">local_pk</code> で指定した別のファイルに含めることも可能です。
      </p>
     </dd>
    
    
     <dt id="context.ssl.local-pk">
      <code class="parameter">local_pk</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       ローカルファイルシステム上のプライベートキーファイルの場所。
       証明書 (<code class="literal">local_cert</code>) とプライベートキーを別のファイルに分けたい場合に用います。
      </p>
     </dd>
    
    
     <dt id="context.ssl.passphrase">
      <code class="parameter">passphrase</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       <code class="literal">local_cert</code> ファイルをエンコードした際の
       パスフレーズ。
      </p>
     </dd>
    
    
     <dt id="context.ssl.verify-depth">
      <code class="parameter">verify_depth</code>
      <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
     </dt>
     <dd>
      <p class="para">
       証明書のチェインが深すぎる場合に終了するかどうか。
      </p>
      <p class="para">
       デフォルトでは検証を行いません。
      </p>
     </dd>
    
    
     <dt id="context.ssl.ciphers">
      <code class="parameter">ciphers</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
     </dt>
     <dd>
      <p class="para">
       使用可能な暗号化方式の一覧を設定します。設定できるフォーマットは
       <a href="https://docs.openssl.org/master/man1/openssl-ciphers/" class="link external">&raquo;&nbsp;ciphers(1)</a> の説明を参照ください。
      </p>
      <p class="para">
       デフォルトは <code class="literal">DEFAULT</code> です。
      </p>
     </dd>
    
    
     <dt id="context.ssl.capture-peer-cert">
      <code class="parameter">capture_peer_cert</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> に設定すると、<code class="literal">peer_certificate</code>
       コンテキストオプションがピア証明書を含んで作成されます。
      </p>
     </dd>
    
    
     <dt id="context.ssl.capture-peer-cert-chain">
      <code class="parameter">capture_peer_cert_chain</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> に設定すると、<code class="literal">peer_certificate_chain</code>
       コンテキストオプションが証明書チェインを含んで作成されます。
      </p>
     </dd>
    
    
     <dt id="context.ssl.sni-enabled">
      <code class="parameter">SNI_enabled</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> に設定すると、サーバー名の表示 (SNI) が有効になります。
       これを有効にすると、同じ IP アドレスで複数の証明書を使えるようになります。
      </p>
     </dd>
    
    
     <dt id="context.ssl.disable-compression">
      <code class="parameter">disable_compression</code>
      <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>
     </dt>
     <dd>
      <p class="para">
       設定すると、TLS 圧縮を無効にします。これは、CRIME アタックベクターを軽減するのに役立ちます。
      </p>
     </dd>
    
    
     <dt id="context.ssl.peer-fingerprint">
      <code class="parameter">peer_fingerprint</code>
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span> | <span class="type"><a href="language.types.array.php" class="type array">array</a></span>
     </dt>
     <dd>
      <p class="para">
       リモート証明書のダイジェストが指定したハッシュに一致しない場合に、異常終了させます。
      </p>
      <p class="para">
       <span class="type"><a href="language.types.string.php" class="type string">string</a></span> を指定する場合は、その長さでハッシュアルゴリズムを判断します。
       &quot;md5&quot; (32) あるいは &quot;sha1&quot; (40) のいずれかです。
      </p>
      <p class="para">
       <span class="type"><a href="language.types.array.php" class="type array">array</a></span> を指定する場合は、キーがハッシュアルゴリズムで、
       それに対応する値がダイジェストとなります。
      </p>
     </dd>
    
    
     <dt id="context.ssl.security-level">
      <code class="parameter">security_level</code>
      <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
     </dt>
     <dd>
      <p class="para">
       セキュリティレベルを設定します。
       指定されない場合、ライブラリのデフォルトのセキュリティレベルが使われます。
       セキュリティレベルについては、
       <a href="https://docs.openssl.org/master/man3/SSL_CTX_set_security_level/" class="link external">&raquo;&nbsp;SSL_CTX_get_security_level(3)</a>
       に説明があります。
      </p>
      <p class="para">
       PHP 7.2.0 および OpenSSL 1.1.0 以降が必要です。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 
 <div class="refsect1 changelog" id="refsect1-context.ssl-changelog">
  <h3 class="title">変更履歴</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>バージョン</th>
       <th>説明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>7.2.0</td>
       <td>
        <code class="parameter">security_level</code> が追加されました。
        OpenSSL &gt;= 1.1.0 が必要です。
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-context.ssl-notes">
  <h3 class="title">注意</h3>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
    <code class="literal">ssl://</code> は
    <a href="wrappers.http.php" class="link"><code class="literal">https://</code></a> および
    <a href="wrappers.ftp.php" class="link"><code class="literal">ftps://</code></a> のラッパーの
    基盤となるものなので、<code class="literal">ssl://</code> に適用可能なオプションは
    <code class="literal">https://</code> および <code class="literal">ftps://</code> にも
    適用可能です。
   </span>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <span class="simpara">
    SNI (Server Name Indication) を使うには、PHP のコンパイル時に
    OpenSSL 0.9.8j 以降を使わなければなりません。SNI をサポートしているかどうかは
    <strong><code><a href="openssl.constsni.php#constant.openssl-tlsext-server-name">OPENSSL_TLSEXT_SERVER_NAME</a></code></strong> で判定します。
   </span>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-context.ssl-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><a href="context.socket.php" class="xref">ソケットコンテキストオプション</a></li>
   </ul>
  </p>
 </div>


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