Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

libssh2_session_method_pref (3ssh2)

Name

libssh2_session_method_pref - set preferred key exchange method

Synopsis

#include <libssh2.h>

int     libssh2_session_method_pref(LIBSSH2_SESSION    *session,    int
method_type, const char *prefs);

Description

libssh2 manual                              libssh2_session_method_pref(3ssh2)



NAME
       libssh2_session_method_pref - set preferred key exchange method

SYNOPSIS
       #include <libssh2.h>

       int     libssh2_session_method_pref(LIBSSH2_SESSION    *session,    int
       method_type, const char *prefs);


DESCRIPTION
       session - Session instance as returned by libssh2_session_init_ex(3)

       method_type - One of the Method Type constants.

       prefs - Coma delimited list of preferred methods to use with  the  most
       preferred  listed  first  and  the  least  preferred listed last.  If a
       method is listed which is not supported by libssh2 it will  be  ignored
       and not sent to the remote host during protocol negotiation.

       Set  preferred  methods to be negotiated. These preferences must be set
       prior to calling libssh2_session_handshake(3) as they are  used  during
       the protocol initiation phase.


RETURN VALUE
       Return   0  on  success  or  negative  on  failure.   It  returns  LIB-
       SSH2_ERROR_EAGAIN  when  it   would   otherwise   block.   While   LIB-
       SSH2_ERROR_EAGAIN  is  a negative number, it isn't really a failure per
       se.


ERRORS
       LIBSSH2_ERROR_INVAL - The requested method type was invalid.

       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.

       LIBSSH2_ERROR_METHOD_NOT_SUPPORTED - The requested method is  not  sup-
       ported.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/libssh2  |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       libssh2_session_init_ex(3) libssh2_session_handshake(3)



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source   was   downloaded  from   https://www.libssh2.org/download/lib-
       ssh2-1.10.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.libssh2.org/.



libssh2 0.15                      1 Jun 2007
                                            libssh2_session_method_pref(3ssh2)