<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ssh2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.ssh2-fingerprint.php',
    1 => 'ssh2_fingerprint',
    2 => 'Retrieve fingerprint of remote server',
  ),
  'up' => 
  array (
    0 => 'ref.ssh2.php',
    1 => 'SSH2 Functions',
  ),
  'prev' => 
  array (
    0 => 'function.ssh2-fetch-stream.php',
    1 => 'ssh2_fetch_stream',
  ),
  'next' => 
  array (
    0 => 'function.ssh2-forward-accept.php',
    1 => 'ssh2_forward_accept',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ssh2/functions/ssh2-fingerprint.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ssh2-fingerprint" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ssh2_fingerprint</h1>
  <p class="verinfo">(PECL ssh2 &gt;= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_fingerprint</span> &mdash; <span class="dc-title">Retrieve fingerprint of remote server</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ssh2-fingerprint-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ssh2_fingerprint</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$session</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = SSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX</span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="simpara">
   Returns a server hostkey hash from an active session.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ssh2-fingerprint-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">session</code></dt>
    <dd>
     <span class="simpara">
      An SSH connection link identifier, obtained from a call to
      <span class="function"><a href="function.ssh2-connect.php" class="function">ssh2_connect()</a></span>.
     </span>
    </dd>
   
   
    <dt><code class="parameter">flags</code></dt>
    <dd>
     <span class="simpara">
      <code class="parameter">flags</code> may be either of
      <strong><code><a href="ssh2.constants.php#constant.ssh2-fingerprint-md5">SSH2_FINGERPRINT_MD5</a></code></strong> or
      <strong><code><a href="ssh2.constants.php#constant.ssh2-fingerprint-sha1">SSH2_FINGERPRINT_SHA1</a></code></strong> logically ORed with
      <strong><code><a href="ssh2.constants.php#constant.ssh2-fingerprint-hex">SSH2_FINGERPRINT_HEX</a></code></strong> or
      <strong><code><a href="ssh2.constants.php#constant.ssh2-fingerprint-raw">SSH2_FINGERPRINT_RAW</a></code></strong>.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ssh2-fingerprint-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns the hostkey hash as a string.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.ssh2-fingerprint-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 Checking the fingerprint against a known value</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$known_host </span><span style="color: #007700">= </span><span style="color: #DD0000">'6F89C2F0A719B30CC38ABDF90755F2E4'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$connection </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">'shell.example.com'</span><span style="color: #007700">, </span><span style="color: #0000BB">22</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$fingerprint </span><span style="color: #007700">= </span><span style="color: #0000BB">ssh2_fingerprint</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">,<br />               </span><span style="color: #0000BB">SSH2_FINGERPRINT_MD5 </span><span style="color: #007700">| </span><span style="color: #0000BB">SSH2_FINGERPRINT_HEX</span><span style="color: #007700">);<br /><br />if (</span><span style="color: #0000BB">$fingerprint </span><span style="color: #007700">!= </span><span style="color: #0000BB">$known_host</span><span style="color: #007700">) {<br />  die(</span><span style="color: #DD0000">"HOSTKEY MISMATCH!\n" </span><span style="color: #007700">.<br />      </span><span style="color: #DD0000">"Possible Man-In-The-Middle Attack?"</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


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