<!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 the ssh agent</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.ssh2.html">SSH2 Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-auth-hostbased-file.html">ssh2_auth_hostbased_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-agent" class="refentry"> <div class="refnamediv"> <h1 class="refname">ssh2_auth_agent</h1> <p class="verinfo">(PECL ssh2 >= 0.12)</p><p class="refpurpose"><span class="refname">ssh2_auth_agent</span> — <span class="dc-title">Authenticate over SSH using the ssh agent</span></p> </div> <div class="refsect1 description" id="refsect1-function.ssh2-auth-agent-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>ssh2_auth_agent</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> )</div> <p class="para rdfs-comment"> Authenticate over SSH using the ssh agent </p> <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara"> The <span class="function"><strong>ssh2_auth_agent()</strong></span> function will only be available when the ssh2 extension is compiled with libssh >= 1.2.3. </span> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-function.ssh2-auth-agent-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> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ssh2-auth-agent-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-agent-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4605"> <p><strong>Example #1 Authenticating with a ssh agent</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_agent</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">)) {<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="ref.ssh2.html">SSH2 Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ssh2-auth-hostbased-file.html">ssh2_auth_hostbased_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>