Tizen 2.0 Release
[external/libgnutls26.git] / doc / manpages / gnutls_srp_set_prime_bits.3
1 .\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
2 .TH "gnutls_srp_set_prime_bits" 3 "2.12.6.1" "gnutls" "gnutls"
3 .SH NAME
4 gnutls_srp_set_prime_bits \- API function
5 .SH SYNOPSIS
6 .B #include <gnutls/gnutls.h>
7 .sp
8 .BI "void gnutls_srp_set_prime_bits(gnutls_session_t " session ", unsigned int " bits ");"
9 .SH ARGUMENTS
10 .IP "gnutls_session_t session" 12
11 is a \fBgnutls_session_t\fP structure.
12 .IP "unsigned int bits" 12
13 is the number of bits
14 .SH "DESCRIPTION"
15 This function sets the minimum accepted number of bits, for use in
16 an SRP key exchange.  If zero, the default 2048 bits will be used.
17
18 In the client side it sets the minimum accepted number of bits.  If
19 a server sends a prime with less bits than that
20 \fBGNUTLS_E_RECEIVED_ILLEGAL_PARAMETER\fP will be returned by the
21 handshake.
22
23 This function has no effect in server side.
24 .SH "SINCE"
25 2.6.0
26 .SH "REPORTING BUGS"
27 Report bugs to <bug-gnutls@gnu.org>.
28 GnuTLS home page: http://www.gnu.org/software/gnutls/
29 General help using GNU software: http://www.gnu.org/gethelp/
30 .SH COPYRIGHT
31 Copyright \(co 2008 Free Software Foundation.
32 .br
33 Copying and distribution of this file, with or without modification,
34 are permitted in any medium without royalty provided the copyright
35 notice and this notice are preserved.
36 .SH "SEE ALSO"
37 The full documentation for
38 .B gnutls
39 is maintained as a Texinfo manual.  If the
40 .B info
41 and
42 .B gnutls
43 programs are properly installed at your site, the command
44 .IP
45 .B info gnutls
46 .PP
47 should give you access to the complete manual.