php-doc-en/reference/ssh2/functions/ssh2-auth-none.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
  <refentry id="function.ssh2-auth-none">
   <refnamediv>
    <refname>ssh2_auth_none</refname>
    <refpurpose>
     Authenticate as "none"
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>mixed</type><methodname>ssh2_auth_none</methodname>
     <methodparam><type>resource</type><parameter>session</parameter></methodparam>
     <methodparam><type>string</type><parameter>username</parameter></methodparam>
    </methodsynopsis>

    <simpara>
     Attempt "none" authentication which usually will (and should) fail.
     As part of the failure, this function will return an array of accepted
     authentication methods.  If the server does accept "none" as an
     authentication method for <parameter>username</parameter>, this function
     will simply return &true;.
    </simpara>

    <example>
     <title>Using <function>ssh2_auth_none</function> to retreive
            a list of authentication methods.</title>
     <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);

$auth_methods = ssh2_auth_none($connection, 'user');

if (in_array('password', $auth_methods)) {
  echo "Server supports password based authentication\n";
}
?>
]]>
     </programlisting>
    </example>

   </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
-->