<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Authenticate over SSH using a plain password</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-auth-none.html">ssh2_auth_none</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-auth-pubkey-file.html">ssh2_auth_pubkey_file</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ssh2-auth-password" class="refentry">
<div class="refnamediv">
<h1 class="refname">ssh2_auth_password</h1>
<p class="verinfo">(PECL ssh2 >= 0.9.0)</p><p class="refpurpose"><span class="refname">ssh2_auth_password</span> — <span class="dc-title">Authenticate over SSH using a plain password</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ssh2-auth-password-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ssh2_auth_password</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$session</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$username</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
)</div>
<p class="para rdfs-comment">
Authenticate over SSH using a plain password. Since version 0.12 this function
also supports keyboard_interactive method.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ssh2-auth-password-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">session</code></em></span>
<dd>
<p class="para">
An SSH connection link identifier, obtained from a call to
<span class="function"><a href="function.ssh2-connect.html" class="function">ssh2_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">username</code></em></span>
<dd>
<p class="para">
Remote user name.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">password</code></em></span>
<dd>
<p class="para">
Password for <em><code class="parameter">username</code></em>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ssh2-auth-password-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ssh2-auth-password-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4608">
<p><strong>Example #1 Authenticating with a password</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$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 />if (</span><span style="color: #0000BB">ssh2_auth_password</span><span style="color: #007700">(</span><span style="color: #0000BB">$connection</span><span style="color: #007700">, </span><span style="color: #DD0000">'username'</span><span style="color: #007700">, </span><span style="color: #DD0000">'secret'</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Authentication Successful!\n"</span><span style="color: #007700">;<br />} else {<br /> die(</span><span style="color: #DD0000">'Authentication Failed...'</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ssh2-auth-none.html">ssh2_auth_none</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ssh2-auth-pubkey-file.html">ssh2_auth_pubkey_file</a></div>
<div class="up"><a href="ref.ssh2.html">SSH2 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
