Current File : //usr/man/man3ssh2/libssh2_userauth_publickey_fromfile_ex.3ssh2

'\" te
.TH libssh2_userauth_publickey_fromfile 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
.SH NAME
libssh2_userauth_publickey_fromfile - authenticate a session with a public key, read from a file
.SH SYNOPSIS
#include <libssh2.h>

.nf
int libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session,
                                           const char *username,
                                           const char *publickey,
                                           const char *privatekey,
                                           const char *passphrase);
.SH DESCRIPTION
\fIsession\fP - Session instance as returned by 
.BR libssh2_session_init_ex(3)

\fIusername\fP - Remote user name to authenticate as.

\fIusername_len\fP - Length of username.

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

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

\fIpassphrase\fP - Passphrase to use when decoding private key file.

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

.SH 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.

.SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.

\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.

\fILIBSSH2_ERROR_SOCKET_TIMEOUT\fP - 

\fILIBSSH2_ERROR_PUBLICKEY_UNVERIFIED\fP - The username/public key
combination was invalid.

\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - Authentication using the supplied
public key was not accepted.


.\" Oracle has added the ARC stability level to this manual page
.SH ATTRIBUTES
See
.BR attributes (5)
for descriptions of the following attributes:
.sp
.TS
box;
cbp-1 | cbp-1
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE 
=
Availability	library/libssh2
=
Stability	Uncommitted
.TE 
.PP
.SH SEE ALSO
.BR libssh2_session_init_ex(3)


.SH NOTES

.\" Oracle has added source availability information to this manual page
This software was built from source available at https://java.net/projects/solaris-userland.  The original community source was downloaded from  http://www.libssh2.org/download/libssh2-1.4.2.tar.gz

Further information about this software can be found on the open source community website at http://www.libssh2.org/.