Blame doc/manpages/gnutls_x509_privkey_get_key_id.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_x509_privkey_get_key_id" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_x509_privkey_get_key_id \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/x509.h>
Packit aea12f
.sp
Packit aea12f
.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 ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_x509_privkey_t key" 12
Packit aea12f
a key
Packit aea12f
.IP "unsigned int flags" 12
Packit aea12f
should be one of the flags from \fBgnutls_keyid_flags_t\fP
Packit aea12f
.IP "unsigned char * output_data" 12
Packit aea12f
will contain the key ID
Packit aea12f
.IP "size_t * output_data_size" 12
Packit aea12f
holds the size of output_data (and will be
Packit aea12f
replaced by the actual size of parameters)
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will return a unique ID that depends on the public key
Packit aea12f
parameters. This ID can be used in checking whether a certificate
Packit aea12f
corresponds to the given key.
Packit aea12f
Packit aea12f
If the buffer provided is not long enough to hold the output, then
Packit aea12f
* \fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will
Packit aea12f
be returned.  The output will normally be a SHA\-1 hash output,
Packit aea12f
which is 20 bytes.
Packit aea12f
.SH "RETURNS"
Packit aea12f
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
Packit aea12f
negative error value.
Packit aea12f
.SH "REPORTING BUGS"
Packit aea12f
Report bugs to <bugs@gnutls.org>.
Packit aea12f
.br
Packit aea12f
Home page: https://www.gnutls.org
Packit aea12f
Packit aea12f
.SH COPYRIGHT
Packit Service 991b93
Copyright \(co 2001- Free Software Foundation, Inc., and others.
Packit aea12f
.br
Packit aea12f
Copying and distribution of this file, with or without modification,
Packit aea12f
are permitted in any medium without royalty provided the copyright
Packit aea12f
notice and this notice are preserved.
Packit aea12f
.SH "SEE ALSO"
Packit aea12f
The full documentation for
Packit aea12f
.B gnutls
Packit aea12f
is maintained as a Texinfo manual.
Packit aea12f
If the /usr/share/doc/gnutls/
Packit aea12f
directory does not contain the HTML form visit
Packit aea12f
.B
Packit aea12f
.IP https://www.gnutls.org/manual/
Packit aea12f
.PP