Linux Manuals session 3

libssh2_channel_get_exit_signal – get the remote exit signal Synopsis#include <libssh2.h> int libssh2_channel_get_exit_signal(LIBSSH2_CHANNEL *channel, char **exitsignal, size_t *exitsignal_len, char **errmsg, size_t *errmsg_len, char **langtag, size_t *langtag_len); Descriptionchannel – Closed channel stream to retrieve exit signal from. exitsignal – If not NULL, is populated by reference with the exit signal (without leading "SIG"). Note that the string is…

libssh2_channel_free – free all resources associated with a channel Synopsis#include <libssh2.h> int libssh2_channel_free(LIBSSH2_CHANNEL *channel); Descriptionchannel – Channel stream to free. Release all resources associated with a channel stream. If the channel has not yet been closed with libssh2_channel_close(3) , it will be called automatically so that the remote end may know that it can safely…

libssh2_channel_forward_listen_ex – listen to inbound connections Synopsis#include <libssh2.h> LIBSSH2_LISTENER * libssh2_channel_forward_listen_ex(LIBSSH2_SESSION *session, char *host, int port, int *bound_port, int queue_maxsize); LIBSSH2_LISTENER * libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); DescriptionInstruct the remote SSH server to begin listening for inbound TCP/IP connections. New connections will be queued by the library until accepted by libssh2_channel_forward_accept(3). session – instance as returned…

libssh2_channel_forward_listen – convenience macro for libssh2_channel_forward_listen_ex(3) calls Synopsis#include <libssh2.h> int libssh2_channel_forward_listen(LIBSSH2_SESSION *session, int port); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_forward_listen_ex(3). Return ValueSee libssh2_channel_forward_listen_ex(3) ErrorsSee libssh2_channel_forward_listen_ex(3) See Alsolibssh2_channel_forward_listen_ex(3)

libssh2_channel_forward_cancel – cancel a forwarded TCP port Synopsis#include <libssh2.h> int libssh2_channel_forward_cancel(LIBSSH2_LISTENER *listener); Descriptionlistener – Forwarding listener instance as returned by libssh2_channel_forward_listen_ex(3) Instruct the remote host to stop listening for new connections on a previously requested host/port. Return ValueReturn 0 on success or negative on failure. It returns LIBSSH2_ERROR_EAGAIN when it would otherwise block. While LIBSSH2_ERROR_EAGAIN…

libssh2_channel_forward_accept – accept a queued connection Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_channel_forward_accept(LIBSSH2_LISTENER *listener); Descriptionlistener is a forwarding listener instance as returned by libssh2_channel_forward_listen_ex(3). Return ValueA newly allocated channel instance or NULL on failure. ErrorsWhen this function returns NULL use libssh2_session_last_errno(3) to extract the error code. If that code is LIBSSH2_ERROR_EAGAIN, the session is set to do…

libssh2_channel_flush_stderr – convenience macro for libssh2_channel_flush_ex(3) calls Synopsis#include <libssh2.h> int libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_flush_ex(3). Return ValueSee libssh2_channel_flush_ex(3) ErrorsSee libssh2_channel_flush_ex(3) See Alsolibssh2_channel_flush_ex(3)

libssh2_channel_flush_ex – flush a channel Synopsis#include <libssh2.h> int libssh2_channel_flush_ex(LIBSSH2_CHANNEL *channel, int streamid); int libssh2_channel_flush(LIBSSH2_CHANNEL *channel); int libssh2_channel_flush_stderr(LIBSSH2_CHANNEL *channel); Descriptionchannel – Active channel stream to flush. streamid – Specific substream number to flush. Groups of substreams may be flushed by passing on of the following Constants. LIBSSH2_CHANNEL_FLUSH_EXTENDED_DATA: Flush all extended data substreams LIBSSH2_CHANNEL_FLUSH_ALL: Flush all substreams…

libssh2_channel_flush – convenience macro for libssh2_channel_flush_ex(3) calls Synopsis#include <libssh2.h> int libssh2_channel_flush(LIBSSH2_CHANNEL *channel); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_flush_ex(3). Return ValueSee libssh2_channel_flush_ex(3) ErrorsSee libssh2_channel_flush_ex(3) See Alsolibssh2_channel_flush_ex(3)

