Reference the non-"legacy" provider names directly from EVP_md5(3) &c.
authorнаб <nabijaczleweli@nabijaczleweli.xyz>
Wed, 18 Oct 2023 13:35:55 +0000 (15:35 +0200)
committerMatt Caswell <matt@openssl.org>
Fri, 20 Oct 2023 15:46:57 +0000 (16:46 +0100)
Earlier today, it took me five manuals! to find what on earth the
"Performance"/"EVP_MD_fetch(3)" crosslinks actually mean:
  EVP_sha1(3)
  crypto(7)
  EVP_MD_fetch(3) (but not there! don't read that!)
  OSSL_PROVIDER-default(7)
  EVP_MD-SHA1(7)

If, instead, EVP_sha1(3) referenced EVP_MD-SHA1(7) at /all/,
which it should do, since it's supposed to be what you're replacing it
with, but it doesn't actually say that, maybe people would use it.
I know I didn't because it's basically just deadass buried

As found by git grep -l 'and should consider using'

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22420)

25 files changed:
doc/man3/EVP_aes_128_gcm.pod
doc/man3/EVP_aria_128_gcm.pod
doc/man3/EVP_bf_cbc.pod
doc/man3/EVP_blake2b512.pod
doc/man3/EVP_camellia_128_ecb.pod
doc/man3/EVP_cast5_cbc.pod
doc/man3/EVP_chacha20.pod
doc/man3/EVP_des_cbc.pod
doc/man3/EVP_desx_cbc.pod
doc/man3/EVP_idea_cbc.pod
doc/man3/EVP_md2.pod
doc/man3/EVP_md4.pod
doc/man3/EVP_md5.pod
doc/man3/EVP_mdc2.pod
doc/man3/EVP_rc2_cbc.pod
doc/man3/EVP_rc4.pod
doc/man3/EVP_rc5_32_12_16_cbc.pod
doc/man3/EVP_ripemd160.pod
doc/man3/EVP_seed_cbc.pod
doc/man3/EVP_sha1.pod
doc/man3/EVP_sha224.pod
doc/man3/EVP_sha3_224.pod
doc/man3/EVP_sm3.pod
doc/man3/EVP_sm4_cbc.pod
doc/man3/EVP_whirlpool.pod

