Blame doc/manpages/gnutls_x509_privkey_sign_data.3

Packit aea12f
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
Packit Service 991b93
.TH "gnutls_x509_privkey_sign_data" 3 "3.6.14" "gnutls" "gnutls"
Packit aea12f
.SH NAME
Packit aea12f
gnutls_x509_privkey_sign_data \- API function
Packit aea12f
.SH SYNOPSIS
Packit aea12f
.B #include <gnutls/x509.h>
Packit aea12f
.sp
Packit aea12f
.BI "int gnutls_x509_privkey_sign_data(gnutls_x509_privkey_t " key ", gnutls_digest_algorithm_t " digest ", unsigned int " flags ", const gnutls_datum_t * " data ", void * " signature ", size_t * " signature_size ");"
Packit aea12f
.SH ARGUMENTS
Packit aea12f
.IP "gnutls_x509_privkey_t key" 12
Packit aea12f
a key
Packit aea12f
.IP "gnutls_digest_algorithm_t digest" 12
Packit aea12f
should be a digest algorithm
Packit aea12f
.IP "unsigned int flags" 12
Packit aea12f
should be 0 for now
Packit aea12f
.IP "const gnutls_datum_t * data" 12
Packit aea12f
holds the data to be signed
Packit aea12f
.IP "void * signature" 12
Packit aea12f
will contain the signature
Packit aea12f
.IP "size_t * signature_size" 12
Packit aea12f
holds the size of signature (and will be replaced
Packit aea12f
by the new size)
Packit aea12f
.SH "DESCRIPTION"
Packit aea12f
This function will sign the given data using a signature algorithm
Packit aea12f
supported by the private key. Signature algorithms are always used
Packit aea12f
together with a hash functions.  Different hash functions may be
Packit aea12f
used for the RSA algorithm, but only SHA\-1 for the DSA keys.
Packit aea12f
Packit aea12f
If the buffer provided is not long enough to hold the output, then
Packit aea12f
* \fIsignature_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will
Packit aea12f
be returned.
Packit aea12f
Packit aea12f
Use \fBgnutls_x509_crt_get_preferred_hash_algorithm()\fP to determine
Packit aea12f
the hash algorithm.
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