<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'wrappers.ssh2.php',
    1 => 'ssh2://',
    2 => 'Shell Seguro 2',
  ),
  'up' => 
  array (
    0 => 'wrappers.php',
    1 => 'Protocolos e empacotadores suportados',
  ),
  'prev' => 
  array (
    0 => 'wrappers.phar.php',
    1 => 'phar://',
  ),
  'next' => 
  array (
    0 => 'wrappers.rar.php',
    1 => 'rar://',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    '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">Shell Seguro 2</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-wrappers.ssh2-description">
  <h3 class="title">Descrição</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">Nota</strong>: 
   <strong>Este empacotador não é habilitado por padrão.</strong><br />
   <span class="simpara">
    Para utilizar os empacotadores <var class="filename">ssh2.*://</var>,
    a extensão
    <a href="https://pecl.php.net/package/ssh2" class="link external">&raquo;&nbsp;SSH2</a>
    disponível em <a href="https://pecl.php.net/" class="link external">&raquo;&nbsp;PECL</a> deve estar instalada.
   </span>
  </p></blockquote>

  <p class="simpara">
   Além de aceitar detalhes de login URI tradicionais, os empacotadores ssh2
   também farão reúso de conexões abertas através da passagem do recurso da conexão na
   parte do host da URL.
  </p>
 </div>


 <div class="refsect1 usage" id="refsect1-wrappers.ssh2-usage"> 
  <h3 class="title">Uso</h3>
  <ul class="itemizedlist">
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.shell://usuario:senha@example.com:22/xterm</var></span></li>
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.exec://usuario:senha@example.com:22/usr/local/bin/algumcomando</var></span></li>
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.tunnel://usuario:senha@example.com:22/192.168.0.1:14</var></span></li>
   <li class="listitem"><span class="simpara"><var class="filename">ssh2.sftp://usuario:senha@example.com:22/caminho/para/arquivo</var></span></li>
  </ul>
 </div>
 

 <div class="refsect1 options" id="refsect1-wrappers.ssh2-options">
  <h3 class="title">Opções</h3>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Sumário do Empacotador</strong></caption>
    
     <thead>
      <tr>
       <th>Atributo</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>Restrito por <a href="filesystem.configuration.php#ini.allow-url-fopen" class="link">allow_url_fopen</a></td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
      </tr>

      <tr>
       <td>Permite Leitura</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
      </tr>

      <tr>
       <td>Permite Escrita</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Não</td>
      </tr>

      <tr>
       <td>Permite Adição</td>
       <td>Não</td>
       <td>Não</td>
       <td>Não</td>
       <td>Sim (quando suportado pelo servidor)</td>
       <td>Não</td>
      </tr>

      <tr>
       <td>Permite Leitura e Escrita Simultâneas</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Sim</td>
       <td>Não</td>
      </tr>

      <tr>
       <td>Suporta <span class="function"><a href="function.stat.php" class="function">stat()</a></span></td>
       <td>Não</td>
       <td>Não</td>
       <td>Não</td>
       <td>Sim</td>
       <td>Não</td>
      </tr>

      <tr>
       <td>Suporta <span class="function"><a href="function.unlink.php" class="function">unlink()</a></span></td>
       <td>Não</td>
       <td>Não</td>
       <td>Não</td>
       <td>Sim</td>
       <td>Não</td>
      </tr>

      <tr>
       <td>Suporta <span class="function"><a href="function.rename.php" class="function">rename()</a></span></td>
       <td>Não</td>
       <td>Não</td>
       <td>Não</td>
       <td>Sim</td>
       <td>Não</td>
      </tr>

      <tr>
       <td>Suporta <span class="function"><a href="function.mkdir.php" class="function">mkdir()</a></span></td>
       <td>Não</td>
       <td>Não</td>
       <td>Não</td>
       <td>Sim</td>
       <td>Não</td>
      </tr>

      <tr>
       <td>Suporta <span class="function"><a href="function.rmdir.php" class="function">rmdir()</a></span></td>
       <td>Não</td>
       <td>Não</td>
       <td>Não</td>
       <td>Sim</td>
       <td>Não</td>
      </tr>

     </tbody>
    
   </table>

  </p>


  
  <p class="para">
   <table class="doctable table">
    <caption><strong>Opções de contexto</strong></caption>
    
     <thead>
      <tr>
       <th>Nome</th>
       <th>Uso</th>
       <th>Padrão</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">session</code></td>
       <td>Recurso ssh2 pré-conectado a ser reutilizado</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">sftp</code></td>
       <td>Recurso sftp pré-alocado a ser reutilizado</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">methods</code></td>
       <td>Métodos de troca de chaves, de chave de host, de cifras, de compressão e de MAC a serem usados</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>Nome de usuário a ser conectado</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">password</code></td>
       <td>Senha a ser usada com a autenticação</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">pubkey_file</code></td>
       <td>Nome do arquivo de chave pública a ser usado com a autenticação</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">privkey_file</code></td>
       <td>Nome do arquivo de chave privada a ser usado com a autenticação</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">env</code></td>
       <td>Array associativo de variáveis de ambiente a ser configurado</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term</code></td>
       <td>Tipo de emulação de terminal a ser requisitado quando da alocação de um pty</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_width</code></td>
       <td>Largura do terminal requisitado quando da alocação de um pty</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_height</code></td>
       <td>Altura do terminal requisitado quando da alocação de um pty</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_units</code></td>
       <td>Unidadem usadas em term_width e 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">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Abrindo um fluxo para conexão ativa</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>Exemplo #2 Esta variável <var class="varname">$session</var> deve ser mantida disponível!</strong></p>
   <div class="example-contents"><p>
    Para usar os empacotadores <var class="filename">ssh2.*://$session</var>,
    a variável de recurso <var class="varname">$session</var> deve ser mantida.
    O código abaixo não terá o efeito desejado:
   </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() fecha a sessão, porque <var class="varname">$connection_string</var> não
    contém uma referência à variável <var class="varname">$session</var>, somente uma string convertida
    derivada dela. Isto também acontece quando a função <span class="function"><a href="function.unset.php" class="function">unset()</a></span> está implícita
    devido a uma saída de escopo (como em uma função).
   </p></div>
  </div>

 </div>


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