libssh2

1
.\" Copyright (C) The libssh2 project and its contributors.
2
.\" SPDX-License-Identifier: BSD-3-Clause
3
.TH libssh2_session_methods 3 "8 Nov 2021" "libssh2 1.11" "libssh2"
4
.SH NAME
5
libssh2_session_methods - return the currently active algorithms
6
.SH SYNOPSIS
7
.nf
8
#include <libssh2.h>
9

10
const char *
11
libssh2_session_methods(LIBSSH2_SESSION *session, int method_type);
12
.fi
13
.SH DESCRIPTION
14
\fIsession\fP - Session instance as returned by
15
.BR libssh2_session_init_ex(3)
16

17
\fImethod_type\fP - one of the method type constants: LIBSSH2_METHOD_KEX,
18
LIBSSH2_METHOD_HOSTKEY, LIBSSH2_METHOD_CRYPT_CS, LIBSSH2_METHOD_CRYPT_SC,
19
LIBSSH2_METHOD_MAC_CS, LIBSSH2_METHOD_MAC_SC, LIBSSH2_METHOD_COMP_CS,
20
LIBSSH2_METHOD_COMP_SC, LIBSSH2_METHOD_LANG_CS, LIBSSH2_METHOD_LANG_SC,
21
LIBSSH2_METHOD_SIGN_ALGO.
22

23
Returns the actual method negotiated for a particular transport parameter.
24
.SH RETURN VALUE
25
Negotiated method or NULL if the session has not yet been started.
26
.SH ERRORS
27
\fILIBSSH2_ERROR_INVAL\fP - The requested method type was invalid.
28

29
\fILIBSSH2_ERROR_METHOD_NONE\fP - no method has been set
30
.SH SEE ALSO
31
.BR libssh2_session_init_ex(3)
32