gnutls_x509_privkey_sign_data(3) — Linux manual page

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | RETURNS | REPORTING BUGS | COPYRIGHT | SEE ALSO | COLOPHON

gnutls_x509_privkey_sign_data(3)  gnutls gnutls_x509_privkey_sign_data(3)

NAME         top

       gnutls_x509_privkey_sign_data - API function

SYNOPSIS         top

       #include <gnutls/x509.h>

       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);

ARGUMENTS         top

       gnutls_x509_privkey_t key
                   a key

       gnutls_digest_algorithm_t digest
                   should be a digest algorithm

       unsigned int flags
                   should be 0 for now

       const gnutls_datum_t * data
                   holds the data to be signed

       void * signature
                   will contain the signature

       size_t * signature_size
                   holds the size of signature (and will be replaced by
                   the new size)

DESCRIPTION         top

       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
       * signature_size is updated and GNUTLS_E_SHORT_MEMORY_BUFFER will
       be returned.

       Use gnutls_x509_crt_get_preferred_hash_algorithm() to determine
       the hash algorithm.

RETURNS         top

       On success, GNUTLS_E_SUCCESS (0) is returned, otherwise a negative
       error value.

REPORTING BUGS         top

       Report bugs to <bugs@gnutls.org>.
       Home page: https://www.gnutls.org

COPYRIGHT         top

       Copyright © 2001-2023 Free Software Foundation, Inc., and others.
       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.

SEE ALSO         top

       The full documentation for gnutls is maintained as a Texinfo
       manual.  If the /usr/share/doc/gnutls/ directory does not contain
       the HTML form visit

       https://www.gnutls.org/manual/

COLOPHON         top

       This page is part of the GnuTLS (GnuTLS Transport Layer Security
       Library) project.  Information about the project can be found at
       ⟨http://www.gnutls.org/⟩.  If you have a bug report for this
       manual page, send it to bugs@gnutls.org.  This page was obtained
       from the tarball fetched from
       ⟨https://www.gnupg.org/ftp/gcrypt/gnutls/⟩ on 2025-02-02.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for the
       page, or you have corrections or improvements to the information
       in this COLOPHON (which is not part of the original manual page),
       send a mail to man-pages@man7.org

gnutls                            3.8.8  gnutls_x509_privkey_sign_data(3)