aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPauli <paul.dale@oracle.com>2020-04-28 19:03:05 +1000
committerPauli <paul.dale@oracle.com>2020-04-30 14:51:37 +1000
commit588d5d01fefde6a3437d6749b4435c41180df868 (patch)
tree994be003296d8884c72fb40ef5a5fa36d7769446 /doc
parent036ee3706352970a15300b5cd4bf0b2cb370e12a (diff)
downloadopenssl-588d5d01fefde6a3437d6749b4435c41180df868.tar.gz
Undeprecate DH, DSA and RSA _bits() functions.
These were deemed information and useful and that they should not be deprecated. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/11669)
Diffstat (limited to 'doc')
-rw-r--r--doc/man3/DH_size.pod24
-rw-r--r--doc/man3/DSA_size.pod22
-rw-r--r--doc/man3/RSA_size.pod20
3 files changed, 34 insertions, 32 deletions
diff --git a/doc/man3/DH_size.pod b/doc/man3/DH_size.pod
index 98452524b6..099c1bad3f 100644
--- a/doc/man3/DH_size.pod
+++ b/doc/man3/DH_size.pod
@@ -9,39 +9,39 @@ security bits
#include <openssl/dh.h>
+ 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_bits(const DH *dh);
-
int DH_security_bits(const DH *dh);
=head1 DESCRIPTION
-All of the functions described on this page are deprecated.
-Applications should instead use L<EVP_PKEY_bits(3)>,
-L<EVP_PKEY_security_bits(3)> and L<EVP_PKEY_size(3)>.
+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 L<DH_compute_key(3)>.
-DH_bits() returns the number of significant bits.
-
-B<dh> and B<dh-E<gt>p> must not be B<NULL>.
-
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.
+DH_size() returns the prime size of Diffie-Hellman in bytes.
+
DH_security_bits() returns the number of security bits.
=head1 SEE ALSO
@@ -52,7 +52,7 @@ L<BN_num_bits(3)>
=head1 HISTORY
-All of these functions were deprecated in OpenSSL 3.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.
diff --git a/doc/man3/DSA_size.pod b/doc/man3/DSA_size.pod
index 2d74eea365..404f1bb231 100644
--- a/doc/man3/DSA_size.pod
+++ b/doc/man3/DSA_size.pod
@@ -8,19 +8,24 @@ DSA_size, DSA_bits, DSA_security_bits - get DSA signature size, key bits or secu
#include <openssl/dsa.h>
+ int DSA_bits(const DSA *dsa);
+
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 DSA_size(const DSA *dsa);
- int DSA_bits(const DSA *dsa);
+
int DSA_security_bits(const DSA *dsa);
=head1 DESCRIPTION
-All of the functions described on this page are deprecated.
-Applications should instead use L<EVP_PKEY_bits(3)>,
-L<EVP_PKEY_security_bits(3)> and L<EVP_PKEY_size(3)>.
+DSA_bits() returns the number of bits in key B<dsa>: this is the number
+of bits in the B<p> parameter.
+
+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)>.
DSA_size() returns the maximum size of an ASN.1 encoded DSA signature
for key B<dsa> in bytes. It can be used to determine how much memory must
@@ -28,18 +33,15 @@ be allocated for a DSA signature.
B<dsa-E<gt>q> must not be B<NULL>.
-DSA_bits() returns the number of bits in key B<dsa>: this is the number
-of bits in the B<p> parameter.
-
DSA_security_bits() returns the number of security bits of the given B<dsa>
key. See L<BN_security_bits(3)>.
=head1 RETURN VALUES
-DSA_size() returns the signature size in bytes.
-
DSA_bits() returns the number of bits in the key.
+DSA_size() returns the signature size in bytes.
+
=head1 SEE ALSO
L<EVP_PKEY_bits(3)>,
@@ -49,7 +51,7 @@ L<DSA_new(3)>, L<DSA_sign(3)>
=head1 HISTORY
-All of these functions were deprecated in OpenSSL 3.0.
+The DSA_size() and DSA_security_bits() functions were deprecated in OpenSSL 3.0.
=head1 COPYRIGHT
diff --git a/doc/man3/RSA_size.pod b/doc/man3/RSA_size.pod
index b2a7c96788..a23f51abc2 100644
--- a/doc/man3/RSA_size.pod
+++ b/doc/man3/RSA_size.pod
@@ -8,19 +8,23 @@ RSA_size, RSA_bits, RSA_security_bits - get RSA modulus size or security bits
#include <openssl/rsa.h>
+ int RSA_bits(const RSA *rsa);
+
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 RSA_size(const RSA *rsa);
- int RSA_bits(const RSA *rsa);
-
int RSA_security_bits(const RSA *rsa)
=head1 DESCRIPTION
-All of the functions described on this page are deprecated.
+RSA_bits() returns the number of significant bits.
+
+B<rsa> and B<rsa-E<gt>n> must not be B<NULL>.
+
+The remaining functions described on this page are deprecated.
Applications should instead use L<EVP_PKEY_size(3)>, L<EVP_PKEY_bits(3)>
and L<EVP_PKEY_security_bits(3)>.
@@ -28,18 +32,14 @@ RSA_size() returns the RSA modulus size in bytes. It can be used to
determine how much memory must be allocated for an RSA encrypted
value.
-RSA_bits() returns the number of significant bits.
-
-B<rsa> and B<rsa-E<gt>n> must not be B<NULL>.
-
RSA_security_bits() returns the number of security bits of the given B<rsa>
key. See L<BN_security_bits(3)>.
=head1 RETURN VALUES
-RSA_size() returns the size of modulus in bytes.
+RSA_bits() returns the number of bits in the key.
-DSA_bits() returns the number of bits in the key.
+RSA_size() returns the size of modulus in bytes.
RSA_security_bits() returns the number of security bits.
@@ -49,7 +49,7 @@ L<BN_num_bits(3)>
=head1 HISTORY
-All of these functions were deprecated in OpenSSL 3.0.
+The RSA_size() and RSA_security_bits() functions were deprecated in OpenSSL 3.0.
The RSA_bits() function was added in OpenSSL 1.1.0.