Rename OSSL_SERIALIZER / OSSL_DESERIALIZER to OSSL_ENCODE / OSSL_DECODE

[openssl.git] / doc / man3 / DH_size.pod

diff --git a/doc/man3/DH_size.pod b/doc/man3/DH_size.pod
index c118bf32348ab7a5ed96c2066e60e15cd1c89205..099c1bad3f8e45f312fbd1b33cc4cd8277c5fd8a 100644 (file)
--- a/doc/man3/DH_size.pod
+++ b/doc/man3/DH_size.pod
@@ -2,44 +2,65 @@
 
 =head1 NAME
 
-DH_size, DH_bits - get Diffie-Hellman prime size
+DH_size, DH_bits, DH_security_bits - get Diffie-Hellman prime size and
+security bits
 
 =head1 SYNOPSIS
 
-#include <openssl/dh.h>
+ #include <openssl/dh.h>
 
-int DH_size(const DH *dh);
+ int DH_bits(const DH *dh);
 
-int DH_bits(const DH *dh);
+Deprecated since OpenSSL 3.0, can be hidden entirely by defining
+B<OPENSSL_API_COMPAT> with a suitable version value, see
+L<openssl_user_macros(7)>:
+
+ int DH_size(const DH *dh);
+
+ int DH_security_bits(const DH *dh);
 
 =head1 DESCRIPTION
 
+DH_bits() returns the number of significant bits.
+
+B<dh> and B<dh-E<gt>p> must not be B<NULL>.
+
+The remaining functions described on this page are deprecated.
+Applications should instead use L<EVP_PKEY_security_bits(3)> and
+L<EVP_PKEY_size(3)>.
+
 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 DH_compute_key().
+computed by L<DH_compute_key(3)>.
 
-DH_bits() returns the number of significant bits.
+DH_security_bits() returns the number of security bits of the given B<dh>
+key. See L<BN_security_bits(3)>.
 
-B<dh> and B<dh-E<gt>p> must not be B<NULL>.
+=head1 RETURN VALUES
 
-=head1 RETURN VALUE
+DH_bits() returns the number of bits in the key.
 
-The size.
+DH_size() returns the prime size of Diffie-Hellman in bytes.
+
+DH_security_bits() returns the number of security bits.
 
 =head1 SEE ALSO
 
+L<EVP_PKEY_bits(3)>,
 L<DH_new(3)>, L<DH_generate_key(3)>,
 L<BN_num_bits(3)>
 
 =head1 HISTORY
 
-DH_bits() was added in OpenSSL 1.1.0.
+The DH_size() and DH_security_bits() functions were deprecated in OpenSSL 3.0.
+
+The DH_bits() function was added in OpenSSL 1.1.0.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2000-2020 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>.