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

doc: Improve documentation for ssh_set_auth_methods()

Signed-off-by: Andreas Schneider <asn@cryptomilk.org>
This commit is contained in:
Andreas Schneider
2016-11-06 11:29:02 +01:00
parent a45db022e9
commit 293ab4bd40
2 changed files with 17 additions and 6 deletions

View File

@@ -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); 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); LIBSSH_API void ssh_set_auth_methods(ssh_session session, int auth_methods);
/********************************************************** /**********************************************************

View File

@@ -557,12 +557,6 @@ static int ssh_server_kex_termination(void *s){
return 1; return 1;
} }
/** Set the acceptable authentication methods to be sent to
* client.
* @param[in] session the SSH server session
* @param[in] auth_methods Bitfield of authentication methods
* to be accepted, e.g. SSH_AUTH_METHOD_PUBLICKEY
*/
void ssh_set_auth_methods(ssh_session session, int auth_methods){ void ssh_set_auth_methods(ssh_session session, int auth_methods){
/* accept only methods in range */ /* accept only methods in range */
session->auth_methods = auth_methods & 0x3f; session->auth_methods = auth_methods & 0x3f;