lib/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2025-11-29 01:03:57 +03:00
Code Activity

auth: Fix ssh_userauth_kbdint*() documentation.

Browse Source 
Thanks to Arto Karppinen.
This commit is contained in:
Andreas Schneider
2012-07-17 17:53:07 +02:00
parent 8624651de3
commit e8cebc2a37
1 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/auth.c
View File

@@ -1913,8 +1913,9 @@ int ssh_userauth_kbdint(ssh_session session, const char *user,
/** /**
* @brief Get the number of prompts (questions) the server has given. * @brief Get the number of prompts (questions) the server has given.
* *
* You have called ssh_userauth_kbdint() and got SSH_AUTH_INFO. This * Once you have called ssh_userauth_kbdint() and received SSH_AUTH_INFO return
* function returns the questions from the server. * code, this function can be used to retrieve information about the keyboard
* interactive authentication questions sent by the remote host.
* *
* @param[in] session The ssh session to use. * @param[in] session The ssh session to use.
* *
@@ -1933,8 +1934,9 @@ int ssh_userauth_kbdint_getnprompts(ssh_session session) {
/** /**
* @brief Get the "name" of the message block. * @brief Get the "name" of the message block.
* *
* You have called ssh_userauth_kbdint() and got SSH_AUTH_INFO. This * Once you have called ssh_userauth_kbdint() and received SSH_AUTH_INFO return
* function returns the questions from the server. * code, this function can be used to retrieve information about the keyboard
* interactive authentication questions sent by the remote host.
* *
* @param[in] session The ssh session to use. * @param[in] session The ssh session to use.
* *
@@ -1953,8 +1955,9 @@ const char *ssh_userauth_kbdint_getname(ssh_session session) {
/** /**
* @brief Get the "instruction" of the message block. * @brief Get the "instruction" of the message block.
* *
* You have called ssh_userauth_kbdint() and got SSH_AUTH_INFO. This * Once you have called ssh_userauth_kbdint() and received SSH_AUTH_INFO return
* function returns the questions from the server. * code, this function can be used to retrieve information about the keyboard
* interactive authentication questions sent by the remote host.
* *
* @param[in] session The ssh session to use. * @param[in] session The ssh session to use.
* *
@@ -1974,8 +1977,9 @@ const char *ssh_userauth_kbdint_getinstruction(ssh_session session) {
/** /**
* @brief Get a prompt from a message block. * @brief Get a prompt from a message block.
* *
* You have called ssh_userauth_kbdint() and got SSH_AUTH_INFO. This * Once you have called ssh_userauth_kbdint() and received SSH_AUTH_INFO return
* function returns the questions from the server. * code, this function can be used to retrieve information about the keyboard
* interactive authentication questions sent by the remote host.
* *
* @param[in] session The ssh session to use. * @param[in] session The ssh session to use.
* *