From e3eacef1350208bd242a304d54b56e448cd84ff8 Mon Sep 17 00:00:00 2001
From: Sara Golemon <pollita@php.net>
Date: Tue, 15 Feb 2005 00:04:09 +0000
Subject: [PATCH] New function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@179800 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/ssh2-auth-hostbased-file.xml    | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 reference/ssh2/functions/ssh2-auth-hostbased-file.xml

diff --git a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
new file mode 100644
index 0000000000..8e136abb12
--- /dev/null
+++ b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
@@ -0,0 +1,78 @@
+<?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
+-->