DOCS: Start restructuring our provider and implementation documentation
[openssl.git] / doc / man7 / OSSL_PROVIDER-legacy.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_PROVIDER-legacy - OpenSSL legacy provider
6
7 =head1 DESCRIPTION
8
9 The OpenSSL legacy provider supplies OpenSSL implementations of algorithms
10 that have been deemed legacy.  Such algorithms have commonly fallen out of
11 use, have been deemed insecure by the cryptography community, or something
12 similar.
13
14 We can consider this the retirement home of cryptographic algorithms.
15
16 =head2 Properties
17
18 The implementations in this provider specifically have these property
19 defined:
20
21 =over 4
22
23 "provider=legacy"
24
25 =back
26
27 It may be used in a property query string with fetching functions such as
28 L<EVP_MD_fetch(3)> or L<EVP_CIPHER_fetch(3)>, as well as with other
29 functions that take a property query string, such as
30 L<EVP_PKEY_CTX_new_from_name(3)>.
31
32 It isn't mandatory to query for any of these properties, except to
33 make sure to get implementations of this provider and none other.
34
35 =head1 OPERATIONS AND ALGORITHMS
36
37 The OpenSSL legacy provider supports these operations and algorithms:
38
39 =head2 Hashing Algorithms / Message Digests
40
41 =over 4
42
43 =item MD2, see L<EVP_MD-MD2(7)>
44
45 =item MD4, see L<EVP_MD-MD4(7)>
46
47 =item MDC2, see L<EVP_MD-MDC2(7)>
48
49 =item WHIRLPOOL, see L<EVP_MD-WHIRLPOOL(7)>
50
51 =item RIPEMD160, see L<EVP_MD-RIPEMD160(7)>
52
53 =back
54
55 =begin comment
56
57 When algorithms for other operations start appearing, the
58 following =head2 titles are appropriate to use:
59
60 - Symmetric Ciphers
61
62 - Message Authentication Code (MAC)
63
64 - Key Derivation Function (KDF)
65
66 - Key Exchange
67
68 - Signature
69
70 - Asymmetric Cipher
71
72 - Asymmetric Key Management
73
74 =end comment
75
76 =head1 SEE ALSO
77
78 L<OSSL_PARAM(3)>,
79 L<openssl-core.h(7)>,
80 L<openssl-core_numbers.h(7)>,
81 L<provider(7)>
82
83 =head1 COPYRIGHT
84
85 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
86
87 Licensed under the Apache License 2.0 (the "License").  You may not use
88 this file except in compliance with the License.  You can obtain a copy
89 in the file LICENSE in the source distribution or at
90 L<https://www.openssl.org/source/license.html>.
91
92 =cut