generic-library/ssh2
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

keyboard-interactive man page: cleaned up

Browse Source
This commit is contained in:
Daniel Stenberg 2011-06-29 20:49:35 +02:00
parent 733bf877f8
commit dadc05fdfd
1 changed files with 36 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
docs/libssh2_userauth_keyboard_interactive_ex.3
View File

@ -2,44 +2,59 @@
.\" .\"
.TH libssh2_userauth_keyboard_interactive_ex 3 "8 Mar 2008" "libssh2 0.19" "libssh2 manual" .TH libssh2_userauth_keyboard_interactive_ex 3 "8 Mar 2008" "libssh2 0.19" "libssh2 manual"
.SH NAME .SH NAME
libssh2_userauth_keyboard_interactive_ex - authenticate a session using a challenge-response authentication libssh2_userauth_keyboard_interactive_ex - authenticate a session using
keyboard-interactive authentication
.SH SYNOPSIS .SH SYNOPSIS
.nf
#include <libssh2.h> #include <libssh2.h>
int int
libssh2_userauth_keyboard_interactive_ex(LIBSSH2_SESSION *session, const char *username, unsigned int username_len, LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback)); libssh2_userauth_keyboard_interactive_ex(LIBSSH2_SESSION *session,
const char *username,
int unsigned int username_len,
libssh2_userauth_keyboard_interactive(LIBSSH2_SESSION *session, const char *username, LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback)); LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback));
.SH DESCRIPTION .SH DESCRIPTION
\fIsession\fP - Session instance as returned by \fIsession\fP - Session instance as returned by
.BR libssh2_session_init_ex(3) \fIlibssh2_session_init_ex(3)\fP.
\fIusername\fP - Name of user to attempt plain password authentication for. \fIusername\fP - Name of user to attempt keyboard-interactive authentication
for.
\fIusername_len\fP - Length of username parameter. \fIusername_len\fP - Length of username parameter.
\fIresponse_callback\fP - As authentication proceeds, host issues several (1 or more) challenges and requires responses. This callback will be called at this moment. Callback is responsible to obtain responses for the challenges, fill the provided data structure and then return control. Responses will be sent to the host. String values will be free(3)ed by the library. \fIresponse_callback\fP - As authentication proceeds, the host issues several
(1 or more) challenges and requires responses. This callback will be called at
this moment. The callback is responsible to obtain responses for the
challenges, fill the provided data structure and then return
control. Responses will be sent to the host. String values will be free(3)ed
by the library. The callback prototype must match this:
.nf
void response(const char *name,
int name_len, const char *instruction,
int instruction_len,
int num_prompts,
const LIBSSH2_USERAUTH_KBDINT_PROMPT *prompts,
LIBSSH2_USERAUTH_KBDINT_RESPONSE *responses,
void **abstract);
.fi
Attempts keyboard-interactive (challenge/response) authentication. Attempts keyboard-interactive (challenge/response) authentication.
Note that many SSH servers will always issue single "password" challenge, Note that many SSH servers will always issue a single "password" challenge,
requesting actual password as response, but it is not required by the protocol, requesting actual password as response, but it is not required by the
and various authentication schemes, such as smartcard authentication may use protocol, and various authentication schemes, such as smartcard authentication
keyboard-interactive authentication type too. may use keyboard-interactive authentication type too.
.SH RETURN VALUE .SH RETURN VALUE
Return 0 on success or negative on failure. It returns Return 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN
LIBSSH2_ERROR_EAGAIN when it would otherwise block. While when it would otherwise block. While LIBSSH2_ERROR_EAGAIN is a negative
LIBSSH2_ERROR_EAGAIN is a negative number, it isn't really a failure per se. number, it isn't really a failure per se.
.SH ERRORS .SH ERRORS
\fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed. \fILIBSSH2_ERROR_ALLOC\fP - An internal memory allocation call failed.
\fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket. \fILIBSSH2_ERROR_SOCKET_SEND\fP - Unable to send data on socket.
\fLIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/password or public/private key. \fLIBSSH2_ERROR_AUTHENTICATION_FAILED\fP - failed, invalid username/password
or public/private key.
.SH SEE ALSO .SH SEE ALSO
.BR libssh2_session_init_ex(3) .BR libssh2_session_init_ex(3)