ssh2_auth_hostbased_file(3) [php man page]

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)

libssh2_userauth_publickey_fromfile(3)				  libssh2 manual			    libssh2_userauth_publickey_fromfile(3)

NAME

       libssh2_userauth_publickey_fromfile - authenticate a session with a public key, read from a file

SYNOPSIS

       #include <libssh2.h>

       int libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session,
						  const char *username,
						  const char *publickey,
						  const char *privatekey,
						  const char *passphrase);

DESCRIPTION

       session - Session instance as returned by libssh2_session_init_ex(3)

       username - Remote user name to authenticate as.

       username_len - Length of username.

       publickey - Path and name of public key file. (e.g. /etc/ssh/hostkey.pub)

       privatekey - Path and name of private key file. (e.g. /etc/ssh/hostkey)

       passphrase - Passphrase to use when decoding private key file.

       Attempt public key authentication using a PEM encoded private key file stored on disk

RETURN VALUE

       Return 0 on success or negative on failure.  It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a
       negative number, it isn't really a failure per se.

ERRORS

       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.

       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

       LIBSSH2_ERROR_SOCKET_TIMEOUT -

       LIBSSH2_ERROR_PUBLICKEY_UNVERIFIED - The username/public key combination was invalid.

       LIBSSH2_ERROR_AUTHENTICATION_FAILED - Authentication using the supplied public key was not accepted.

SEE ALSO

       libssh2_session_init_ex(3)

libssh2 0.15							    1 Jun 2007				    libssh2_userauth_publickey_fromfile(3)