diff options
Diffstat (limited to 'doc/man3/DH_size.pod')
| -rw-r--r-- | doc/man3/DH_size.pod | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/doc/man3/DH_size.pod b/doc/man3/DH_size.pod index 3cbdbc67da1c..81b73a8c6647 100644 --- a/doc/man3/DH_size.pod +++ b/doc/man3/DH_size.pod @@ -9,47 +9,59 @@ security bits #include <openssl/dh.h> - int DH_size(const DH *dh); +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_bits(const DH *dh); + int DH_size(const DH *dh); + int DH_security_bits(const DH *dh); =head1 DESCRIPTION -DH_size() returns the Diffie-Hellman prime size in bytes. It can be used -to determine how much memory must be allocated for the shared secret -computed by L<DH_compute_key(3)>. +The functions described on this page are deprecated. +Applications should instead use L<EVP_PKEY_get_bits(3)>, +L<EVP_PKEY_get_security_bits(3)> and L<EVP_PKEY_get_size(3)>. DH_bits() returns the number of significant bits. B<dh> and B<dh-E<gt>p> must not be B<NULL>. +DH_size() returns the Diffie-Hellman prime size in bytes. It can be used +to determine how much memory must be allocated for the shared secret +computed by L<DH_compute_key(3)>. + DH_security_bits() returns the number of security bits of the given B<dh> key. See L<BN_security_bits(3)>. =head1 RETURN VALUES -DH_size() returns the prime size of Diffie-Hellman in bytes. +DH_bits() returns the number of bits in the key, or -1 if +B<dh> doesn't hold any key parameters. -DH_bits() returns the number of bits in the key. +DH_size() returns the prime size of Diffie-Hellman in bytes, or -1 if +B<dh> doesn't hold any key parameters. -DH_security_bits() returns the number of security bits. +DH_security_bits() returns the number of security bits, or -1 if +B<dh> doesn't hold any key parameters. =head1 SEE ALSO +L<EVP_PKEY_get_bits(3)>, L<DH_new(3)>, L<DH_generate_key(3)>, L<BN_num_bits(3)> =head1 HISTORY -The DH_bits() function was added in OpenSSL 1.1.0. +All functions were deprecated in OpenSSL 3.0. =head1 COPYRIGHT -Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000-2021 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>. |