summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_privkey_sign_data.3
blob: cf26ab3632e28ad4649d5f6776dbf702916de4d2 (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
51
52
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_privkey_sign_data" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_privkey_sign_data \- API function
.SH SYNOPSIS
.B #include <gnutls/abstract.h>
.sp
.BI "int gnutls_privkey_sign_data(gnutls_privkey_t " signer ", gnutls_digest_algorithm_t " hash ", unsigned int " flags ", const gnutls_datum_t * " data ", gnutls_datum_t * " signature ");"
.SH ARGUMENTS
.IP "gnutls_privkey_t signer" 12
Holds the key
.IP "gnutls_digest_algorithm_t hash" 12
should be a digest algorithm
.IP "unsigned int flags" 12
Zero or one of \fBgnutls_privkey_flags_t\fP
.IP "const gnutls_datum_t * data" 12
holds the data to be signed
.IP "gnutls_datum_t * signature" 12
will contain the signature allocated with \fBgnutls_malloc()\fP
.SH "DESCRIPTION"
This function will sign the given data using a signature algorithm
supported by the private key. Signature algorithms are always used
together with a hash functions.  Different hash functions may be
used for the RSA algorithm, but only the SHA family for the DSA keys.

You may use \fBgnutls_pubkey_get_preferred_hash_algorithm()\fP to determine
the hash algorithm.
.SH "RETURNS"
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned, otherwise a
negative error value.
.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