summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_x509_privkey_sign_data.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/gnutls_x509_privkey_sign_data.3
parentInitial commit. (diff)
downloadgnutls28-upstream.tar.xz
gnutls28-upstream.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_x509_privkey_sign_data.3')
-rw-r--r--doc/manpages/gnutls_x509_privkey_sign_data.357
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/manpages/gnutls_x509_privkey_sign_data.3 b/doc/manpages/gnutls_x509_privkey_sign_data.3
new file mode 100644
index 0000000..dc08360
--- /dev/null
+++ b/doc/manpages/gnutls_x509_privkey_sign_data.3
@@ -0,0 +1,57 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by gdoc.
+.TH "gnutls_x509_privkey_sign_data" 3 "3.7.9" "gnutls" "gnutls"
+.SH NAME
+gnutls_x509_privkey_sign_data \- API function
+.SH SYNOPSIS
+.B #include <gnutls/x509.h>
+.sp
+.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 ");"
+.SH ARGUMENTS
+.IP "gnutls_x509_privkey_t key" 12
+a key
+.IP "gnutls_digest_algorithm_t digest" 12
+should be a digest algorithm
+.IP "unsigned int flags" 12
+should be 0 for now
+.IP "const gnutls_datum_t * data" 12
+holds the data to be signed
+.IP "void * signature" 12
+will contain the signature
+.IP "size_t * signature_size" 12
+holds the size of signature (and will be replaced
+by the new size)
+.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 SHA\-1 for the DSA keys.
+
+If the buffer provided is not long enough to hold the output, then
+* \fIsignature_size\fP is updated and \fBGNUTLS_E_SHORT_MEMORY_BUFFER\fP will
+be returned.
+
+Use \fBgnutls_x509_crt_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 "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