shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-11 10:40:27 +09:00
Code Issues Packages Projects Releases Wiki Activity

libsshpp: Match documentation with the code

Browse Source 
Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
This commit is contained in:
Andreas Schneider
2018-08-21 11:48:03 +02:00
parent c2fc9ac956
commit 49f92cf5cd
1 changed files with 28 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
include/libssh/libsshpp.hpp
View File

@@ -195,11 +195,20 @@ public:
return ret; return ret;
} }
/** @brief Authenticate through the "keyboard-interactive" method. /**
* @param[in] The username to authenticate. You can specify NULL if ssh_option_set_username() has been used. You cannot try two different logins in a row. * @brief Authenticate through the "keyboard-interactive" method.
* @param[in] Undocumented. Set it to NULL. *
* @param[in] username The username to authenticate. You can specify NULL if
* ssh_option_set_username() has been used. You cannot
* try two different logins in a row.
*
* @param[in] submethods Undocumented. Set it to NULL.
*
* @throws SshException on error * @throws SshException on error
* @returns SSH_AUTH_SUCCESS, SSH_AUTH_PARTIAL, SSH_AUTH_DENIED, SSH_AUTH_ERROR, SSH_AUTH_INFO, SSH_AUTH_AGAIN *
* @returns SSH_AUTH_SUCCESS, SSH_AUTH_PARTIAL, SSH_AUTH_DENIED,
* SSH_AUTH_ERROR, SSH_AUTH_INFO, SSH_AUTH_AGAIN
*
* @see ssh_userauth_kbdint * @see ssh_userauth_kbdint
*/ */
int userauthKbdint(const char* username, const char* submethods){ int userauthKbdint(const char* username, const char* submethods){
@@ -216,15 +225,25 @@ public:
return ssh_userauth_kbdint_getnprompts(c_session); return ssh_userauth_kbdint_getnprompts(c_session);
} }
/** @brief Set the answer for a question from a message block.. /**
* @param[in] index The number of the ith prompt. * @brief Set the answer for a question from a message block.
* @param[in] The answer to give to the server. The answer MUST be encoded UTF-8. It is up to the server how to interpret the value and validate it. However, if you read the answer in some other encoding, you MUST convert it to UTF-8. *
* @param[in] index The index number of the prompt.
* @param[in] answer The answer to give to the server. The answer MUST be
* encoded UTF-8. It is up to the server how to interpret
* the value and validate it. However, if you read the
* answer in some other encoding, you MUST convert it to
* UTF-8.
*
* @throws SshException on error * @throws SshException on error
*
* @returns 0 on success, < 0 on error * @returns 0 on success, < 0 on error
*
* @see ssh_userauth_kbdint_setanswer * @see ssh_userauth_kbdint_setanswer
*/ */
int userauthKbdintSetAnswer(unsigned int i, const char* answer){ int userauthKbdintSetAnswer(unsigned int index, const char *answer)
int ret=ssh_userauth_kbdint_setanswer(c_session, i, answer); {
int ret = ssh_userauth_kbdint_setanswer(c_session, index, answer);
ssh_throw(ret); ssh_throw(ret);
return ret; return ret;
} }