Manual Reference Pages  - libssh2_userauth_publickey_fromfile (3)

NAME

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

CONTENTS

Synopsis
Description
Return Value
Errors
See Also

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 libssh2_userauth_publickey_fromfile (3) 1 Jun 2007
blog comments powered by Disqus