<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/wrappers.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'wrappers.ssh2.php',
    1 => 'ssh2://',
    2 => 'Secure Shell 2',
  ),
  'up' => 
  array (
    0 => 'wrappers.php',
    1 => 'サポートするプロトコル/ラッパー',
  ),
  'prev' => 
  array (
    0 => 'wrappers.phar.php',
    1 => 'phar://',
  ),
  'next' => 
  array (
    0 => 'wrappers.rar.php',
    1 => 'rar://',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'language/wrappers/ssh2.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="wrappers.ssh2" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ssh2://</h1>
  <p class="refpurpose"><span class="refname">ssh2://</span> &mdash; <span class="dc-title">Secure Shell 2</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-wrappers.ssh2-description">
  <h3 class="title">説明</h3>
  <p class="para">
   <var class="filename">ssh2.shell://</var>
   <var class="filename">ssh2.exec://</var>
   <var class="filename">ssh2.tunnel://</var>
   <var class="filename">ssh2.sftp://</var>
   <var class="filename">ssh2.scp://</var>
   （PECL）
  </p>

  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <strong>このラッパーはデフォルトでは有効になっていません</strong><br />
   <span class="simpara">
    <var class="filename">ssh2.*://</var> ラッパーを使用するには、
    <a href="https://pecl.php.net/" class="link external">&raquo;&nbsp;PECL</a> から
    <a href="https://pecl.php.net/package/ssh2" class="link external">&raquo;&nbsp;SSH2</a> 拡張モジュールを
    インストールする必要があります。
   </span>
  </p></blockquote>

  <p class="simpara">
   ssh2 ラッパーでは、URL のホスト部分に接続リソースを渡すことで既にオープン
   している接続を再利用することが可能です。
  </p>
 </div>


 <div class="refsect1 usage" id="refsect1-wrappers.ssh2-usage"> 
  <h3 class="title">利用法</h3>
  <ul class="itemizedlist">
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.shell://user:pass@example.com:22/xterm</var></span></li>
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.exec://user:pass@example.com:22/usr/local/bin/somecmd</var></span></li>
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.tunnel://user:pass@example.com:22/192.168.0.1:14</var></span></li>
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.sftp://user:pass@example.com:22/path/to/filename</var></span></li>
  </ul>
 </div>
 

 <div class="refsect1 options" id="refsect1-wrappers.ssh2-options">
  <h3 class="title">オプション</h3>
  <p class="para">
   <table class="doctable table">
    <caption><strong>ラッパーの概要</strong></caption>
    
     <thead>
      <tr>
       <th>属性</th>
       <th>ssh2.shell</th>
       <th>ssh2.exec</th>
       <th>ssh2.tunnel</th>
       <th>ssh2.sftp</th>
       <th>ssh2.scp</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><a href="filesystem.configuration.php#ini.allow-url-fopen" class="link">allow_url_fopen</a> で制約される</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
      </tr>

      <tr>
       <td>読み込み許可</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
      </tr>

      <tr>
       <td>書き込み許可</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>No</td>
      </tr>

      <tr>
       <td>追加許可</td>
       <td>No</td>
       <td>No</td>
       <td>No</td>
       <td>Yes（サーバーがサポートしている場合）</td>
       <td>No</td>
      </tr>

      <tr>
       <td>同時読み書き許可</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>Yes</td>
       <td>No</td>
      </tr>

      <tr>
       <td><span class="function"><a href="function.stat.php" class="function">stat()</a></span> のサポート</td>
       <td>No</td>
       <td>No</td>
       <td>No</td>
       <td>Yes</td>
       <td>No</td>
      </tr>

      <tr>
       <td><span class="function"><a href="function.unlink.php" class="function">unlink()</a></span> のサポート</td>
       <td>No</td>
       <td>No</td>
       <td>No</td>
       <td>Yes</td>
       <td>No</td>
      </tr>

      <tr>
       <td><span class="function"><a href="function.rename.php" class="function">rename()</a></span> のサポート</td>
       <td>No</td>
       <td>No</td>
       <td>No</td>
       <td>Yes</td>
       <td>No</td>
      </tr>

      <tr>
       <td><span class="function"><a href="function.mkdir.php" class="function">mkdir()</a></span> のサポート</td>
       <td>No</td>
       <td>No</td>
       <td>No</td>
       <td>Yes</td>
       <td>No</td>
      </tr>

      <tr>
       <td><span class="function"><a href="function.rmdir.php" class="function">rmdir()</a></span> のサポート</td>
       <td>No</td>
       <td>No</td>
       <td>No</td>
       <td>Yes</td>
       <td>No</td>
      </tr>

     </tbody>
    
   </table>

  </p>


  
  <p class="para">
   <table class="doctable table">
    <caption><strong>コンテキストオプション</strong></caption>
    
     <thead>
      <tr>
       <th>名前</th>
       <th>使用法</th>
       <th>デフォルト</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">session</code></td>
       <td>再利用する接続済みの ssh2 リソース</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">sftp</code></td>
       <td>再利用する割り当て済みの sftp リソース</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">methods</code></td>
       <td>Key exchange, hostkey, cipher, compression, および MAC methods</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">callbacks</code></td>
       <td class="empty">&nbsp;</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">username</code></td>
       <td>接続するユーザー名</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">password</code></td>
       <td>パスワード認証に使用するパスワード</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">pubkey_file</code></td>
       <td>認証に使用する公開鍵ファイル</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">privkey_file</code></td>
       <td>認証に使用する秘密鍵ファイル</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">env</code></td>
       <td>設定する環境変数の連想配列</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term</code></td>
       <td>pty を割り当てる際の端末エミュレート方式</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_width</code></td>
       <td>pty を割り当てる際の端末の幅</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_height</code></td>
       <td>pty を割り当てる際の端末の高さ</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_units</code></td>
       <td>term_width および term_height の単位</td>
       <td><strong><code><a href="ssh2.constants.php#constant.ssh2-term-unit-chars">SSH2_TERM_UNIT_CHARS</a></code></strong></td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>
 

 <div class="refsect1 examples" id="refsect1-wrappers.ssh2-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 アクティブな接続からストリームをオープンする</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ssh2_auth_pubkey_file</span><span style="color: #007700">(</span><span style="color: #0000BB">$session</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/home/username/.ssh/id_rsa.pub'</span><span style="color: #007700">,<br />                                            </span><span style="color: #DD0000">'/home/username/.ssh/id_rsa'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stream </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"ssh2.tunnel://</span><span style="color: #0000BB">$session</span><span style="color: #DD0000">/remote.example.com:1234"</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>例2 <var class="varname">$session</var> を有効にしておかないといけない!</strong></p>
   <div class="example-contents"><p>
    <var class="filename">ssh2.*://$session</var> ラッパーを使うには、
    リソース変数 <var class="varname">$session</var> をキープしておかないといけません。
    次のコードは、期待通りには動きません。
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$session </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">ssh2_auth_pubkey_file</span><span style="color: #007700">(</span><span style="color: #0000BB">$session</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/home/username/.ssh/id_rsa.pub'</span><span style="color: #007700">,<br />                                            </span><span style="color: #DD0000">'/home/username/.ssh/id_rsa'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$connection_string </span><span style="color: #007700">= </span><span style="color: #DD0000">"ssh2.sftp://</span><span style="color: #0000BB">$session</span><span style="color: #DD0000">/"</span><span style="color: #007700">;<br />unset(</span><span style="color: #0000BB">$session</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stream </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection_string </span><span style="color: #007700">. </span><span style="color: #DD0000">"path/to/file"</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>
    この例では、unset() のところでセッションを閉じてしまいます。
    なぜなら、<var class="varname">$connection_string</var> が持つのが <var class="varname">$session</var>
    への参照ではなく、単にそれを文字列にキャストしたものだからです。
    これは、<span class="function"><a href="function.unset.php" class="function">unset()</a></span> が暗黙のうちに呼ばれた場合にも起こりえます
    (関数などの) スコープを抜けるときに発生する可能性があります。
   </p></div>
  </div>

 </div>


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