ssh2_auth_hostbased_file
PHP function
Edit on GitHub ✎
(PECL ssh2 >= 0.9.0)
Authenticate using a public hostkey
Description
ssh2_auth_hostbased_file(resource $session, string $username, string $hostname, string $pubkeyfile, string $privkeyfile, [string $passphrase], [string $local_username]): bool
Authenticate using a public hostkey read from a file.
Parameters
sessionAn SSH connection link identifier, obtained from a call to
ssh2_connect().usernamehostnamepubkeyfileprivkeyfilepassphraseIf
privkeyfileis encrypted (which it should be), the passphrase must be provided.local_usernameIf
local_usernameis omitted, then the value forusernamewill be used for it.
Return Values
Success
Examples
Authentication using a public hostkey
php
<?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');
}
?>Notes
Note
ssh2_auth_hostbased_file() requires libssh2 >= 0.7 and PHP/SSH2 >= 0.7