libssh2_userauth_password_ex.3 (2225B)
1.TH libssh2_userauth_password_ex 3 "1 Jun 2007" "libssh2 0.15" "libssh2" 2.SH NAME 3libssh2_userauth_password_ex - authenticate a session with username and password 4.SH SYNOPSIS 5.nf 6#include <libssh2.h> 7 8int 9libssh2_userauth_password_ex(LIBSSH2_SESSION *session, 10 const char *username, 11 unsigned int username_len, 12 const char *password, 13 unsigned int password_len, 14 LIBSSH2_PASSWD_CHANGEREQ_FUNC((*passwd_change_cb))); 15 16#define libssh2_userauth_password(session, username, password) \\ 17 libssh2_userauth_password_ex((session), (username), \\ 18 strlen(username), \\ 19 (password), strlen(password), NULL) 20.fi 21.SH DESCRIPTION 22\fIsession\fP - Session instance as returned by 23.BR libssh2_session_init_ex(3) 24 25\fIusername\fP - Name of user to attempt plain password authentication for. 26 27\fIusername_len\fP - Length of username parameter. 28 29\fIpassword\fP - Password to use for authenticating username. 30 31\fIpassword_len\fP - Length of password parameter. 32 33\fIpasswd_change_cb\fP - If the host accepts authentication but 34requests that the password be changed, this callback will be issued. 35If no callback is defined, but server required password change, 36authentication will fail. 37 38Attempt basic password authentication. Note that many SSH servers 39which appear to support ordinary password authentication actually have 40it disabled and use Keyboard Interactive authentication (routed via 41PAM or another authentication backed) instead. 42.SH RETURN VALUE 43Return 0 on success or negative on failure. It returns 44LIBSSH2_ERROR_EAGAIN when it would otherwise block. While 45LIBSSH2_ERROR_EAGAIN is a negative number, it is not really a failure per se. 46.SH ERRORS 47Some of the errors this function may return include: 48 49\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. 50 51\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. 52 53\fILIBSSH2_ERROR_PASSWORD_EXPIRED\fP - 54 55\fILIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/password 56or public/private key. 57.SH SEE ALSO 58.BR libssh2_session_init_ex(3)