PHP マニュアル: SSH の認証を、ssh agent を使って行う

説明

bool ssh2_auth_agent(resource $session, string $username)

SSH の認証を、ssh agent を使って行います。

注意: ssh2_auth_agent 関数が使えるのは、 ssh2 拡張モジュールのコンパイルに libssh >= 1.2.3 を使った場合だけです。

パラメータ

session: SSH 接続リンク ID。 ssh2_connect を呼んで取得したもの。
username: リモートのユーザー名。

戻り値

成功した場合に true を、失敗した場合に false を返します。

例

例1 ssh agent による認証

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

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