Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_rsa_params_generate2.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_rsa_params_generate2" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_rsa_params_generate2 \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "int gnutls_rsa_params_generate2(gnutls_rsa_params_t " params ", unsigned int " bits ");"
9 .SH ARGUMENTS
10 .IP "gnutls_rsa_params_t params" 12
11 The structure where the parameters will be stored
12 .IP "unsigned int bits" 12
13 is the prime's number of bits
14 .SH "DESCRIPTION"
15 This function will generate new temporary RSA parameters for use in
16 RSA\-EXPORT ciphersuites.  This function is normally slow.
17
18 Note that if the parameters are to be used in export cipher suites the
19 bits value should be 512 or less.
20 Also note that the generation of new RSA parameters is only useful
21 to servers. Clients use the parameters sent by the server, thus it's
22 no use calling this in client side.
23 .SH "RETURNS"
24 \fBGNUTLS_E_SUCCESS\fP on success, or an negative error code.
25 .SH "REPORTING BUGS"
26 Report bugs to <bug-gnutls@gnu.org>.
27 GnuTLS home page: http://www.gnu.org/software/gnutls/
28 General help using GNU software: http://www.gnu.org/gethelp/
29 .SH COPYRIGHT
30 Copyright \(co 2008 Free Software Foundation.
31 .br
32 Copying and distribution of this file, with or without modification,
33 are permitted in any medium without royalty provided the copyright
34 notice and this notice are preserved.
35 .SH "SEE ALSO"
36 The full documentation for
37 .B gnutls
38 is maintained as a Texinfo manual.  If the
39 .B info
40 and
41 .B gnutls
42 programs are properly installed at your site, the command
43 .IP
44 .B info gnutls
45 .PP
46 should give you access to the complete manual.