Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

libssh2_knownhost_add(3) [debian man page]

libssh2_knownhost_add(3)					  libssh2 manual					  libssh2_knownhost_add(3)

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 for removal in a future release. 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 hashed, it must be provided base64 encoded. The host name can be the IP numeri- cal address of the host or the full name. saltP is a pointer to the salt used for the host hashing, if the host is provided hashed. If the host is provided in plain text, salt has no meaning. The salt has to be provided base64 encoded with a trailing zero byte. key is a pointer to the key for the given host. keylen is the total size in bytes of the key pointed to by the key argument typemask is a bitmask that specifies format and info about the data passed to this function. Specificly, it details what format the host name is, what format the key is and what key type it is. The host name is given as one of the following types: LIBSSH2_KNOWNHOST_TYPE_PLAIN, LIBSSH2_KNOWNHOST_TYPE_SHA1 or LIBSSH2_KNOWN- HOST_TYPE_CUSTOM. The key is encoded using one of the following encodings: LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. The key is using one of these algorithms: LIBSSH2_KNOWNHOST_KEY_RSA1, LIBSSH2_KNOWNHOST_KEY_SSHRSA or LIBSSH2_KNOWNHOST_KEY_SSHDSS. store should point to a pointer that gets filled in to point to the known host data after the addition. NULL can be passed if you don't care about this pointer. RETURN VALUE
Returns a regular libssh2 error code, where negative values are error codes and 0 indicates success. AVAILABILITY
Added in libssh2 1.2, deprecated since libssh2 1.2.5. Use libssh2_knownhost_addc(3) instead! SEE ALSO
libssh2_knownhost_init(3) libssh2_knownhost_free(3) libssh2_knownhost_check(3) libssh2_knownhost_addc(3) libssh2 1.2 28 May 2009 libssh2_knownhost_add(3)

Check Out this Related Man Page

libssh2_knownhost_check(3)					  libssh2 manual					libssh2_knownhost_check(3)

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 the host name in plain text. The host name can be the IP numerical address of the host or the full name. key is a pointer to the key for the given host. keylen is the total size in bytes of the key pointed to by the key argument typemask is a bitmask that specifies format and info about the data passed to this function. Specificly, it details what format the host name is, what format the key is and what key type it is. The host name is given as one of the following types: LIBSSH2_KNOWNHOST_TYPE_PLAIN or LIBSSH2_KNOWNHOST_TYPE_CUSTOM. The key is encoded using one of the following encodings: LIBSSH2_KNOWNHOST_KEYENC_RAW or LIBSSH2_KNOWNHOST_KEYENC_BASE64. knownhost if set to non-NULL, it must be a pointer to a 'struct libssh2_knownhost' pointer that gets filled in to point to info about a known host that matches or partially matches. RETURN VALUE
libssh2_knownhost_check(3) returns info about how well the provided host + key pair matched one of the entries in the list of known hosts. LIBSSH2_KNOWNHOST_CHECK_FAILURE - something prevented the check to be made LIBSSH2_KNOWNHOST_CHECK_NOTFOUND - no host match was found LIBSSH2_KNOWNHOST_CHECK_MATCH - hosts and keys match. LIBSSH2_KNOWNHOST_CHECK_MISMATCH - host was found, but the keys didn't match! AVAILABILITY
Added in libssh2 1.2 EXAMPLE
See the ssh2_exec.c example as provided in the tarball. SEE ALSO
libssh2_knownhost_init(3) libssh2_knownhost_free(3) libssh2_knownhost_add(3) libssh2 1.2 28 May 2009 libssh2_knownhost_check(3)
Man Page