Skip to content

Commit

Permalink
Reference the non-"legacy" provider names directly from EVP_md5(3) &c.
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-by: Matt Caswell <[email protected]>
(Merged from openssl#22420)
  • Loading branch information
nabijaczleweli authored and mattcaswell committed Oct 20, 2023
1 parent 039119a commit b6eb95f
Show file tree
Hide file tree
Showing 25 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion doc/man3/EVP_aes_128_gcm.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_aria_128_gcm.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_bf_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_blake2b512.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_camellia_128_ecb.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_cast5_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_chacha20.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_des_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_desx_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_idea_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_md2.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_md4.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_md5.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_mdc2.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_rc2_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_rc4.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_rc5_32_12_16_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_ripemd160.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_seed_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_sha1.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_sha224.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_sha3_224.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_sm3.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_sm4_cbc.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/EVP_whirlpool.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit b6eb95f

Please sign in to comment.