Linux Manuals session 3

libssh2_userauth_publickey_fromfile – authenticate a session with a public key, read from a file Synopsis#include <libssh2.h> int libssh2_userauth_publickey_fromfile_ex(LIBSSH2_SESSION *session, const char *username, const char *publickey, const char *privatekey, const char *passphrase);Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) username – Pointer to user name to authenticate as. username_len – Length of username. publickey – Path name…

libssh2_userauth_publickey_fromfile – convenience macro for libssh2_userauth_publickey_fromfile_ex(3) calls Synopsis#include <libssh2.h> int libssh2_userauth_publickey_fromfile(LIBSSH2_SESSION *session,                               const char *username,                               const char *publickey,                               const char *privatekey,                               const char *passphrase); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_userauth_publickey_fromfile_ex(3). Return ValueSee libssh2_userauth_publickey_fromfile_ex(3) ErrorsSee libssh2_userauth_publickey_fromfile_ex(3) See Alsolibssh2_userauth_publickey_fromfile_ex(3)

libssh2_userauth_publickey – authenticate using a callback function Synopsis#include <libssh2.h> int libssh2_userauth_publickey(LIBSSH2_SESSION *session, const char *user, const unsigned char *pubkeydata, size_t pubkeydata_len, sign_callback, void **abstract);DescriptionAuthenticate with the sign_callback callback that matches the prototype below Callbackint name(LIBSSH2_SESSION *session, unsigned char **sig, size_t *sig_len, const unsigned char *data, size_t data_len, void **abstract);This function gets called… Return ValueReturn 0…

libssh2_userauth_password_ex – authenticate a session with username and password Synopsis#include <libssh2.h> int libssh2_userauth_password_ex(LIBSSH2_SESSION *session, const char *username, unsigned int username_len, const char *password, unsigned int password_len, LIBSSH2_PASSWD_CHANGEREQ_FUNC((*passwd_change_cb))); #define libssh2_userauth_password(session, username, password) \ libssh2_userauth_password_ex((session), (username), \ strlen(username), \ (password), strlen(password), NULL)Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) username – Name of user to attempt plain…

libssh2_userauth_password – convenience macro for libssh2_userauth_password_ex(3) calls Synopsis#include <libssh2.h> int libssh2_userauth_password(LIBSSH2_SESSION *session,                         const char *username,                         const char *password); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_userauth_password_ex(3). Return ValueSee libssh2_userauth_password_ex(3) ErrorsSee libssh2_userauth_password_ex(3) See Alsolibssh2_userauth_password_ex(3)

libssh2_userauth_list – list supported authentication methods Synopsis#include <libssh2.h> char * libssh2_userauth_list(LIBSSH2_SESSION *session, const char *username, unsigned int username_len);Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) username – Username which will be used while authenticating. Note that most server implementations do not permit attempting authentication with different usernames between requests. Therefore this must be the same…

libssh2_userauth_keyboard_interactive_ex – authenticate a session using keyboard-interactive authentication Synopsis#include <libssh2.h> int libssh2_userauth_keyboard_interactive_ex(LIBSSH2_SESSION *session, const char *username, unsigned int username_len, LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC(*response_callback));Descriptionsession – Session instance as returned by libssh2_session_init_ex(3). username – Name of user to attempt keyboard-interactive authentication for. username_len – Length of username parameter. response_callback – As authentication proceeds, the host issues several (1 or more)…

libssh2_userauth_keyboard_interactive – convenience macro for libssh2_userauth_keyboard_interactive_ex(3) calls Synopsis#include <libssh2.h> int libssh2_userauth_keyboard_interactive(LIBSSH2_SESSION* session, const char *username, LIBSSH2_USERAUTH_KBDINT_RESPONSE_FUNC((*response_callback)));DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_userauth_keyboard_interactive_ex(3). Return ValueSee libssh2_userauth_keyboard_interactive_ex(3) ErrorsSee libssh2_userauth_keyboard_interactive_ex(3) See Alsolibssh2_userauth_keyboard_interactive_ex(3)

libssh2_userauth_hostbased_fromfile_ex – TODO SynopsisDescriptionReturn ValueErrorsSee Also

libssh2_userauth_hostbased_fromfile – convenience macro for libssh2_userauth_hostbased_fromfile_ex(3) calls Synopsis#include <libssh2.h> int libssh2_userauth_hostbased_fromfile(LIBSSH2_SESSION *session, const char *username, const char *publickey, const char *privatekey, const char *passphrase, const char *hostname); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_userauth_hostbased_fromfile_ex(3). Return ValueSee libssh2_userauth_hostbased_fromfile_ex(3) ErrorsSee libssh2_userauth_hostbased_fromfile_ex(3) See Alsolibssh2_userauth_hostbased_fromfile_ex(3)

