doc/manpages/gnutls_privkey_sign_data.3

   1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
   2 .TH "gnutls_privkey_sign_data" 3 "2.12.6.1" "gnutls" "gnutls"
   3 .SH NAME
   4 gnutls_privkey_sign_data \- API function
   5 .SH SYNOPSIS
   6 .B #include <gnutls/gnutls.h>
   7 .sp
   8 .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 ");"
   9 .SH ARGUMENTS
  10 .IP "gnutls_privkey_t signer" 12
  11 Holds the key
  12 .IP "gnutls_digest_algorithm_t hash" 12
  13 should be a digest algorithm
  14 .IP "unsigned int flags" 12
  15 should be 0 for now
  16 .IP "const gnutls_datum_t * data" 12
  17 holds the data to be signed
  18 .IP "gnutls_datum_t * signature" 12
  19 will contain the signature allocate with \fBgnutls_malloc()\fP
  20 .SH "DESCRIPTION"
  21 This function will sign the given data using a signature algorithm
  22 supported by the private key. Signature algorithms are always used
  23 together with a hash functions.  Different hash functions may be
  24 used for the RSA algorithm, but only SHA\-1 for the DSA keys.
  25 .SH "RETURNS"
  26 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
  27 negative error value.
  28 .SH "SINCE"
  29 2.12.0
  30 .SH "REPORTING BUGS"
  31 Report bugs to <bug-gnutls@gnu.org>.
  32 GnuTLS home page: http://www.gnu.org/software/gnutls/
  33 General help using GNU software: http://www.gnu.org/gethelp/
  34 .SH COPYRIGHT
  35 Copyright \(co 2008 Free Software Foundation.
  36 .br
  37 Copying and distribution of this file, with or without modification,
  38 are permitted in any medium without royalty provided the copyright
  39 notice and this notice are preserved.
  40 .SH "SEE ALSO"
  41 The full documentation for
  42 .B gnutls
  43 is maintained as a Texinfo manual.  If the
  44 .B info
  45 and
  46 .B gnutls
  47 programs are properly installed at your site, the command
  48 .IP
  49 .B info gnutls
  50 .PP
  51 should give you access to the complete manual.