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