Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_x509_crl_privkey_sign.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_x509_crl_privkey_sign" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_x509_crl_privkey_sign \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/x509.h>
7 .sp
8 .BI "int gnutls_x509_crl_privkey_sign(gnutls_x509_crl_t " crl ", gnutls_x509_crt_t " issuer ", gnutls_privkey_t " issuer_key ", gnutls_digest_algorithm_t " dig ", unsigned int " flags ");"
9 .SH ARGUMENTS
10 .IP "gnutls_x509_crl_t crl" 12
11 should contain a gnutls_x509_crl_t structure
12 .IP "gnutls_x509_crt_t issuer" 12
13 is the certificate of the certificate issuer
14 .IP "gnutls_privkey_t issuer_key" 12
15 holds the issuer's private key
16 .IP "gnutls_digest_algorithm_t dig" 12
17 The message digest to use. GNUTLS_DIG_SHA1 is the safe choice unless you know what you're doing.
18 .IP "unsigned int flags" 12
19 must be 0
20 .SH "DESCRIPTION"
21 This function will sign the CRL with the issuer's private key, and
22 will copy the issuer's information into the CRL.
23
24 This must be the last step in a certificate CRL since all
25 the previously set parameters are now signed.
26 .SH "RETURNS"
27 On success, \fBGNUTLS_E_SUCCESS\fP is returned, otherwise a
28 negative error value.
29 .SH "REPORTING BUGS"
30 Report bugs to <bug-gnutls@gnu.org>.
31 GnuTLS home page: http://www.gnu.org/software/gnutls/
32 General help using GNU software: http://www.gnu.org/gethelp/
33 .SH COPYRIGHT
34 Copyright \(co 2008 Free Software Foundation.
35 .br
36 Copying and distribution of this file, with or without modification,
37 are permitted in any medium without royalty provided the copyright
38 notice and this notice are preserved.
39 .SH "SEE ALSO"
40 The full documentation for
41 .B gnutls
42 is maintained as a Texinfo manual.  If the
43 .B info
44 and
45 .B gnutls
46 programs are properly installed at your site, the command
47 .IP
48 .B info gnutls
49 .PP
50 should give you access to the complete manual.