Rename OSSL_SERIALIZER / OSSL_DESERIALIZER to OSSL_ENCODE / OSSL_DECODE
[openssl.git] / doc / man3 / RSA_size.pod
index b087ece39ce457aef77d91ef11a875794b9e4802..6e3451f22c313103370a9bbfaf1db5e85cef70f1 100644 (file)
@@ -8,30 +8,38 @@ RSA_size, RSA_bits, RSA_security_bits - get RSA modulus size or security bits
 
  #include <openssl/rsa.h>
 
- int RSA_size(const RSA *rsa);
-
  int RSA_bits(const RSA *rsa);
 
- int RSA_security_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)>:
 
-=head1 DESCRIPTION
+ int RSA_size(const RSA *rsa);
 
-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.
+ int RSA_security_bits(const RSA *rsa);
+
+=head1 DESCRIPTION
 
 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)>.
+
+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_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.
 
@@ -41,11 +49,13 @@ L<BN_num_bits(3)>
 
 =head1 HISTORY
 
-RSA_bits() was added in OpenSSL 1.1.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.
 
 =head1 COPYRIGHT
 
-Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
 
 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