International PHP Conference Berlin 2025

ssh2_auth_password

(PECL ssh2 >= 0.9.0)

ssh2_auth_passwordAuthenticate over SSH using a plain password

Description

ssh2_auth_password(resource $session, string $username, string $password): bool

Authenticate over SSH using a plain password. Since version 0.12 this function also supports keyboard_interactive method.

Parameters

session

An SSH connection link identifier, obtained from a call to ssh2_connect().

username

Remote user name.

password

Password for username

Return Values

Returns true on success or false on failure.

Examples

Example #1 Authenticating with a password

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

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

add a note

User Contributed Notes 1 note

up
0
sgchris at gmail dot com
9 years ago
Please note that the function ssh2_auth_password raises PHP warning(!) on bad authentication. To avoid the warning, use the "silence" ("@") operator.

<?php
$ssh
= ssh2_connect($host);
if (
false === $ssh) {
die(
'connection failed');
}

$auth = @ssh2_auth_password($ssh, $user, $password);
if (
false === $auth) {
die(
'authentication failed');
}
?>
To Top