summaryrefslogtreecommitdiffstats
path: root/doc/manpages/gnutls_dh_params_generate2.3
blob: a321b14c4fa8149b2a376830e5d803aa668eb527 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
.\" DO NOT MODIFY THIS FILE!  It was generated by gdoc.
.TH "gnutls_dh_params_generate2" 3 "3.7.9" "gnutls" "gnutls"
.SH NAME
gnutls_dh_params_generate2 \- API function
.SH SYNOPSIS
.B #include <gnutls/gnutls.h>
.sp
.BI "int gnutls_dh_params_generate2(gnutls_dh_params_t " dparams ", unsigned int " bits ");"
.SH ARGUMENTS
.IP "gnutls_dh_params_t dparams" 12
The parameters
.IP "unsigned int bits" 12
is the prime's number of bits
.SH "DESCRIPTION"
This function will generate a new pair of prime and generator for use in
the Diffie\-Hellman key exchange. This may take long time.

It is recommended not to set the number of bits directly, but 
use \fBgnutls_sec_param_to_pk_bits()\fP instead.
Also note that the DH parameters are only useful to servers.
Since clients use the parameters sent by the server, it's of
no use to call this in client side.

The parameters generated are of the DSA form. It also is possible
to generate provable parameters (following the Shawe\-Taylor
algorithm), using \fBgnutls_x509_privkey_generate2()\fP with DSA option
and the \fBGNUTLS_PRIVKEY_FLAG_PROVABLE\fP flag set. These can the
be imported with \fBgnutls_dh_params_import_dsa()\fP.

It is no longer recommended for applications to generate parameters.
See the "Parameter generation" section in the manual.
.SH "RETURNS"
On success, \fBGNUTLS_E_SUCCESS\fP (0) is returned,
otherwise a negative error code is returned.
.SH "REPORTING BUGS"
Report bugs to <bugs@gnutls.org>.
.br
Home page: https://www.gnutls.org

.SH COPYRIGHT
Copyright \(co 2001- Free Software Foundation, Inc., and others.
.br
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.
.SH "SEE ALSO"
The full documentation for
.B gnutls
is maintained as a Texinfo manual.
If the /usr/share/doc/gnutls/
directory does not contain the HTML form visit
.B
.IP https://www.gnutls.org/manual/
.PP