libssh2_channel_exec – convenience macro for libssh2_channel_process_startup(3) calls Synopsis#include <libssh2.h> int libssh2_channel_exec(LIBSSH2_CHANNEL *channel, const char *command); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_process_startup(3). Return ValueSee libssh2_channel_process_startup(3) ErrorsSee libssh2_channel_process_startup(3) See Alsolibssh2_channel_process_startup(3)

libssh2_channel_eof – check a channel’s EOF status Synopsis#include <libssh2.h> int libssh2_channel_eof(LIBSSH2_CHANNEL *channel); Descriptionchannel – active channel stream to set closed status on. Check if the remote host has sent an EOF status for the selected stream. Return ValueReturns 1 if the remote host has sent EOF, otherwise 0. Negative on failure. See Alsolibssh2_channel_close(3)

libssh2_channel_direct_tcpip_ex – Tunnel a TCP connection through an SSH session Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_channel_direct_tcpip_ex(LIBSSH2_SESSION *session, const char *host, int port, const char *shost, int sport); LIBSSH2_CHANNEL * libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) host – Third party host to connect to using the SSH host…

libssh2_channel_direct_tcpip – convenience macro for libssh2_channel_direct_tcpip_ex(3) calls Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_channel_direct_tcpip(LIBSSH2_SESSION *session, const char *host, int port); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_channel_direct_tcpip_ex(3). Return ValueSee libssh2_channel_direct_tcpip_ex(3) ErrorsSee libssh2_channel_direct_tcpip_ex(3) See Alsolibssh2_channel_direct_tcpip_ex(3)

libssh2_channel_close – close a channel Synopsis#include <libssh2.h> int libssh2_channel_close(LIBSSH2_CHANNEL *channel); Descriptionchannel – active channel stream to set closed status on. Close an active data channel. In practice this means sending an SSH_MSG_CLOSE packet to the remote host which serves as instruction that no further data will be sent to it. The remote host may still…

libssh2_base64_decode – decode a base64 encoded string Synopsis#include <libssh2.h> int libssh2_base64_decode(LIBSSH2_SESSION *session, char **dest,                     unsigned int *dest_len, const char *src,                     unsigned int src_len); DescriptionThis function is deemed DEPRECATED and will be removed from libssh2 in a future version. Don’t use it! Decode a base64 chunk and store it into a newly allocated buffer. ‘dest_len’ will be set…

libssh2_banner_set – set the SSH prococol banner for the local client Synopsis#include <libssh2.h> int libssh2_banner_set(LIBSSH2_SESSION *session, const char *banner); DescriptionThis function is DEPRECATED. Use libssh2_session_banner_set(3) instead! session – Session instance as returned by libssh2_session_init_ex(3) banner – A pointer to a user defined banner Set the banner that will be sent to the remote host when…

libssh2_agent_userauth – authenticate a session with a public key, with the help of ssh-agent Synopsis#include <libssh2.h> int libssh2_agent_userauth(LIBSSH2_AGENT *agent,                      const char *username,                      struct libssh2_agent_publickey *identity); Descriptionagent – ssh-agent handle as returned by libssh2_agent_init(3) username – Remote user name to authenticate as. identity – Public key to authenticate with, as returned by libssh2_agent_get_identity(3) Attempt public key authentication with…

libssh2_agent_list_identities – request an ssh-agent to list of public keys. Synopsis#include <libssh2.h> int libssh2_agent_list_identities(LIBSSH2_AGENT *agent); DescriptionRequest an ssh-agent to list of public keys, and stores them in the internal collection of the handle. Call libssh2_agent_get_identity(3) to get a public key off the collection. Return ValueReturns 0 if succeeded, or a negative value for error. AvailabilityAdded…

libssh2_agent_init – init an ssh-agent handle Synopsis#include <libssh2.h> LIBSSH2_AGENT *libssh2_agent_init(LIBSSH2_SESSION *session); DescriptionInit an ssh-agent handle. Returns the handle to an internal representation of an ssh-agent connection. After the successful initialization, an application can call libssh2_agent_connect(3) to connect to a running ssh-agent. Call libssh2_agent_free(3) to free the handle again after you’re doing using it. Return ValueReturns…

libssh2_agent_get_identity – get a public key off the collection of public keys managed by ssh-agent Synopsis#include <libssh2.h> int libssh2_agent_get_identity(LIBSSH2_AGENT *agent,                          struct libssh2_agent_publickey **store,                          struct libssh2_agent_publickey *prev); Descriptionlibssh2_agent_get_identity(3) allows an application to iterate over all public keys in the collection managed by ssh-agent. store should point to a pointer that gets filled in to point to the public…