aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2020-03-23 10:33:05 +0100
committerAndreas Schneider <asn@cryptomilk.org>2020-03-23 15:03:25 +0100
commit3e5dc99198274a670450342801ac7631ddf2fba2 (patch)
tree361c0aa541776935427daaf7f5e385c69deee12e /include
parentc8222dc1f64621112a6bb309cab3c995fcfe3c6b (diff)
downloadlibssh-3e5dc99198274a670450342801ac7631ddf2fba2.tar.gz
libssh-3e5dc99198274a670450342801ac7631ddf2fba2.tar.xz
libssh-3e5dc99198274a670450342801ac7631ddf2fba2.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>
Diffstat (limited to 'include')
-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 d1ddffdc..7b96541a 100644
--- a/include/libssh/libssh.h
+++ b/include/libssh/libssh.h
@@ -637,7 +637,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.
@@ -652,6 +658,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)