libssh2_session_supported_algs(3) [debian man page]

libssh2_session_supported_algs(3)				  libssh2 manual				 libssh2_session_supported_algs(3)

NAME

       libssh2_session_supported_algs - get list of supported algorithms

SYNOPSIS

       #include <libssh2.h>

       int libssh2_session_supported_algs(LIBSSH2_SESSION* session,
					  int method_type,
					  const char*** algs);

DESCRIPTION

       session	- An instance of initialized LIBSSH2_SESSION (the function will use its pointer to the memory allocation function).  method_type -
       Method type. See .BR libssh2_session_method_pref(3).  algs - Address of a pointer that will point to an array af returned algorithms

       Get a list of supported algorithms for the given method_type. The method_type  parameter  is  equivalent  to  method_type  in  libssh2_ses-
       sion_method_pref(3).  If successful, the function will allocate the appropriate amount of memory. When not needed anymore, it must be deal-
       located by calling libssh2_free(3). When this function is unsuccessful, this must not be done.

       In order to get a list of all supported compression algorithms, libssh2_session_flag(session,  LIBSSH2_FLAG_COMPRESS,  1)  must	be  called
       before calling this function, otherwise only "none" will be returned.

       If  successful, the function will allocate and fill the array with supported algorithms (the same names as defined in RFC 4253).  The array
       is not NULL terminated.

EXAMPLE

       #include "libssh2.h"

       const char **algorithms;
       int rc, i;
       LIBSSH2_SESSION *session;

       /* initilize session */
       session = libssh2_session_init();
       rc = libssh2_session_supported_algs(session,
					   LIBSSH2_METHOD_CRYPT_CS,
					   &algorithms);
       if (rc>0) {
	   /* the call succeeded, do sth. with the list of algorithms
	      (e.g. list them)... */
	   printf("Supported symmetric algorithms:0);
	   for ( i=0; i<rc; i++ )
	       printf("%s0, algorithms[i]);

	   /* ... and free the allocated memory when not needed anymore */
	   libssh2_free(session, algorithms);
       }
       else {
	   /* call failed, error handling */
       }

RETURN VALUE

       On success, a number of returned algorithms (i.e a positive number will be returned).  In case of a failure, an error code (a negative num-
       ber, see below) is returned.  0 should never be returned.

ERRORS

       LIBSSH2_ERROR_BAD_USE - Invalid address of algs.

       LIBSSH2_ERROR_METHOD_NOT_SUPPORTED -  Unknown method type.

       LIBSSH2_ERROR_INVAL - Internal error (normally should not occur).

       LIBSSH2_ERROR_ALLOC - Allocation of memory failed.

AVAILABILITY

       Added in 1.4.0

SEE ALSO

       libssh2_session_methods(3), libssh2_session_method_pref(3) libssh2_free(3)

libssh2 1.4.0							    23 Oct 2011 				 libssh2_session_supported_algs(3)

Check Out this Related Man Page

libssh2_channel_open_ex(3)					  libssh2 manual					libssh2_channel_open_ex(3)

NAME

       libssh2_channel_open_ex - establish a generic session channel

SYNOPSIS

       #include <libssh2.h>

       LIBSSH2_CHANNEL	*  libssh2_channel_open_ex(LIBSSH2_SESSION *session, const char *channel_type, unsigned int channel_type_len, unsigned int
       window_size, unsigned int packet_size, const char *message, unsigned int message_len);

       LIBSSH2_CHANNEL * libssh2_channel_open_session(session);

DESCRIPTION

       session - Session instance as returned by libssh2_session_init_ex(3)

       channel_type - Channel type to open. Typically one of session, direct-tcpip, or tcpip-forward. The SSH2	protocol  allowed  for	additional
       types including local, custom channel types.

       channel_type_len - Length of channel_type

       window_size  -  Maximum	amount	of  unacknowledged  data  remote host is allowed to send before receiving an SSH_MSG_CHANNEL_WINDOW_ADJUST
       packet.

       packet_size - Maximum number of bytes remote host is allowed to send in	a  single  SSH_MSG_CHANNEL_DATA  or  SSG_MSG_CHANNEL_EXTENDED_DATA
       packet.

       message - Additional data as required by the selected channel_type.

       message_len - Length of message parameter.

       Allocate  a  new  channel  for  exchanging  data with the server. This method is typically called through its macroized form: libssh2_chan-
       nel_open_session(3) or via libssh2_channel_direct_tcpip(3) or libssh2_channel_forward_listen(3)

RETURN VALUE

       Pointer to a newly allocated LIBSSH2_CHANNEL instance, or NULL on errors.

ERRORS

       LIBSSH2_ERROR_ALLOC -  An internal memory allocation call failed.

       LIBSSH2_ERROR_SOCKET_SEND - Unable to send data on socket.

       LIBSSH2_ERROR_CHANNEL_FAILURE -

       LIBSSH2_ERROR_EAGAIN - Marked for non-blocking I/O but the call would block.

SEE ALSO

       Add related functions

libssh2 0.15							    1 Jun 2007						libssh2_channel_open_ex(3)

Linux and UNIX Man Pages

libssh2_session_supported_algs(3) [debian man page]

Check Out this Related Man Page