libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent
#include <libssh2.h> int libssh2_agent_userauth(LIBSSH2_AGENT *agent, const char *username, struct libssh2_agent_publickey *identity);
libssh2 manual libssh2_agent_userauth(3ssh2)
NAME
libssh2_agent_userauth - authenticate a session with a public key, with
the help of ssh-agent
SYNOPSIS
#include <libssh2.h>
int libssh2_agent_userauth(LIBSSH2_AGENT *agent,
const char *username,
struct libssh2_agent_publickey *identity);
DESCRIPTION
agent - ssh-agent handle as returned by libssh2_agent_init(3)
username - Remote user name to authenticate as.
identity - Public key to authenticate with, as returned by lib-
ssh2_agent_get_identity(3)
Attempt public key authentication with the help of ssh-agent.
RETURN VALUE
Returns 0 if succeeded, or a negative value for error.
AVAILABILITY
Added in libssh2 1.2
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | library/libssh2 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
SEE ALSO
libssh2_agent_init(3) libssh2_agent_get_identity(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 1.2 23 Dec 2009
libssh2_agent_userauth(3ssh2)