SysTutorials Posts

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

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

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

NAME 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[]) DESCRIPTION TBD RETURN VALUE Returns 0 on success, negative on failure. ERRORS LIBSSH2_ERROR_BAD_USE LIBSSH2_ERROR_ALLOC, LIBSSH2_ERROR_EAGAIN LIBSSH2_ERROR_SOCKET_SEND, LIBSSH2_ERROR_SOCKET_TIMEOUT, LIBSSH2_ERROR_PUBLICKEY_PROTOCOL, SEE ALSO…

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

NAME libssh2_poll_channel_read – check if data is available SYNOPSIS #include <libssh2.h> int libssh2_poll_channel_read(LIBSSH2_CHANNEL *channel, int extended); DESCRIPTION This function is deprecated. Do note use. libssh2_poll_channel_read(3) checks to see if data is available in the channel‘s read buffer. No attempt is made with this method to see if packets are available to be processed. For full…

NAME libssh2_poll – poll for activity on a socket, channel or listener SYNOPSIS #include <libssh2.h> int libssh2_poll(LIBSSH2_POLLFD *fds, unsigned int nfds, long timeout); DESCRIPTION This function is deprecated. Do note use. We encourage users to instead use the poll(3) or select(3) functions to check for socket activity or when specific sockets are ready to get…

NAME libssh2_knownhost_writeline – convert a known host to a line for storage SYNOPSIS #include <libssh2.h> libssh2_knownhost_writeline(LIBSSH2_KNOWNHOSTS *hosts,                       struct libssh2_knownhost *known,                       char *buffer, size_t buflen,                       size_t *outlen,                       int type); DESCRIPTION Converts a single known host to a single line of output for storage, using the ‘type’ output format. known identifies which particular known host buffer points to an allocated…

NAME libssh2_knownhost_writefile – write a collection of known hosts to a file SYNOPSIS #include <libssh2.h> int libssh2_knownhost_writefile(LIBSSH2_KNOWNHOSTS *hosts,                           const char *filename, int type); DESCRIPTION Writes all the known hosts to the specified file using the specified file format. filename specifies what filename to create type specifies what file type it is, and LIBSSH2_KNOWNHOST_FILE_OPENSSH is the only…

NAME libssh2_knownhost_readline – read a known host line SYNOPSIS #include <libssh2.h> int libssh2_knownhost_readline(LIBSSH2_KNOWNHOSTS *hosts,                          const char *line, size_t len, int type): DESCRIPTION Tell libssh2 to read a buffer as it if is a line from a known hosts file. line points to the start of the line len is the length of the line in bytes…

NAME libssh2_knownhost_readfile – parse a file of known hosts SYNOPSIS #include <libssh2.h> int libssh2_knownhost_readfile(LIBSSH2_KNOWNHOSTS *hosts,                          const char *filename, int type); DESCRIPTION Reads a collection of known hosts from a specified file and adds them to the collection of known hosts. filename specifies which file to read type specifies what file type it is, and LIBSSH2_KNOWNHOST_FILE_OPENSSH is…

NAME libssh2_knownhost_init – init a collection of known hosts SYNOPSIS #include <libssh2.h> LIBSSH2_KNOWNHOSTS *libssh2_knownhost_init(LIBSSH2_SESSION *session); DESCRIPTION Init a collection of known hosts for this session. Returns the handle to an internal representation of a known host collection. Call libssh2_knownhost_free(3) to free the collection again after you’re doing using it. RETURN VALUE Returns a handle pointer…

NAME libssh2_knownhost_get – get a known host off the collection of known hosts SYNOPSIS #include <libssh2.h> int libssh2_knownhost_get(LIBSSH2_KNOWNHOSTS *hosts,                     struct libssh2_knownhost **store,                     struct libssh2_knownhost *prev): DESCRIPTION libssh2_knownhost_get(3) allows an application to iterate over all known hosts in the collection. store should point to a pointer that gets filled in to point to the known host data. prev…

NAME libssh2_knownhost_free – free a collection of known hosts SYNOPSIS #include <libssh2.h> void libssh2_knownhost_free(LIBSSH2_KNOWNHOSTS *hosts); DESCRIPTION Free a collection of known hosts. RETURN VALUE None. AVAILABILITY Added in libssh2 1.2 SEE ALSO libssh2_knownhost_init(3) libssh2_knownhost_add(3) libssh2_knownhost_check(3) Index

NAME libssh2_knownhost_del – delete a known host entry SYNOPSIS #include <libssh2.h> int libssh2_knownhost_del(LIBSSH2_KNOWNHOSTS *hosts,                     struct libssh2_knownhost *entry); DESCRIPTION Delete a known host entry from the collection of known hosts. entry is a pointer to a struct that you can extract with libssh2_knownhost_check(3) or libssh2_knownhost_get(3). RETURN VALUE Returns a regular libssh2 error code, where negative values are…

NAME libssh2_knownhost_checkp – check a host+key against the list of known hosts SYNOPSIS #include <libssh2.h> int libssh2_knownhost_checkp(LIBSSH2_KNOWNHOSTS *hosts,                        const char *host, int port,                        const char *key, size_t keylen,                        int typemask,                        struct libssh2_knownhost **knownhost); DESCRIPTION Checks a host and its associated key against the collection of known hosts, and returns info back about the (partially) matched entry. host is…

NAME libssh2_knownhost_check – check a host+key against the list of known hosts SYNOPSIS #include <libssh2.h> int libssh2_knownhost_check(LIBSSH2_KNOWNHOSTS *hosts,                       const char *host,                       const char *key, size_t keylen,                       int typemask,                       struct libssh2_knownhost **knownhost); DESCRIPTION Checks a host and its associated key against the collection of known hosts, and returns info back about the (partially) matched entry. host is a pointer…

NAME libssh2_knownhost_add – add a known host SYNOPSIS #include <libssh2.h> int libssh2_knownhost_addc(LIBSSH2_KNOWNHOSTS *hosts,                      char *host, char *salt,                      char *key, size_t keylen,                      const char *comment, size_t commentlen,                      int typemask,                      struct libssh2_knownhost **store); DESCRIPTION Adds a known host to the collection of known hosts identified by the ‘hosts’ handle. host is a pointer the host name in plain text or hashed. If…

NAME libssh2_knownhost_add – add a known host SYNOPSIS #include <libssh2.h> int libssh2_knownhost_add(LIBSSH2_KNOWNHOSTS *hosts, char *host, char *salt, char *key, size_t keylen, int typemask, struct libssh2_knownhost **store); DESCRIPTION We discourage use of this function as of libssh2 1.2.5. Instead we strongly urge users to use libssh2_knownhost_addc(3) instead, which as a more complete API. libssh2_knownhost_add(3) is subject…

NAME libssh2_keepalive_send – short function description SYNOPSIS #include <libssh2.h> int libssh2_keepalive_send(LIBSSH2_SESSION *session, int *seconds_to_next); DESCRIPTION Send a keepalive message if needed. seconds_to_next indicates how many seconds you can sleep after this call before you need to call it again. RETURN VALUE Returns 0 on success, or LIBSSH2_ERROR_SOCKET_SEND on I/O errors. AVAILABILITY Added in libssh2 1.2.5…