[PHP-DOC] cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-hostbased-file.xml

[Sara Golemon]

pollita         Mon Feb 14 19:04:10 2005 EDT

  Added files:                 
    /phpdoc/en/reference/ssh2/functions ssh2-auth-hostbased-file.xml 
  Log:
  New function
  

http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
  <refentry id="function.ssh2-auth-hostbased-file">
   <refnamediv>
    <refname>ssh2_auth_hostbased_file</refname>
    <refpurpose>
     Authenticate using a public hostkey
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>bool</type><methodname>ssh2_auth_hostbased_file</methodname>
     
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
     
<methodparam><type>string</type><parameter>username</parameter></methodparam>
     
<methodparam><type>string</type><parameter>hostname</parameter></methodparam>
     
<methodparam><type>string</type><parameter>pubkeyfile</parameter></methodparam>
     
<methodparam><type>string</type><parameter>privkeyfile</parameter></methodparam>
     <methodparam 
choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
     <methodparam 
choice="opt"><type>string</type><parameter>local_username</parameter></methodparam>
    </methodsynopsis>

    <simpara>
     Authenticate using a public hostkey read from a file.  If 
<parameter>privkeyfile</parameter>
     is encrypted (which it should be), the passphrase must be provided.
     If <parameter>local_username</parameter> is omitted, then the value for
     <parameter>username</parameter> will be used for it.
    </simpara>

    <example>
     <title>Authentication using a public hostkey</title>
     <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22, 
array('hostkey'=>'ssh-rsa'));

if (ssh2_auth_hostbased_file($connection, 'remoteusername', 
'myhost.example.com',
                             '/usr/local/etc/hostkey_rsa.pub',
                             '/usr/local/etc/hostkey_rsa', 'secret',
                             'localusername')) {
  echo "Public Key Hostbased Authentication Successful\n";
} else {
  die('Public Key Hostbased Authentication Failed');
}
?>
]]>
     </programlisting>
    </example>

    <note>
     <simpara>
      <function>ssh2_auth_hostbased_file</function> requires libssh2 >= 0.7 and 
PHP/SSH2 >= 0.7
     </simpara>
    </note>

   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->