DOCS: Move implementation specific docs away from provider-digest(7)
[openssl.git] / doc / man7 / EVP_MD-SHAKE.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_MD-SHAKE, EVP_MD-KECCAK-KMAC
6 - The SHAKE / KECCAK family EVP_MD implementations
7
8 =head1 DESCRIPTION
9
10 Support for computing SHAKE or KECCAK-KMAC digests through the
11 B<EVP_MD> API.
12
13 KECCAK-KMAC is a special digest that's used by the KMAC EVP_MAC
14 implementation (see L<EVP_MAC-KMAC(7)>).
15
16 =head2 Identities
17
18 This implementation is only available with the default provider, and
19 includes the following varieties:
20
21 =over 4
22
23 =item KECCAK-KMAC-128
24
25 Known names are "KECCAK-KMAC-128" and "KECCAK-KMAC128"
26
27 =item KECCAK-KMAC-256
28
29 Known names are "KECCAK-KMAC-256" and "KECCAK-KMAC256"
30
31 =item SHAKE-128
32
33 Known names are "SHAKE-128" and "SHAKE128"
34
35 =item SHAKE-256
36
37 Known names are "SHAKE-256" and "SHAKE256"
38
39 =back
40
41 =head2 Gettable Parameters
42
43 This implementation supports the common gettable parameters described
44 in L<EVP_MD-common(7)>.
45
46 =head2 Settable Context Parameters
47
48 These implementations support the following L<OSSL_PARAM(3)> entries,
49 settable for an B<EVP_MD_CTX> with L<EVP_MD_CTX_set_params(3)>:
50
51 =over 4
52
53 =item "xoflen" (B<OSSL_DIGEST_PARAM_XOFLEN>) <unsigned integer>
54
55 Sets the digest length for extendable output functions.
56 The length of the "xoflen" parameter should not exceed that of a B<size_t>.
57
58 =back
59
60 =head1 SEE ALSO
61
62 L<EVP_MD_CTX_set_params(3)>, L<provider-digest(7)>, L<OSSL_PROVIDER-default(7)>
63
64 =head1 COPYRIGHT
65
66 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
67
68 Licensed under the Apache License 2.0 (the "License").  You may not use
69 this file except in compliance with the License.  You can obtain a copy
70 in the file LICENSE in the source distribution or at
71 L<https://www.openssl.org/source/license.html>.
72
73 =cut