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