src/vendor/libssh2-sys/libssh2/docs/libssh2_agent_userauth.3

   1 .\"
   2 .\" Copyright (c) 2009 by Daiki Ueno
   3 .\"
   4 .TH libssh2_agent_userauth 3 "23 Dec 2009" "libssh2 1.2" "libssh2 manual"
   5 .SH NAME
   6 libssh2_agent_userauth - authenticate a session with a public key, with the help of ssh-agent
   7 .SH SYNOPSIS
   8 #include <libssh2.h>
   9
  10 int libssh2_agent_userauth(LIBSSH2_AGENT *agent,
  11                            const char *username,
  12                            struct libssh2_agent_publickey *identity);
  13 .SH DESCRIPTION
  14 \fIagent\fP - ssh-agent handle as returned by
  15 .BR libssh2_agent_init(3)
  16
  17 \fIusername\fP - Remote user name to authenticate as.
  18
  19 \fIidentity\fP - Public key to authenticate with, as returned by
  20 .BR libssh2_agent_get_identity(3)
  21
  22 Attempt public key authentication with the help of ssh-agent.
  23 .SH RETURN VALUE
  24 Returns 0 if succeeded, or a negative value for error.
  25 .SH AVAILABILITY
  26 Added in libssh2 1.2
  27 .SH SEE ALSO
  28 .BR libssh2_agent_init(3)
  29 .BR libssh2_agent_get_identity(3)