ssh2_auth_pubkey_file
(PECL ssh2 >= 0.9.0)
ssh2_auth_pubkey_file — Authenticate using a public key
Description
bool ssh2_auth_pubkey_file
( resource $session
, string $username
, string $pubkeyfile
, string $privkeyfile
[, string $passphrase
] )
Authenticate using a public key read from a file.
Parameters
- session
-
An SSH connection link identifier, obtained from a call to ssh2_connect().
- username
-
- pubkeyfile
-
- privkeyfile
-
- passphrase
-
If privkeyfile is encrypted (which it should be), the passphrase must be provided.
Return Values
Returns TRUE on success or FALSE on failure.
Examples
Example #1 Authentication using a public key
<?php
$connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa'));
if (ssh2_auth_pubkey_file($connection, 'username',
'/home/username/.ssh/id_rsa.pub',
'/home/username/.ssh/id_rsa', 'secret')) {
echo "Public Key Authentication Successful\n";
} else {
die('Public Key Authentication Failed');
}
?>