diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:33:12 +0000 |
| commit | 36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch) | |
| tree | 6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/gnutls_pubkey_get_key_id.3 | |
| parent | Initial commit. (diff) | |
| download | gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.tar.xz gnutls28-36082a2fe36ecd800d784ae44c14f1f18c66a7e9.zip | |
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages/gnutls_pubkey_get_key_id.3')
| -rw-r--r-- | doc/manpages/gnutls_pubkey_get_key_id.3 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_pubkey_get_key_id.3 b/doc/manpages/gnutls_pubkey_get_key_id.3 new file mode 100644 index 0000000..93dd04f --- /dev/null +++ b/doc/manpages/gnutls_pubkey_get_key_id.3 @@ -0,0 +1,52 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by gdoc. +.TH "gnutls_pubkey_get_key_id" 3 "3.7.9" "gnutls" "gnutls" +.SH NAME +gnutls_pubkey_get_key_id \- API function +.SH SYNOPSIS +.B #include <gnutls/abstract.h> +.sp +.BI "int gnutls_pubkey_get_key_id(gnutls_pubkey_t " key ", unsigned int " flags ", unsigned char * " output_data ", size_t * " output_data_size ");" +.SH ARGUMENTS +.IP "gnutls_pubkey_t key" 12 +Holds the public 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 public key. + +If the buffer provided is not long enough to hold the output, then +*output_data_size 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" +In case of failure a negative error code will be +returned, and 0 on success. +.SH "SINCE" +2.12.0 +.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 |