array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.ssh2-auth-agent.php', 1 => 'ssh2_auth_agent', ), 'up' => array ( 0 => 'ref.ssh2.php', 1 => 'SSH2 Functions', ), 'prev' => array ( 0 => 'ref.ssh2.php', 1 => 'SSH2 Functions', ), 'next' => array ( 0 => 'function.ssh2-auth-hostbased-file.php', 1 => 'ssh2_auth_hostbased_file', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ssh2/functions/ssh2-auth-agent.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PECL ssh2 >= 0.12)
ssh2_auth_agent — Authenticate over SSH using the ssh agent
Authenticate over SSH using the ssh agent
Note: The ssh2_auth_agent() function will only be available when the ssh2 extension is compiled with libssh >= 1.2.3.
session
An SSH connection link identifier, obtained from a call to ssh2_connect().
username
Remote user name.
Example #1 Authenticating with a ssh agent
<?php
$connection = ssh2_connect('shell.example.com', 22);
if (ssh2_auth_agent($connection, 'username')) {
echo "Authentication Successful!\n";
} else {
die('Authentication Failed...');
}
?>