Home/ Manual/ ssh2 / functions/ ssh2_auth_password

ssh2_auth_password

PHP function Edit on GitHub ✎

(PECL ssh2 >= 0.9.0)

Authenticate 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

Success

Examples

Authenticating with a password

php

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

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

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