aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorAndreas Schneider <asn@cryptomilk.org>2016-11-06 11:29:02 +0100
committerAndreas Schneider <asn@cryptomilk.org>2016-11-06 11:29:02 +0100
commit293ab4bd40eade73e21c6a6e963814a226613c77 (patch)
tree5cd59de1ea9a9b5fdff307520157dd8e5c010dc9 /include
parenta45db022e968a09b76012866d379e128fd6a4937 (diff)
downloadlibssh-293ab4bd40eade73e21c6a6e963814a226613c77.tar.gz
libssh-293ab4bd40eade73e21c6a6e963814a226613c77.tar.xz
libssh-293ab4bd40eade73e21c6a6e963814a226613c77.zip
doc: Improve documentation for ssh_set_auth_methods()
Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
Diffstat (limited to 'include')
-rw-r--r--include/libssh/server.h17
1 files changed, 17 insertions, 0 deletions
diff --git a/include/libssh/server.h b/include/libssh/server.h
index 6564f7c7..ec09f2f8 100644
--- a/include/libssh/server.h
+++ b/include/libssh/server.h
@@ -193,6 +193,23 @@ LIBSSH_API int ssh_handle_key_exchange(ssh_session session);
*/
LIBSSH_API void ssh_bind_free(ssh_bind ssh_bind_o);
+/**
+ * @brief Set the acceptable authentication methods to be sent to the client.
+ *
+ *
+ * @param[in] session The server session
+ *
+ * @param[in] auth_methods The authentication methods we will support, which
+ * can be bitwise-or'd.
+ *
+ * Supported methods are:
+ *
+ * SSH_AUTH_METHOD_PASSWORD
+ * SSH_AUTH_METHOD_PUBLICKEY
+ * SSH_AUTH_METHOD_HOSTBASED
+ * SSH_AUTH_METHOD_INTERACTIVE
+ * SSH_AUTH_METHOD_GSSAPI_MIC
+ */
LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
/**********************************************************