Author: Linux Manual

NAME 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) DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) username – Name of…

NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_userauth_password_ex(3). RETURN VALUE See libssh2_userauth_password_ex(3) ERRORS See libssh2_userauth_password_ex(3) SEE ALSO libssh2_userauth_password_ex(3) Index

NAME 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); DESCRIPTION session – 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…

NAME 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)); DESCRIPTION session – 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…

NAME 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))); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_userauth_keyboard_interactive_ex(3). RETURN VALUE See libssh2_userauth_keyboard_interactive_ex(3) ERRORS See libssh2_userauth_keyboard_interactive_ex(3) SEE ALSO libssh2_userauth_keyboard_interactive_ex(3) Index

NAME libssh2_userauth_hostbased_fromfile_ex – TODO SYNOPSIS DESCRIPTION RETURN VALUE ERRORS SEE ALSO Index

NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_userauth_hostbased_fromfile_ex(3). RETURN VALUE See libssh2_userauth_hostbased_fromfile_ex(3) ERRORS See libssh2_userauth_hostbased_fromfile_ex(3)…

NAME libssh2_userauth_authenticated – return authentication status SYNOPSIS #include <libssh2.h> int libssh2_userauth_authenticated(LIBSSH2_SESSION *session); DESCRIPTION session – Session instance as returned by libssh2_session_init_ex(3) Indicates whether or not the named session has been successfully authenticated. RETURN VALUE Returns 1 if authenticated and 0 if not. SEE ALSO libssh2_session_init_ex(3) Index

NAME 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); DESCRIPTION libssh2_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…

NAME libssh2_trace – enable debug info from inside libssh2 SYNOPSIS #include <libssh2.h> void libssh2_trace(LIBSSH2_SESSION *session, int bitmask); DESCRIPTION This 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…

NAME 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); DESCRIPTION libssh2_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…

NAME 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); DESCRIPTION sftp – 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…

NAME 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); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_unlink_ex(3). RETURN VALUE See libssh2_sftp_unlink_ex(3) ERRORS See libssh2_sftp_unlink_ex(3) SEE ALSO libssh2_sftp_unlink_ex(3) Index

NAME 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); DESCRIPTION handle – SFTP File Handle as returned by libssh2_sftp_open_ex(3) Identify the current offset of the file handle’s internal pointer. RETURN VALUE Current offset from beginning of file in bytes. AVAILABILITY Added in libssh2 1.0…

NAME 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); DESCRIPTION handle – 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 VALUE Current offset…

NAME 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); DESCRIPTION Create a symlink or read out symlink information from the remote side. sftp – SFTP instance as returned by libssh2_sftp_init(3) path – Remote filesystem…

NAME 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) DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_symlink_ex(3). RETURN VALUE See libssh2_sftp_symlink_ex(3) ERRORS See libssh2_sftp_symlink_ex(3) SEE ALSO libssh2_sftp_symlink_ex(3) Index

NAME libssh2_sftp_statvfs, libssh2_sftp_fstatvfs – get file system statistics SYNOPSIS #include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_statvfs(LIBSSH2_SFTP *sftp, const char *path, size_t path_len, LIBSSH2_SFTP_STATVFS *st); int libssh2_sftp_fstatvfs(LIBSSH2_SFTP_HANDLE *handle, LIBSSH2_SFTP_STATVFS *st) DESCRIPTION These functions provide statvfs(2)-like operations and require statvfs [at] openssh.com and fstatvfs [at] openssh.com extension support on the server. sftp – SFTP instance as returned by…

NAME libssh2_sftp_stat_ex – get status about an SFTP file SYNOPSIS #include <libssh2.h> #include <libssh2_sftp.h> int libssh2_sftp_stat_ex(LIBSSH2_SFTP *sftp, const char *path, unsigned int path_len, int stat_type, LIBSSH2_SFTP_ATTRIBUTES *attrs); DESCRIPTION sftp – SFTP instance as returned by libssh2_sftp_init(3) path – Remote filesystem object to stat/lstat/setstat. path_len – Length of the name of the remote filesystem object to…

NAME libssh2_sftp_stat – convenience macro for libssh2_sftp_fstat_ex(3) calls SYNOPSIS #include <libssh2.h> int libssh2_sftp_stat(LIBSSH2_SFTP *sftp, const char *path, LIBSSH2_STFP_ATTRIBUTES *attrs); DESCRIPTION This is a macro defined in a public libssh2 header file that is using the underlying function libssh2_sftp_fstat_ex(3). RETURN VALUE See libssh2_sftp_fstat_ex(3) ERRORS See libssh2_sftp_fstat_ex(3) SEE ALSO libssh2_sftp_fstat_ex(3) Index