libssh2_userauth_authenticated – return authentication status Synopsis#include <libssh2.h> int libssh2_userauth_authenticated(LIBSSH2_SESSION *session); Descriptionsession – Session instance as returned by libssh2_session_init_ex(3) Indicates whether or not the named session has been successfully authenticated. Return ValueReturns 1 if authenticated and 0 if not. See Alsolibssh2_session_init_ex(3)

libssh2_trace_sethandler – set a trace output handler Synopsis#include <libssh2.h> typedef void (*libssh2_trace_handler_func)(LIBSSH2_SESSION *session, void* context, const char *data, size_t length); int libssh2_trace_sethandler(LIBSSH2_SESSION *session, void* context, libssh2_trace_handler_func callback);Descriptionlibssh2_trace_sethandler installs a trace output handler for your application. By default, when tracing has been switched on via a call to libssh2_trace(), all output is written to stderr. By…

libssh2_trace – enable debug info from inside libssh2 Synopsis#include <libssh2.h> void libssh2_trace(LIBSSH2_SESSION *session, int bitmask); DescriptionThis is a function present in the library that can be used to get debug info from within libssh2 when it is running. Helpful when trying to trace or debug behaviors. Note that this function has no effect unless libssh2…

libssh2_sftp_write – write SFTP data Synopsis#include <libssh2.h> #include <libssh2_sftp.h> ssize_t libssh2_sftp_write(LIBSSH2_SFTP_HANDLE *handle, const char *buffer, size_t count);Descriptionlibssh2_sftp_write(3) writes a block of data to the SFTP server. This method is modeled after the POSIX write() function and uses the same calling semantics. handle – SFTP file handle as returned by libssh2_sftp_open_ex(3). buffer – points to the…

libssh2_sftp_unlink_ex – unlink an SFTP file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_unlink_ex(LIBSSH2_SFTP *sftp, const char *filename, unsigned int filename_len); int libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); Descriptionsftp – SFTP instance as returned by libssh2_sftp_init(3) filename – Path and name of the existing filesystem entry filename_len – Length of the path and name of the existing filesystem…

libssh2_sftp_unlink – convenience macro for libssh2_sftp_unlink_ex(3) calls Synopsis#include <libssh2.h> int libssh2_sftp_unlink(LIBSSH2_SFTP *sftp, const char *filename); DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_unlink_ex(3). Return ValueSee libssh2_sftp_unlink_ex(3) ErrorsSee libssh2_sftp_unlink_ex(3) See Alsolibssh2_sftp_unlink_ex(3)

libssh2_sftp_tell64 – get the current read/write position indicator for a file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> libssh2_uint64_t libssh2_sftp_tell64(LIBSSH2_SFTP_HANDLE *handle); Descriptionhandle – SFTP File Handle as returned by libssh2_sftp_open_ex(3) Identify the current offset of the file handle’s internal pointer. Return ValueCurrent offset from beginning of file in bytes. AvailabilityAdded in libssh2 1.0 See Alsolibssh2_sftp_open_ex(3), libssh2_sftp_tell(3)

libssh2_sftp_tell – get the current read/write position indicator for a file Synopsis#include <libssh2.h> #include <libssh2_sftp.h> size_t libssh2_sftp_tell(LIBSSH2_SFTP_HANDLE *handle); Descriptionhandle – SFTP File Handle as returned by libssh2_sftp_open_ex(3). Returns the current offset of the file handle’s internal pointer. Note that this is now deprecated. Use the newer libssh2_sftp_tell64(3) instead! Return ValueCurrent offset from beginning of file…

libssh2_sftp_symlink_ex – read or set a symbolic link Synopsis#include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_symlink_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, char *target, unsigned int target_len, int link_type);DescriptionCreate a symlink or read out symlink information from the remote side. sftp – SFTP instance as returned by libssh2_sftp_init(3) path – Remote filesystem object to create a…

libssh2_sftp_symlink – convenience macro for libssh2_sftp_symlink_ex(3) Synopsis#include <libssh2.h> #define libssh2_sftp_symlink(sftp, orig, linkpath) \ libssh2_sftp_symlink_ex((sftp), (orig), strlen(orig), (linkpath), \ strlen(linkpath), LIBSSH2_SFTP_SYMLINK)DescriptionThis is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_symlink_ex(3). Return ValueSee libssh2_sftp_symlink_ex(3) ErrorsSee libssh2_sftp_symlink_ex(3) See Alsolibssh2_sftp_symlink_ex(3)