SSH2_AUTH_HOSTBASED_FILE(3) 1 SSH2_AUTH_HOSTBASED_FILE(3)
ssh2_auth_hostbased_file - Authenticate using a public hostkey
SYNOPSIS
bool ssh2_auth_hostbased_file (resource $session, string $username, string $hostname, string $pubkeyfile, string $privkeyfile, [string
$passphrase], [string $local_username])
DESCRIPTION
Authenticate using a public hostkey read from a file.
PARAMETERS
o $session
- An SSH connection link identifier, obtained from a call to ssh2_connect(3).
o $username
-
o $hostname
-
o $pubkeyfile
-
o $privkeyfile
-
o $passphrase
- If $privkeyfile is encrypted (which it should be), the passphrase must be provided.
o $local_username
- If $local_username is omitted, then the value for $username will be used for it.
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
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
";
} else {
die('Public Key Hostbased Authentication Failed');
}
?>
NOTES
Note
ssh2_auth_hostbased_file(3) requires libssh2 >= 0.7 and PHP/SSH2 >= 0.7
PHP Documentation Group SSH2_AUTH_HOSTBASED_FILE(3)