summaryrefslogtreecommitdiffstats
path: root/src/auth.c
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2012-07-17 17:57:49 +0200
committerAndreas Schneider <asn@cryptomilk.org>2012-07-17 18:04:55 +0200
commit8ef45e00c7dbb5d35f26cb23676d7988e8f833df (patch)
tree6a9a46a3d8d8660271fbff3c98e53404d4c55998 /src/auth.c
parente8cebc2a374e1aa982a7c5eb8bef7a3e7419ed89 (diff)
downloadlibssh-8ef45e00c7dbb5d35f26cb23676d7988e8f833df.tar.gz
libssh-8ef45e00c7dbb5d35f26cb23676d7988e8f833df.tar.xz
libssh-8ef45e00c7dbb5d35f26cb23676d7988e8f833df.zip
auth: Improve ssh_userauth_kbdint_setanswer() documentation.
Thanks to Arto Karppinen.
Diffstat (limited to 'src/auth.c')
-rw-r--r--src/auth.c6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/auth.c b/src/auth.c
index 04543e0..e699f60 100644
--- a/src/auth.c
+++ b/src/auth.c
@@ -2065,7 +2065,11 @@ const char *ssh_userauth_kbdint_getanswer(ssh_session session, unsigned int i) {
*
* @param[in] i index The number of the ith prompt.
*
- * @param[in] answer The answer to give to the server.
+ * @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.
*
* @return 0 on success, < 0 on error.
*/