libssh2/share/man/man3/libssh2_userauth_list.3

   1 .\" $Id: libssh2_userauth_list.3,v 1.1 2007/06/14 17:15:32 jehousley Exp $
   2 .\"
   3 .TH libssh2_userauth_list 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_userauth_list - list the authentication methods supported by a server
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 char *
  10 libssh2_userauth_list(LIBSSH2_SESSION *session, const char *username, unsigned int username_len);
  11
  12 .SH DESCRIPTION
  13 \fIsession\fP - Session instance as returned by
  14 .BR libssh2_session_init(3)
  15
  16 \fIusername\fP - Username which will be used while authenticating. Note
  17 that most server implementations do not permit attempting authentication
  18 with different usernames between requests. Therefore this must be the
  19 same username you will use on later userauth calls.
  20
  21 \fIusername_len\fP - Length of username parameter.
  22
  23 Send a \fBSSH_USERAUTH_NONE\fP request to the remote host. Unless the
  24 remote host is configured to accept none as a viable authentication
  25 scheme (unlikely), it will return \fBSSH_USERAUTH_FAILURE\fB along with a
  26 listing of what authentication schemes it does support. In the unlikely
  27 event that none authentication succeeds, this method with return NULL. This
  28 case may be distinguished from faily by examining
  29 .BR libssh2_userauth_authenticated(3)
  30
  31 .SH RETURN VALUE
  32 On success a comma delimited list of supported authentication schemes.  This list is
  33 internally managed by libssh2.  On failure ruturns NULL.
  34
  35 .SH ERRORS
  36 \fILIBSSH2_ERROR_ALLOC\fP -  An internal memory allocation call failed.
  37
  38 \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
  39
  40 \fILIBSSH2_ERROR_EAGAIN\fP - Marked for non-blocking I/O but the call
  41
  42 .SH SEE ALSO
  43 .BR libssh2_session_init(3)