aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2020-03-23 10:33:05 +0100
committerAndreas Schneider <asn@cryptomilk.org>2020-03-27 13:15:26 +0100
commit316f46f8332c8a86be0d9bddca41026c367505fc (patch)
tree6afe7f401160414a52974a16d3f899a7ad06b33d
parent0dd71375e7fe3ba80a225ffb4304319a756aee78 (diff)
downloadlibssh-316f46f8332c8a86be0d9bddca41026c367505fc.tar.gz
libssh-316f46f8332c8a86be0d9bddca41026c367505fc.tar.xz
libssh-316f46f8332c8a86be0d9bddca41026c367505fc.zip
doc: Add SSH auth callback to libssh_auth doc group
Fixes T217 Signed-off-by: Andreas Schneider <asn@cryptomilk.org> Reviewed-by: Jakub Jelen <jjelen@redhat.com> (cherry picked from commit 3e5dc99198274a670450342801ac7631ddf2fba2)
-rw-r--r--include/libssh/libssh.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/include/libssh/libssh.h b/include/libssh/libssh.h
index e7de48de..79030131 100644
--- a/include/libssh/libssh.h
+++ b/include/libssh/libssh.h
@@ -633,7 +633,13 @@ LIBSSH_API ssh_pcap_file ssh_pcap_file_new(void);
LIBSSH_API int ssh_pcap_file_open(ssh_pcap_file pcap, const char *filename);
/**
- * @brief SSH authentication callback.
+ * @addtogroup libssh_auth
+ *
+ * @{
+ */
+
+/**
+ * @brief SSH authentication callback for password and publickey auth.
*
* @param prompt Prompt to be displayed.
* @param buf Buffer to save the password. You should null-terminate it.
@@ -648,6 +654,8 @@ LIBSSH_API int ssh_pcap_file_open(ssh_pcap_file pcap, const char *filename);
typedef int (*ssh_auth_callback) (const char *prompt, char *buf, size_t len,
int echo, int verify, void *userdata);
+/** @} */
+
LIBSSH_API ssh_key ssh_key_new(void);
#define SSH_KEY_FREE(x) \
do { if ((x) != NULL) { ssh_key_free(x); x = NULL; } } while(0)