diff options
Diffstat (limited to 'doc/man3/DH_generate_parameters.pod')
| -rw-r--r-- | doc/man3/DH_generate_parameters.pod | 33 |
1 files changed, 28 insertions, 5 deletions
diff --git a/doc/man3/DH_generate_parameters.pod b/doc/man3/DH_generate_parameters.pod index 3c847104327a..9c1dff7aedd9 100644 --- a/doc/man3/DH_generate_parameters.pod +++ b/doc/man3/DH_generate_parameters.pod @@ -12,6 +12,10 @@ parameters #include <openssl/dh.h> +The following functions have been deprecated since OpenSSL 3.0, and can be +hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, +see L<openssl_user_macros(7)>: + int DH_generate_parameters_ex(DH *dh, int prime_len, int generator, BN_GENCB *cb); int DH_check(DH *dh, int *codes); @@ -21,15 +25,20 @@ parameters int DH_check_params_ex(const DH *dh); int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key); -Deprecated: +The following functions have been deprecated since OpenSSL 0.9.8, and can be +hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, +see L<openssl_user_macros(7)>: - #if OPENSSL_API_COMPAT < 0x00908000L DH *DH_generate_parameters(int prime_len, int generator, void (*callback)(int, int, void *), void *cb_arg); - #endif =head1 DESCRIPTION +All of the functions described on this page are deprecated. +Applications should instead use L<EVP_PKEY_check(3)>, +L<EVP_PKEY_public_check(3)>, L<EVP_PKEY_private_check(3)> and +L<EVP_PKEY_param_check(3)>. + DH_generate_parameters_ex() generates Diffie-Hellman parameters that can be shared among a group of users, and stores them in the provided B<DH> structure. The pseudo-random number generator must be @@ -73,6 +82,14 @@ The generator B<g> is not suitable. Note that the lack of this bit doesn't guarantee that B<g> is suitable, unless B<p> is known to be a strong prime. +=item DH_MODULUS_TOO_SMALL + +The modulus is too small. + +=item DH_MODULUS_TOO_LARGE + +The modulus is too large. + =back DH_check() confirms that the Diffie-Hellman parameters B<dh> are valid. The @@ -111,6 +128,10 @@ The parameter B<j> is invalid. =back +If 0 is returned or B<*codes> is set to a nonzero value the supplied +parameters should not be used for Diffie-Hellman operations otherwise +the security properties of the key exchange are not guaranteed. + DH_check_ex(), DH_check_params() and DH_check_pub_key_ex() are similar to DH_check() and DH_check_params() respectively, but the error reasons are added to the thread's error queue instead of provided as return values from the @@ -136,14 +157,16 @@ L<DH_free(3)> =head1 HISTORY +All of these functions were deprecated in OpenSSL 3.0. + DH_generate_parameters() was deprecated in OpenSSL 0.9.8; use DH_generate_parameters_ex() instead. =head1 COPYRIGHT -Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved. -Licensed under the OpenSSL license (the "License"). You may not use +Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at L<https://www.openssl.org/source/license.html>. |