ssh2_auth_hostbased_file

(PECL ssh2 >= 0.9.0)
Authenticate using a public hostkey
bool ssh2_auth_hostbased_file ( resource $session, string $username, string $hostname, string $pubkeyfile, string $privkeyfile [, string $passphrase [, string $local_username ]] )

Authenticate using a public hostkey read from a file.

Parameters:
session

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

username

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

hostname

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

pubkeyfile

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

privkeyfile

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

passphrase

If privkeyfile is encrypted (which it should be), the passphrase must be provided.

local_username

If local_username is omitted, then the value for username will be used for it.

Returns:

Returns TRUE on success or FALSE on failure.

Notes:

ssh2_auth_hostbased_file() requires libssh2 >= 0.7 and PHP/SSH2 >= 0.7

Examples:
Authentication using a public hostkey
<?php
$connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa'));

if (ssh2_auth_hostbased_file($connection, 'remoteusername', 'myhost.example.com',
                             '/usr/local/etc/hostkey_rsa.pub',
                             '/usr/local/etc/hostkey_rsa', 'secret',
                             'localusername')) {
  echo "Public Key Hostbased Authentication Successful\n";
} else {
  die('Public Key Hostbased Authentication Failed');
}
?>

doc_php
2016-02-24 16:10:06
Comments
Leave a Comment

Please login to continue.