Blame doc/manpages/gnutls_pubkey_get_preferred_hash_algorithm.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_pubkey_get_preferred_hash_algorithm" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_pubkey_get_preferred_hash_algorithm \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/abstract.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_pubkey_get_preferred_hash_algorithm(gnutls_pubkey_t " key ", gnutls_digest_algorithm_t *         " hash ", unsigned int * " mand ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_pubkey_t key" 12
Packit aea12f
Holds the certificate
Packit aea12f
.IP "gnutls_digest_algorithm_t *         hash" 12
Packit aea12f
The result of the call with the hash algorithm used for signature
Packit aea12f
.IP "unsigned int * mand" 12
Packit aea12f
If non zero it means that the algorithm MUST use this hash. May be NULL.
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will read the certificate and return the appropriate digest
Packit aea12f
algorithm to use for signing with this certificate. Some certificates (i.e.
Packit aea12f
DSA might not be able to sign without the preferred algorithm).
Packit aea12f
Packit aea12f
To get the signature algorithm instead of just the hash use \fBgnutls_pk_to_sign()\fP
Packit aea12f
with the algorithm of the certificate/key and the provided  \fIhash\fP .
Packit aea12f
.SH "RETURNS"
Packit aea12f
the 0 if the hash algorithm is found. A negative error code is
Packit aea12f
returned on error.
Packit aea12f
.SH "SINCE"
Packit aea12f
2.12.0
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