Home/ Manual/ ssh2 / functions/ ssh2_auth_agent

ssh2_auth_agent

PHP function Edit on GitHub ✎

(PECL ssh2 >= 0.12)

Authenticate over SSH using the ssh agent

Description

ssh2_auth_agent(resource $session, string $username): bool

Authenticate over SSH using the ssh agent

Note

The ssh2_auth_agent() function will only be available when the ssh2 extension is compiled with libssh2 >= 1.2.3.

Parameters

session: An SSH connection link identifier, obtained from a call to ssh2_connect().
username: Remote user name.

Return Values

Success

Examples

Authenticating with a ssh agent

php

<?php
$connection = ssh2_connect('shell.example.com', 22);

if (ssh2_auth_agent($connection, 'username')) {
  echo "Authentication Successful!\n";
} else {
  die('Authentication Failed...');
}
?>

Source: reference/ssh2/functions/ssh2-auth-agent.xml · from the official PHP manual (php/doc-en)