4908dcf515b2bb34cdde663a982fb8f9f15d88f1
[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, DH_check_params,
7 DH_check_ex, DH_check_params_ex, DH_check_pub_key_ex
8 - generate and check Diffie-Hellman
9 parameters
10
11 =head1 SYNOPSIS
12
13  #include <openssl/dh.h>
14
15  int DH_generate_parameters_ex(DH *dh, int prime_len, int generator, BN_GENCB *cb);
16
17  int DH_check(DH *dh, int *codes);
18  int DH_check_params(DH *dh, int *codes);
19
20  int DH_check_ex(const DH *dh);
21  int DH_check_params_ex(const DH *dh);
22  int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key);
23
24 Deprecated since OpenSSL 0.9.8, can be hidden entirely by defining
25 B<OPENSSL_API_COMPAT> with a suitable version value, see
26 L<openssl_user_macros(7)>:
27
28  DH *DH_generate_parameters(int prime_len, int generator,
29                             void (*callback)(int, int, void *), void *cb_arg);
30
31 =head1 DESCRIPTION
32
33 DH_generate_parameters_ex() generates Diffie-Hellman parameters that can
34 be shared among a group of users, and stores them in the provided B<DH>
35 structure. The pseudo-random number generator must be
36 seeded before calling it.
37 The parameters generated by DH_generate_parameters_ex() should not be used in
38 signature schemes.
39
40 B<prime_len> is the length in bits of the safe prime to be generated.
41 B<generator> is a small number E<gt> 1, typically 2 or 5.
42
43 A callback function may be used to provide feedback about the progress
44 of the key generation. If B<cb> is not B<NULL>, it will be
45 called as described in L<BN_generate_prime(3)> while a random prime
46 number is generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)>
47 is called. See L<BN_generate_prime_ex(3)> for information on
48 the BN_GENCB_call() function.
49
50 DH_generate_parameters() is similar to DH_generate_prime_ex() but
51 expects an old-style callback function; see
52 L<BN_generate_prime(3)> for information on the old-style callback.
53
54 DH_check_params() confirms that the B<p> and B<g> are likely enough to
55 be valid.
56 This is a lightweight check, if a more thorough check is needed, use
57 DH_check().
58 The value of B<*codes> is updated with any problems found.
59 If B<*codes> is zero then no problems were found, otherwise the
60 following bits may be set:
61
62 =over 4
63
64 =item DH_CHECK_P_NOT_PRIME
65
66 The parameter B<p> has been determined to not being an odd prime.
67 Note that the lack of this bit doesn't guarantee that B<p> is a
68 prime.
69
70 =item DH_NOT_SUITABLE_GENERATOR
71
72 The generator B<g> is not suitable.
73 Note that the lack of this bit doesn't guarantee that B<g> is
74 suitable, unless B<p> is known to be a strong prime.
75
76 =item DH_MODULUS_TOO_SMALL
77
78 The modulus is too small.
79
80 =item DH_MODULUS_TOO_LARGE
81
82 The modulus is too large.
83
84 =back
85
86 DH_check() confirms that the Diffie-Hellman parameters B<dh> are valid. The
87 value of B<*codes> is updated with any problems found. If B<*codes> is zero then
88 no problems were found, otherwise the following bits may be set:
89
90 =over 4
91
92 =item DH_CHECK_P_NOT_PRIME
93
94 The parameter B<p> is not prime.
95
96 =item DH_CHECK_P_NOT_SAFE_PRIME
97
98 The parameter B<p> is not a safe prime and no B<q> value is present.
99
100 =item DH_UNABLE_TO_CHECK_GENERATOR
101
102 The generator B<g> cannot be checked for suitability.
103
104 =item DH_NOT_SUITABLE_GENERATOR
105
106 The generator B<g> is not suitable.
107
108 =item DH_CHECK_Q_NOT_PRIME
109
110 The parameter B<q> is not prime.
111
112 =item DH_CHECK_INVALID_Q_VALUE
113
114 The parameter B<q> is invalid.
115
116 =item DH_CHECK_INVALID_J_VALUE
117
118 The parameter B<j> is invalid.
119
120 =back
121
122 DH_check_ex(), DH_check_params() and DH_check_pub_key_ex() are similar to
123 DH_check() and DH_check_params() respectively, but the error reasons are added
124 to the thread's error queue instead of provided as return values from the
125 function.
126
127 =head1 RETURN VALUES
128
129 DH_generate_parameters_ex(), DH_check() and DH_check_params() return 1
130 if the check could be performed, 0 otherwise.
131
132 DH_generate_parameters() returns a pointer to the DH structure or NULL if
133 the parameter generation fails.
134
135 DH_check_ex(), DH_check_params() and DH_check_pub_key_ex() return 1 if the
136 check is successful, 0 for failed.
137
138 The error codes can be obtained by L<ERR_get_error(3)>.
139
140 =head1 SEE ALSO
141
142 L<DH_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
143 L<DH_free(3)>
144
145 =head1 HISTORY
146
147 DH_generate_parameters() was deprecated in OpenSSL 0.9.8; use
148 DH_generate_parameters_ex() instead.
149
150 =head1 COPYRIGHT
151
152 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
153
154 Licensed under the Apache License 2.0 (the "License").  You may not use
155 this file except in compliance with the License.  You can obtain a copy
156 in the file LICENSE in the source distribution or at
157 L<https://www.openssl.org/source/license.html>.
158
159 =cut