libssh2/share/man/man3/libssh2_userauth_password_ex.3

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