doc/manpages/gnutls_x509_privkey_get_key_id.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_x509_privkey_get_key_id" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_x509_privkey_get_key_id \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/x509.h>
   7 .sp
   8 .BI "int gnutls_x509_privkey_get_key_id(gnutls_x509_privkey_t " key ", unsigned int " flags ", unsigned char * " output_data ", size_t * " output_data_size ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_x509_privkey_t key" 12
  11 Holds the key
  12 .IP "unsigned int flags" 12
  13 should be 0 for now
  14 .IP "unsigned char * output_data" 12
  15 will contain the key ID
  16 .IP "size_t * output_data_size" 12
  17 holds the size of output_data (and will be
  18 replaced by the actual size of parameters)
  19 .SH "DESCRIPTION"
  20 This function will return a unique ID the depends on the public key
  21 parameters. This ID can be used in checking whether a certificate
  22 corresponds to the given key.
  23
  24 If the buffer provided is not long enough to hold the output, then
  25 *\fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will
  26 be returned.  The output will normally be a SHA\-1 hash output,
  27 which is 20 bytes.
  28 .SH "RETURNS"
  29 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
  30 negative error value.
  31 .SH "REPORTING BUGS"
  32 Report bugs to <bug-gnutls@gnu.org>.
  33 GnuTLS home page: http://www.gnu.org/software/gnutls/
  34 General help using GNU software: http://www.gnu.org/gethelp/
  35 .SH COPYRIGHT
  36 Copyright \(co 2008 Free Software Foundation.
  37 .br
  38 Copying and distribution of this file, with or without modification,
  39 are permitted in any medium without royalty provided the copyright
  40 notice and this notice are preserved.
  41 .SH "SEE ALSO"
  42 The full documentation for
  43 .B gnutls
  44 is maintained as a Texinfo manual.  If the
  45 .B info
  46 and
  47 .B gnutls
  48 programs are properly installed at your site, the command
  49 .IP
  50 .B info gnutls
  51 .PP
  52 should give you access to the complete manual.