summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_x509_privkey_get_key_id.3
blob: a4be1c08ee03939aa4b8c75a1e644fe9be6f0c2e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_x509_privkey_get_key_id" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_x509_privkey_get_key_id \- API function
.SH SYNOPSIS
.B #include <gnutls/x509.h>
.sp
.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 ");"
.SH ARGUMENTS
.IP "gnutls_x509_privkey_t key" 12
a key
.IP "unsigned int flags" 12
should be one of the flags from \fBgnutls_keyid_flags_t\fP
.IP "unsigned char * output_data" 12
will contain the key ID
.IP "size_t * output_data_size" 12
holds the size of output_data (and will be
replaced by the actual size of parameters)
.SH "DESCRIPTION"
This function will return a unique ID that depends on the public key
parameters. This ID can be used in checking whether a certificate
corresponds to the given key.

If the buffer provided is not long enough to hold the output, then
* \fIoutput_data_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will
be returned.  The output will normally be a SHA\-1 hash output,
which is 20 bytes.
.SH "RETURNS"
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
negative error value.
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.br
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP