]> git.ipfire.org Git - thirdparty/openssl.git/blob - doc/man7/OSSL_PROVIDER-default.pod
Document the list of RAND algorithms in the default and fips providers.
[thirdparty/openssl.git] / doc / man7 / OSSL_PROVIDER-default.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_PROVIDER-default - OpenSSL default provider
6
7 =head1 DESCRIPTION
8
9 The OpenSSL default provider supplies the majority of OpenSSL's diverse
10 algorithm implementations. If an application doesn't specify anything else
11 explicitly (e.g. in the application or via config), then this is the
12 provider that will be used as fallback: It is loaded automatically the
13 first time that an algorithm is fetched from a provider or a function
14 acting on providers is called and no other provider has been loaded yet.
15
16 If an attempt to load a provider has already been made (whether successful
17 or not) then the default provider won't be loaded automatically. Therefore
18 if the default provider is to be used in conjunction with other providers
19 then it must be loaded explicitly. Automatic loading of the default
20 provider only occurs a maximum of once; if the default provider is
21 explicitly unloaded then the default provider will not be automatically
22 loaded again.
23
24 =head2 Properties
25
26 The implementations in this provider specifically have this property
27 defined:
28
29 =over 4
30
31 =item "provider=default"
32
33 =back
34
35 It may be used in a property query string with fetching functions such as
36 L<EVP_MD_fetch(3)> or L<EVP_CIPHER_fetch(3)>, as well as with other
37 functions that take a property query string, such as
38 L<EVP_PKEY_CTX_new_from_name(3)>.
39
40 It isn't mandatory to query for this property, except to make sure to get
41 implementations of this provider and none other.
42
43 Some implementations may define additional properties. Exact information is
44 listed below
45
46 =head1 OPERATIONS AND ALGORITHMS
47
48 The OpenSSL default provider supports these operations and algorithms:
49
50 =head2 Hashing Algorithms / Message Digests
51
52 =over 4
53
54 =item SHA1, see L<EVP_MD-SHA1(7)>
55
56 =item SHA2, see L<EVP_MD-SHA2(7)>
57
58 =item SHA3, see L<EVP_MD-SHA3(7)>
59
60 =item KECCAK, see L<EVP_MD-KECCAK(7)>
61
62 =item KECCAK-KMAC, see L<EVP_MD-KECCAK-KMAC(7)>
63
64 =item SHAKE, see L<EVP_MD-SHAKE(7)>
65
66 =item BLAKE2, see L<EVP_MD-BLAKE2(7)>
67
68 =item SM3, see L<EVP_MD-SM3(7)>
69
70 =item MD5, see L<EVP_MD-MD5(7)>
71
72 =item MD5-SHA1, see L<EVP_MD-MD5-SHA1(7)>
73
74 =item RIPEMD160, see L<EVP_MD-RIPEMD160(7)>
75
76 =item NULL, see L<EVP_MD-NULL(7)>
77
78 =back
79
80 =head2 Symmetric Ciphers
81
82 =over 4
83
84 =item AES, see L<EVP_CIPHER-AES(7)>
85
86 =item ARIA, see L<EVP_CIPHER-ARIA(7)>
87
88 =item CAMELLIA, see L<EVP_CIPHER-CAMELLIA(7)>
89
90 =item 3DES, see L<EVP_CIPHER-DES(7)>
91
92 =item SEED, see L<EVP_CIPHER-SEED(7)>
93
94 =item SM4, see L<EVP_CIPHER-SM4(7)>
95
96 =item ChaCha20, see L<EVP_CIPHER-CHACHA(7)>
97
98 =item ChaCha20-Poly1305, see L<EVP_CIPHER-CHACHA(7)>
99
100 =item NULL, see L<EVP_CIPHER-NULL(7)>
101
102 =back
103
104 =head2 Message Authentication Code (MAC)
105
106 =over 4
107
108 =item BLAKE2, see L<EVP_MAC-BLAKE2(7)>
109
110 =item CMAC, see L<EVP_MAC-CMAC(7)>
111
112 =item GMAC, see L<EVP_MAC-GMAC(7)>
113
114 =item HMAC, see L<EVP_MAC-HMAC(7)>
115
116 =item KMAC, see L<EVP_MAC-KMAC(7)>
117
118 =item SIPHASH, see L<EVP_MAC-Siphash(7)>
119
120 =item POLY1305, see L<EVP_MAC-Poly1305(7)>
121
122 =back
123
124 =head2 Key Derivation Function (KDF)
125
126 =over 4
127
128 =item HKDF, see L<EVP_KDF-HKDF(7)>
129
130 =item SSKDF, see L<EVP_KDF-SS(7)>
131
132 =item PBKDF2, see L<EVP_KDF-PBKDF2(7)>
133
134 =item PKCS12KDF, see L<EVP_KDF-PKCS12KDF(7)>
135
136 =item SSHKDF, see L<EVP_KDF-SSHKDF(7)>
137
138 =item TLS1-PRF, see L<EVP_KDF-TLS1_PRF(7)>
139
140 =item KBKDF, see L<EVP_KDF-KB(7)>
141
142 =item X942KDF-ASN1, see L<EVP_KDF-X942-ASN1(7)>
143
144 =item X942KDF-CONCAT, see L<EVP_KDF-X942-CONCAT(7)>
145
146 =item X963KDF, see L<EVP_KDF-X963(7)>
147
148 =item SCRYPT, see L<EVP_KDF-SCRYPT(7)>
149
150 =item KRB5KDF, see L<EVP_KDF-KRB5KDF(7)>
151
152 =item HMAC-DRBG, see L<EVP_KDF-HMAC-DRBG(7)>
153
154 =back
155
156 =head2 Key Exchange
157
158 =over 4
159
160 =item DH, see L<EVP_KEYEXCH-DH(7)>
161
162 =item ECDH, see L<EVP_KEYEXCH-ECDH(7)>
163
164 =item X25519, see L<EVP_KEYEXCH-X25519(7)>
165
166 =item X448, see L<EVP_KEYEXCH-X448(7)>
167
168 =back
169
170 =head2 Asymmetric Signature
171
172 =over 4
173
174 =item DSA, see L<EVP_SIGNATURE-DSA(7)>
175
176 =item RSA, see L<EVP_SIGNATURE-RSA(7)>
177
178 =item HMAC, see L<EVP_SIGNATURE-HMAC(7)>
179
180 =item SIPHASH, see L<EVP_SIGNATURE-Siphash(7)>
181
182 =item POLY1305, see L<EVP_SIGNATURE-Poly1305(7)>
183
184 =item CMAC, see L<EVP_SIGNATURE-CMAC(7)>
185
186 =back
187
188 =head2 Asymmetric Cipher
189
190 =over 4
191
192 =item RSA, see L<EVP_ASYM_CIPHER-RSA(7)>
193
194 =item SM2, see L<EVP_ASYM_CIPHER-SM2(7)>
195
196 =back
197
198 =head2 Asymmetric Key Encapsulation
199
200 =over 4
201
202 =item RSA, see L<EVP_KEM-RSA(7)>
203
204 =item X25519, see L<EVP_KEM-X25519(7)>
205
206 =item EC, see L<EVP_KEM-EC(7)>
207
208 =back
209
210 =head2 Asymmetric Key Management
211
212 =over 4
213
214 =item DH, see L<EVP_KEYMGMT-DH(7)>
215
216 =item DHX, see L<EVP_KEYMGMT-DHX(7)>
217
218 =item DSA, see L<EVP_KEYMGMT-DSA(7)>
219
220 =item RSA, see L<EVP_KEYMGMT-RSA(7)>
221
222 =item EC, see L<EVP_KEYMGMT-EC(7)>
223
224 =item X25519, see L<EVP_KEYMGMT-X25519(7)>
225
226 =item X448, see L<EVP_KEYMGMT-X448(7)>
227
228 =back
229
230 =head2 Random Number Generation
231
232 =over 4
233
234 =item CTR-DRBG, see L<EVP_RAND-CTR-DRBG(7)>
235
236 =item HASH-DRBG, see L<EVP_RAND-HASH-DRBG(7)>
237
238 =item HMAC-DRBG, see L<EVP_RAND-HMAC-DRBG(7)>
239
240 =item SEED-SRC, see L<EVP_RAND-SEED-SRC(7)>
241
242 =item TEST-RAND, see L<EVP_RAND-TEST-RAND(7)>
243
244 =back
245
246 =head2 Asymmetric Key Encoder
247
248 The default provider also includes all of the encoding algorithms
249 present in the base provider. Some of these have the property "fips=yes",
250 to allow them to be used together with the FIPS provider.
251
252 =over 4
253
254 =item RSA, see L<OSSL_ENCODER-RSA(7)>
255
256 =item DH, see L<OSSL_ENCODER-DH(7)>
257
258 =item DSA, see L<OSSL_ENCODER-DSA(7)>
259
260 =item EC, see L<OSSL_ENCODER-EC(7)>
261
262 =item X25519, see L<OSSL_ENCODER-X25519(7)>
263
264 =item X448, see L<OSSL_ENCODER-X448(7)>
265
266 =back
267
268 =head1 SEE ALSO
269
270 L<openssl-core.h(7)>, L<openssl-core_dispatch.h(7)>, L<provider(7)>,
271 L<OSSL_PROVIDER-base(7)>
272
273 =head1 HISTORY
274
275 The RIPEMD160 digest was added to the default provider in OpenSSL 3.0.7.
276
277 All other functionality was added in OpenSSL 3.0.
278
279 =head1 COPYRIGHT
280
281 Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
282
283 Licensed under the Apache License 2.0 (the "License"). You may not use
284 this file except in compliance with the License. You can obtain a copy
285 in the file LICENSE in the source distribution or at
286 L<https://www.openssl.org/source/license.html>.
287
288 =cut