b71497baaf1266ed8be560f12cf2b4978295fe3c
[openssl.git] / doc / man3 / DH_generate_parameters.pod
1 =pod
2
3 =head1 NAME
4
5 DH_generate_parameters_ex, DH_generate_parameters,
6 DH_check - generate and check Diffie-Hellman parameters
7
8 =head1 SYNOPSIS
9
10  #include <openssl/dh.h>
11
12  int DH_generate_parameters_ex(DH *dh, int prime_len, int generator, BN_GENCB *cb);
13
14  int DH_check(DH *dh, int *codes);
15
16 Deprecated:
17
18  #if OPENSSL_API_COMPAT < 0x00908000L
19  DH *DH_generate_parameters(int prime_len, int generator,
20      void (*callback)(int, int, void *), void *cb_arg);
21  #endif
22
23 =head1 DESCRIPTION
24
25 DH_generate_parameters_ex() generates Diffie-Hellman parameters that can
26 be shared among a group of users, and stores them in the provided B<DH>
27 structure. The pseudo-random number generator must be
28 seeded prior to calling DH_generate_parameters().
29
30 B<prime_len> is the length in bits of the safe prime to be generated.
31 B<generator> is a small number E<gt> 1, typically 2 or 5.
32
33 A callback function may be used to provide feedback about the progress
34 of the key generation. If B<cb> is not B<NULL>, it will be
35 called as described in L<BN_generate_prime(3)> while a random prime
36 number is generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)>
37 is called. See L<BN_generate_prime(3)> for information on
38 the BN_GENCB_call() function.
39
40 DH_check() confirms that the Diffie-Hellman parameters B<dh> are valid. The
41 value of B<*codes> is updated with any problems found. If B<*codes> is zero then
42 no problems were found, otherwise the following bits may be set:
43
44 =over 4
45
46 =item DH_CHECK_P_NOT_PRIME
47
48 The parameter B<p> is not prime.
49
50 =item DH_CHECK_P_NOT_SAFE_PRIME
51
52 The parameter B<p> is not a safe prime and no B<q> value is present.
53
54 =item DH_UNABLE_TO_CHECK_GENERATOR
55
56 The generator B<g> cannot be checked for suitability.
57
58 =item DH_NOT_SUITABLE_GENERATOR
59
60 The generator B<g> is not suitable.
61
62 =item DH_CHECK_Q_NOT_PRIME
63
64 The parameter B<q> is not prime.
65
66 =item DH_CHECK_INVALID_Q_VALUE
67
68 The parameter B<q> is invalid.
69
70 =item DH_CHECK_INVALID_J_VALUE
71
72 The parameter B<j> is invalid.
73
74 =back
75
76 =head1 RETURN VALUES
77
78 DH_generate_parameters_ex() and DH_check() return 1 if the check could be
79 performed, 0 otherwise.
80
81 DH_generate_parameters() (deprecated) returns a pointer to the DH structure, or
82 NULL if the parameter generation fails.
83
84 The error codes can be obtained by L<ERR_get_error(3)>.
85
86 =head1 NOTES
87
88 DH_generate_parameters_ex() and DH_generate_parameters() may run for several
89 hours before finding a suitable prime.
90
91 The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters()
92 are not to be used in signature schemes.
93
94 =head1 SEE ALSO
95
96 L<dh(3)>, L<ERR_get_error(3)>, L<rand(3)>,
97 L<DH_free(3)>
98
99 =head1 COPYRIGHT
100
101 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
102
103 Licensed under the OpenSSL license (the "License").  You may not use
104 this file except in compliance with the License.  You can obtain a copy
105 in the file LICENSE in the source distribution or at
106 L<https://www.openssl.org/source/license.html>.
107
108 =cut