libssh2_userauth_publickey_fromfile_ex - authenticate a session with a public key, read from a file
#include <libssh2.h> int libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session, const char *username, unsigned int ousername_len, const char *publickey, const char *privatekey, const char *passphrase);
libssh2 manual libssh2_userauth_publickey_fromfile(3ssh2)
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,
unsigned int ousername_len,
const char *publickey,
const char *privatekey,
const char *passphrase);
DESCRIPTION
session - Session instance as returned by libssh2_session_init_ex(3)
username - Pointer to user name to authenticate as.
username_len - Length of username.
publickey - Path name of the public key file. (e.g.
/etc/ssh/hostkey.pub). If libssh2 is built against OpenSSL, this option
can be set to NULL.
privatekey - Path name of the private key file. (e.g. /etc/ssh/hostkey)
passphrase - Passphrase to use when decoding privatekey.
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 LIB-
SSH2_ERROR_EAGAIN when it would otherwise block. While LIB-
SSH2_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 combina-
tion was invalid.
LIBSSH2_ERROR_AUTHENTICATION_FAILED - Authentication using the supplied
public key was not accepted.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_session_init_ex(3)
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://www.libssh2.org/download/lib-
ssh2-1.10.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.libssh2.org/.
libssh2 0.15 1 Jun 2007
libssh2_userauth_publickey_fromfile(3ssh2)