<?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 => 'fr',
  ),
  'this' => 
  array (
    0 => 'wrappers.ssh2.php',
    1 => 'ssh2://',
    2 => 'Shell s&eacute;curis&eacute; 2',
  ),
  'up' => 
  array (
    0 => 'wrappers.php',
    1 => 'Liste des protocoles et des gestionnaires support&eacute;s',
  ),
  'prev' => 
  array (
    0 => 'wrappers.phar.php',
    1 => 'phar://',
  ),
  'next' => 
  array (
    0 => 'wrappers.rar.php',
    1 => 'rar://',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    '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 sécurisé 2</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-wrappers.ssh2-description">
  <h3 class="title">Description</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">Note</strong>: 
   <strong>Cette enveloppe n&#039;est pas activée par défaut</strong><br />
   <span class="simpara">
    Pour utiliser l&#039;enveloppe <var class="filename">ssh2://</var>,
    l&#039;extension <a href="https://pecl.php.net/package/ssh2" class="link external">&raquo;&nbsp;SSH2</a>
    disponible sur <a href="https://pecl.php.net/" class="link external">&raquo;&nbsp;PECL</a> doit être installée.
   </span>
  </p></blockquote>

  <p class="simpara">
   En plus d&#039;accepter les identifications traditionnelles via l&#039;URI,
   l&#039;enveloppe ssh2 réutilisera les connexions ouvertes en passant la ressource
   de connexion dans la partie hôte de l&#039;URL.
  </p>
 </div>


 <div class="refsect1 usage" id="refsect1-wrappers.ssh2-usage"> 
  <h3 class="title">Utilisation</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">Options</h3>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Résumé de l&#039;enveloppe</strong></caption>
    
     <thead>
      <tr>
       <th>Attribut</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>Restreint par <a href="filesystem.configuration.php#ini.allow-url-fopen" class="link">allow_url_fopen</a></td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
      </tr>

      <tr>
       <td>Autorise la lecture</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
      </tr>

      <tr>
       <td>Autorise l&#039;écriture</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Non</td>
      </tr>

      <tr>
       <td>Autorise l&#039;ajout</td>
       <td>Non</td>
       <td>Non</td>
       <td>Non</td>
       <td>Oui (lorsque supporté par le serveur)</td>
       <td>Non</td>
      </tr>

      <tr>
       <td>Autorise la lecture et l&#039;écriture simultanément</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Oui</td>
       <td>Non</td>
      </tr>

      <tr>
       <td>Support de la fonction <span class="function"><a href="function.stat.php" class="function">stat()</a></span></td>
       <td>Non</td>
       <td>Non</td>
       <td>Non</td>
       <td>Oui</td>
       <td>Non</td>
      </tr>

      <tr>
       <td>Support de la fonction <span class="function"><a href="function.unlink.php" class="function">unlink()</a></span></td>
       <td>Non</td>
       <td>Non</td>
       <td>Non</td>
       <td>Oui</td>
       <td>Non</td>
      </tr>

      <tr>
       <td>Support de la fonction <span class="function"><a href="function.rename.php" class="function">rename()</a></span></td>
       <td>Non</td>
       <td>Non</td>
       <td>Non</td>
       <td>Oui</td>
       <td>Non</td>
      </tr>

      <tr>
       <td>Support de la fonction <span class="function"><a href="function.mkdir.php" class="function">mkdir()</a></span></td>
       <td>Non</td>
       <td>Non</td>
       <td>Non</td>
       <td>Oui</td>
       <td>Non</td>
      </tr>

      <tr>
       <td>Support de la fonction <span class="function"><a href="function.rmdir.php" class="function">rmdir()</a></span></td>
       <td>Non</td>
       <td>Non</td>
       <td>Non</td>
       <td>Oui</td>
       <td>Non</td>
      </tr>

     </tbody>
    
   </table>

  </p>


  
  <p class="para">
   <table class="doctable table">
    <caption><strong>Options de contexte</strong></caption>
    
     <thead>
      <tr>
       <th>Nom</th>
       <th>Utilisation</th>
       <th>Défaut</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">session</code></td>
       <td>ressource ssh2 pré-connectée à réutiliser</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">sftp</code></td>
       <td>ressource sftp pré-allouée à réutiliser</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">methods</code></td>
       <td>méthodes d&#039;échange de clés, hostkey, cipher, compression, et MAC, à utiliser</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>Nom de l&#039;utilisateur pour la connexion</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">password</code></td>
       <td>Mot de passe à utiliser lors d&#039;une identification par mot de passe</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">pubkey_file</code></td>
       <td>Nom du fichier contenant la clé publique à utiliser lors de l&#039;identification</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">privkey_file</code></td>
       <td>Nom du fichier contenant la clé privée à utiliser lors de l&#039;identification</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">env</code></td>
       <td>Tableau associatif de variables d&#039;environnement à définir</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term</code></td>
       <td>Type d&#039;émulation de terminal à demander lors de l&#039;allocation d&#039;un pty</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_width</code></td>
       <td>Largeur du terminal à demander lors de l&#039;allocation d&#039;un pty</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_height</code></td>
       <td>Hauteur du terminal à demander lors de l&#039;allocation d&#039;un pty</td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">term_units</code></td>
       <td>Unités à utiliser avec term_width et 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">Exemples</h3>
  <div class="example" id="example-1">
   <p><strong>Exemple #1 Ouverture d&#039;un flux depuis une connexion active</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>Exemple #2 La variable <var class="varname">$session</var> doit rester disponible !</strong></p>
   <div class="example-contents"><p>
    Afin d&#039;utiliser l&#039;enveloppe <var class="filename">ssh2.*://$session</var>,
    la variable de ressource <var class="varname">$session</var> doit être conservée. 
    Le code ci-dessous n&#039;aura pas l&#039;effet escompté :
   </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>
    La fonction unset() clôt la session, car la variable <var class="varname">$connection_string</var>
    ne contient pas de référence à la variable <var class="varname">$session</var>, mais uniquement
    une chaîne dérivée. Ceci survient également lorsque la fonction
    <span class="function"><a href="function.unset.php" class="function">unset()</a></span> est implicite, lors d&#039;une sortie du scope (comme dans une
    fonction).
   </p></div>
  </div>

 </div>


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