xref: /openssl/doc/man3/EVP_sha3_224.pod (revision b6eb95fa)
1=pod
2
3=head1 NAME
4
5EVP_sha3_224,
6EVP_sha3_256,
7EVP_sha3_384,
8EVP_sha3_512,
9EVP_shake128,
10EVP_shake256
11- SHA-3 For EVP
12
13=head1 SYNOPSIS
14
15 #include <openssl/evp.h>
16
17 const EVP_MD *EVP_sha3_224(void);
18 const EVP_MD *EVP_sha3_256(void);
19 const EVP_MD *EVP_sha3_384(void);
20 const EVP_MD *EVP_sha3_512(void);
21
22 const EVP_MD *EVP_shake128(void);
23 const EVP_MD *EVP_shake256(void);
24
25=head1 DESCRIPTION
26
27SHA-3 (Secure Hash Algorithm 3) is a family of cryptographic hash functions
28standardized in NIST FIPS 202, first published in 2015. It is based on the
29Keccak algorithm.
30
31=over 4
32
33=item EVP_sha3_224(),
34EVP_sha3_256(),
35EVP_sha3_384(),
36EVP_sha3_512()
37
38The SHA-3 SHA-3-224, SHA-3-256, SHA-3-384, and SHA-3-512 algorithms
39respectively. They produce 224, 256, 384 and 512 bits of output from a given
40input.
41
42=item EVP_shake128(),
43EVP_shake256()
44
45The SHAKE-128 and SHAKE-256 Extendable Output Functions (XOF) that can generate
46a variable hash length.
47
48Specifically, B<EVP_shake128> provides an overall security of 128 bits, while
49B<EVP_shake256> provides that of 256 bits.
50
51=back
52
53=head1 NOTES
54
55Developers should be aware of the negative performance implications of
56calling these functions multiple times and should consider using
57L<EVP_MD_fetch(3)> with L<EVP_MD-SHA3(7)> or L<EVP_MD-SHAKE(7)> instead.
58See L<crypto(7)/Performance> for further information.
59
60=head1 RETURN VALUES
61
62These functions return a B<EVP_MD> structure that contains the
63implementation of the message digest. See L<EVP_MD_meth_new(3)> for
64details of the B<EVP_MD> structure.
65
66=head1 CONFORMING TO
67
68NIST FIPS 202.
69
70=head1 SEE ALSO
71
72L<evp(7)>,
73L<EVP_DigestInit(3)>
74
75=head1 COPYRIGHT
76
77Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved.
78
79Licensed under the Apache License 2.0 (the "License").  You may not use
80this file except in compliance with the License.  You can obtain a copy
81in the file LICENSE in the source distribution or at
82L<https://www.openssl.org/source/license.html>.
83
84=cut
85
86