index 067f17e8fc183df413a0aabb11dead4ff7f0f1b9..485705ea7889073dd706fa69be170e53ac6cdc7d 100644 (file)
@@ -167,7 +167,7 @@ the XTS "tweak" value.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-AES(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 92913652630d52d0c027de90dbfe28778a9e3b8a..91aa75ec387172ef6efe2e7ee3041d7b162bf42d 100644 (file)
@@ -96,7 +96,7 @@ correctly, see the L<EVP_EncryptInit(3)/AEAD Interface> section for details.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-ARIA(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 4df98f4bdf47ec1dfb29e1514f9dd1bd7fadcd96..11a909207ac954ae7b765487ab89c9eb7ab7efc0 100644 (file)
@@ -41,7 +41,7 @@ Blowfish encryption algorithm in CBC, CFB, ECB and OFB modes respectively.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-BLOWFISH(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 98e1899f6a935d0540e5ca3a13efe73d8e4b9a05..55bd9f3bce77dbee4470826718c9900d6ebce937 100644 (file)
@@ -35,7 +35,7 @@ The BLAKE2b algorithm that produces a 512-bit output from a given input.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-BLAKE2(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 While the BLAKE2b and BLAKE2s algorithms supports a variable length digest,
index a6b597156a77a9ebf8a456e6710e9be518bac6c8..cb6e12e2122b760e436f18ce3ff53105b425f05c 100644 (file)
@@ -79,7 +79,7 @@ Camellia for 128, 192 and 256 bit keys in the following modes: CBC, CFB with
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-CAMELLIA(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 85ff2ad014888f4eca7cbd0eb31626c4525abd56..7fef0598151d85f8f1c62b012061f0d1ca2a1d19 100644 (file)
@@ -41,7 +41,7 @@ CAST encryption algorithm in CBC, ECB, CFB and OFB modes respectively.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-CAST(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 683faa326e145309277cd0e9ec051f86087867f4..7e80c8de40c9ecf583c35a303944732d3587c0f2 100644 (file)
@@ -44,7 +44,7 @@ L<EVP_EncryptInit(3)/AEAD Interface> section for more information.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-CHACHA(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 L<RFC 7539|https://www.rfc-editor.org/rfc/rfc7539.html#section-2.4>
index 501216cd6d77b3c22fd63cdb63ea6de693fe97d3..442be8993a29f78846f0422777776b1acc61aab2 100644 (file)
@@ -89,7 +89,7 @@ Triple-DES key wrap according to RFC 3217 Section 3.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-DES(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index fae827192ee995e7a3c76e12c05cb010af42ff40..c22c0de47900c8805975a0ca4110a55ed5b80476 100644 (file)
@@ -31,7 +31,7 @@ implementation.
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-DES(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 5a9adaedc4462c2db84f2b107fd4cfb5149e368b..a36aae0bc999e3170f2ea97b805c049937c7677b 100644 (file)
@@ -39,7 +39,7 @@ The IDEA encryption algorithm in CBC, CFB, ECB and OFB modes respectively.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-IDEA(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 0b473887e01b97bdb72d1fc22f6b5f0336a45601..a6f3a010deb5aa08e8029b163bd5d52a246626ea 100644 (file)
@@ -28,7 +28,7 @@ The MD2 algorithm which produces a 128-bit output from a given input.
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-MD2(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index baaff9e4eaa2ac720b387473b96d91439855d3dd..a4e1a7d0a6e910ef080c20a712d75eb91ac2cf73 100644 (file)
@@ -29,7 +29,7 @@ The MD4 algorithm which produces a 128-bit output from a given input.
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-MD4(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 752fdd1f6c37b35b1e2e96366f0c8bcf747320d2..42370fb3d0a3299b30b87a2713513f286cf607c3 100644 (file)
@@ -40,7 +40,7 @@ WARNING: this algorithm is not intended for non-SSL usage.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-MD5(7)> or L<EVP_MD-MD5-SHA1(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index e9de6f3c560a61bf1919425734dc640ba5616967..3681bd06a63cd96dddddf75ddbd45710923cf2cf 100644 (file)
@@ -30,7 +30,7 @@ The MDC-2DES algorithm of using MDC-2 with the DES block cipher. It produces a
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-MDC2(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index bf4a13ba45c19c11fc669bfd99280caacf51844a..17f6f4b3e254da3cc469e4aa5576355e47589e26 100644 (file)
@@ -55,7 +55,7 @@ functions to set the key length and effective key length.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-RC2(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index f22e88a652147747adb0a7209429a4fe532f0f4f..0311ef278ca12d69d3d86a6f1885656665c1ff27 100644 (file)
@@ -47,7 +47,7 @@ interface.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-RC4(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index c177b1845196f2bcb68886a62ae42a4deaa168c2..69fc2f2cc656b975e596ee413df31c550ad1b3d7 100644 (file)
@@ -60,7 +60,7 @@ is an int.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-RC5(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 6ad2d3e0186968236ad0604cef608a446de9a23d..5b96fd09f85037938968ec9d0d1f80d0a4f94887 100644 (file)
@@ -29,7 +29,7 @@ The RIPEMD-160 algorithm which produces a 160-bit output from a given input.
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-RIPEMD160(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 010607e5740590b70fff5063ab51f5a9364e3f71..2c821d07c3993a12d0e3078732d22daa511465db 100644 (file)
@@ -41,7 +41,7 @@ The SEED encryption algorithm in CBC, CFB, ECB and OFB modes respectively.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-SEED(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 264ddd1addb717f02d6e8684508608e64022430b..6fc8f07b066a6f8dfd02614249e661e3ce8e8233 100644 (file)
@@ -29,7 +29,7 @@ The SHA-1 algorithm which produces a 160-bit output from a given input.
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-SHA1(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 7a50cf9b6c3f15ece50209e004eadc409ea1186a..be09e49ee39325dd462a331b3e29fb596ba1d76a 100644 (file)
@@ -49,7 +49,7 @@ their outputs are of the same size.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-SHA2(7)>instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 5bb9ae1b89e55015705f14cbe3a0961e3653fe73..93c0d0b9fb1e0f8e2bbb6515be9f53ccbc517c95 100644 (file)
@@ -54,7 +54,7 @@ B<EVP_shake256> provides that of 256 bits.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-SHA3(7)> or L<EVP_MD-SHAKE(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index 4e8112dc0afee2b8548757e0040d18271e238db6..65be55e88dba8d207f2c0944b04927f60a8b39ef 100644 (file)
@@ -28,7 +28,7 @@ The SM3 hash function.
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-SM3(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index b67ade549968c5a4df082fb5835ea6412863f109..48be7a31ad756d01752e8d4554f802184ff89416 100644 (file)
@@ -45,7 +45,7 @@ respectively.
 
 Developers should be aware of the negative performance implications of
 calling these functions multiple times and should consider using
-L<EVP_CIPHER_fetch(3)> instead.
+L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-SM4(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES
index a9826e290a4279c1b7cac8716b72271312105b01..c5d465b16f0c3cc7727479b39c3cd4761713e3da 100644 (file)
@@ -30,7 +30,7 @@ input.
 
 Developers should be aware of the negative performance implications of
 calling this function multiple times and should consider using
-L<EVP_MD_fetch(3)> instead.
+L<EVP_MD_fetch(3)> with L<EVP_MD-WHIRLPOOL(7)> instead.
 See L<crypto(7)/Performance> for further information.
 
 =head1 RETURN VALUES