libssh2_session_flag – TODO Synopsisint libssh2_session_flag(LIBSSH2_SESSION *session, int flag, int value); DescriptionSet options for the created session. flag is the option to set, while value is typically set to 1 or 0 to enable or disable the option. FlagsLIBSSH2_FLAG_SIGPIPE If set, libssh2 will not attempt to block SIGPIPEs but will let them trigger from the underlying…
libssh2_session_disconnect_ex – terminate transport layer Synopsis#include <libssh2.h> int libssh2_session_disconnect_ex(LIBSSH2_SESSION *session, int reason, const char *description, const char *lang); int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) reason – One of the Disconnect Reason constants. description – Human readable reason for disconnection. lang – Localization string describing the langauge/encoding of…
libssh2_session_disconnect – convenience macro for libssh2_session_disconnect_ex(3) calls Synopsis#include <libssh2.h> int libssh2_session_disconnect(LIBSSH2_SESSION *session, const char *description); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_session_disconnect_ex(3). Return ValueSee libssh2_session_disconnect_ex(3) ErrorsSee libssh2_session_disconnect_ex(3) See Alsolibssh2_session_disconnect_ex(3)
libssh2_session_callback_set – set a callback function Synopsis#include <libssh2.h> void *libssh2_session_callback_set(LIBSSH2_SESSION *session, int cbtype, void *callback);DescriptionSets a custom callback handler for a previously initialized session object. Callbacks are triggered by the receipt of special packets at the Transport layer. To disable a callback, set it to NULL. session – Session instance as returned by libssh2_session_init_ex(3) cbtype…
libssh2_session_block_directions – get directions to wait for Synopsis#include <libssh2.h> int libssh2_session_block_directions(LIBSSH2_SESSION *session); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) When any of libssh2 functions return LIBSSH2_ERROR_EAGAIN an application should wait for the socket to have data available for reading or writing. Depending on the return value of libssh2_session_block_directions(3) an application should wait for read,…
libssh2_session_banner_set – set the SSH prococol banner for the local client Synopsis#include <libssh2.h> int libssh2_session_banner_set(LIBSSH2_SESSION *session, const char *banner); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) banner – A pointer to a zero-terminated string holding the user defined banner Set the banner that will be sent to the remote host when the SSH session…
libssh2_session_banner_get – get the remote banner Synopsis#include <libssh2.h> const char *libssh2_session_banner_get(oLIBSSH2_SESSION *session); DescriptionOnce the session has been setup and libssh2_session_handshake(3) has completed successfully, this function can be used to get the server id from the banner each server presents. Return ValueA pointer to a string or NULL if something failed. The data pointed to will…
libssh2_session_abstract – return a pointer to a session’s abstract pointer Synopsis#include <libssh2.h> void ** libssh2_session_abstract(LIBSSH2_SESSION *session); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) Return a pointer to where the abstract pointer provided to libssh2_session_init_ex(3) is stored. By providing a doubly de-referenced pointer, the internal storage of the session instance may be modified in place….
libssh2_scp_send_ex – Send a file via SCP Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send_ex(LIBSSH2_SESSION *session, const char *path, int mode, size_t size, long mtime, long atime);DescriptionThis function has been deemed deprecated since libssh2 1.2.6. See libssh2_scp_send64(3). session – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer to. That is…
libssh2_scp_send64 – Send a file via SCP Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send64(LIBSSH2_SESSION *session, const char *path, int mode, libssh2_uint64_t size, time_t mtime, time_t atime);Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer to. That is the remote file name. mode – File access mode to create…
libssh2_scp_send – convenience macro for libssh2_scp_send_ex(3) calls Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_send(LIBSSH2_SESSION *session, const char *path, int mode, size_t size); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_scp_send_ex(3). Return ValueSee libssh2_scp_send_ex(3) ErrorsSee libssh2_scp_send_ex(3) See Alsolibssh2_scp_send_ex(3)
libssh2_scp_recv – request a remote file via SCP Synopsis#include <libssh2.h> LIBSSH2_CHANNEL * libssh2_scp_recv(LIBSSH2_SESSION *session, const char *path, struct stat *sb); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) path – Full path and filename of file to transfer. That is the remote file name. sb – Populated with remote file’s size, mode, mtime, and atime…
libssh2_publickey_shutdown – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_list_remove_ex – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_remove – convenience macro for libssh2_publickey_remove_ex(3) calls Synopsis#include <libssh2.h> int libssh2_publickey_remove(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, unsigned long name_len, const unsigned char *blob, unsigned long blob_len); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_publickey_remove_ex(3). Return ValueSee libssh2_publickey_remove_ex(3) ErrorsSee libssh2_publickey_remove_ex(3) See Alsolibssh2_publickey_remove_ex(3)
libssh2_publickey_list_free – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_list_fetch – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_init – TODO SynopsisDescriptionReturn ValueErrorsSee Also
libssh2_publickey_add_ex – Add a public key entry Synopsis#include <libssh2.h> int libssh2_publickey_add_ex(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, unsigned long name_len, const unsigned char *blob, unsigned long blob_len, char overwrite, unsigned long num_attrs, const libssh2_publickey_attribute attrs[]) DescriptionTBD Return ValueReturns 0 on success, negative on failure. ErrorsLIBSSH2_ERROR_BAD_USE LIBSSH2_ERROR_ALLOC, LIBSSH2_ERROR_EAGAIN LIBSSH2_ERROR_SOCKET_SEND, LIBSSH2_ERROR_SOCKET_TIMEOUT, LIBSSH2_ERROR_PUBLICKEY_PROTOCOL, See Also
libssh2_publickey_add – convenience macro for libssh2_publickey_add_ex(3) calls Synopsis#include <libssh2.h> int libssh2_publickey_add(LIBSSH2_PUBLICKEY *pkey, const unsigned char *name, const unsigned char *blob, unsigned long blob_len, char overwrite, unsigned long num_attrs, const libssh2_publickey_attribute attrs[]); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_publickey_add_ex(3). Return ValueSee libssh2_publickey_add_ex(3) ErrorsSee libssh2_publickey_add_ex(3) See…