libssh2/share/man/man3/libssh2_hostkey_hash.3

   1 .\" $Id: libssh2_hostkey_hash.3,v 1.1 2007/06/14 14:56:32 jehousley Exp $
   2 .\"
   3 .TH libssh2_hostkey_hash 3 "1 Jun 2007" "libssh2 0.15" "libssh2 manual"
   4 .SH NAME
   5 libssh2_hostkey_hash - return a hash of the remote host's key
   6 .SH SYNOPSIS
   7 #include <libssh2.h>
   8
   9 const char *
  10 libssh2_hostkey_hash(LIBSSH2_SESSION *session, int hash_type);
  11
  12 .SH DESCRIPTION
  13 \fIsession\fP - Session instance as returned by
  14 .BR libssh2_session_init(3)
  15
  16 \fIhash_type\fP - One of: \fBLIBSSH2_HOSTKEY_HASH_MD5\fP or
  17 \fBLIBSSH2_HOSTKEY_HASH_SHA1\fP.
  18
  19 Returns the computed digest of the remote system's hostkey. The length of
  20 the returned string is hash_type specific (e.g. 16 bytes for MD5,
  21 20 bytes for SHA1).
  22
  23 .SH RETURN VALUE
  24 Computed hostkey hash value. or NULL if the session has not yet been started
  25 up. (The hash consists of raw binary bytes, not hex digits, so is not
  26 directly printable.)
  27
  28 .SH SEE ALSO
  29 .BR libssh2_session_init(3)