xref: /openbsd/lib/libcrypto/man/EVP_sha3_224.3 (revision 4bdff4be)
1.\" $OpenBSD: EVP_sha3_224.3,v 1.2 2023/08/15 11:54:38 schwarze Exp $
2.\" selective merge up to: OpenSSL bbda8ce9 Oct 31 15:43:01 2017 +0800
3.\"
4.\" This file was written by Ronald Tse <ronald.tse@ribose.com>.
5.\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in
16.\"    the documentation and/or other materials provided with the
17.\"    distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\"    software must display the following acknowledgment:
21.\"    "This product includes software developed by the OpenSSL Project
22.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\"    endorse or promote products derived from this software without
26.\"    prior written permission. For written permission, please contact
27.\"    openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\"    nor may "OpenSSL" appear in their names without prior written
31.\"    permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\"    acknowledgment:
35.\"    "This product includes software developed by the OpenSSL Project
36.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: August 15 2023 $
52.Dt EVP_SHA3_224 3
53.Os
54.Sh NAME
55.Nm EVP_sha3_224 ,
56.Nm EVP_sha3_256 ,
57.Nm EVP_sha3_384 ,
58.Nm EVP_sha3_512
59.Nd Secure Hash Algorithm 3 for EVP
60.Sh SYNOPSIS
61.In openssl/evp.h
62.Ft const EVP_MD *
63.Fn EVP_sha3_224 void
64.Ft const EVP_MD *
65.Fn EVP_sha3_256 void
66.Ft const EVP_MD *
67.Fn EVP_sha3_384 void
68.Ft const EVP_MD *
69.Fn EVP_sha3_512 void
70.Sh DESCRIPTION
71SHA-3 (Secure Hash Algorithm 3) is a family of cryptographic hash
72functions standardized in NIST FIPS 202, first published in 2015.
73It is based on the Keccak algorithm.
74.Pp
75.Fn EVP_sha3_224 ,
76.Fn EVP_sha3_256 ,
77.Fn EVP_sha3_384 ,
78and
79.Fn EVP_sha3_512
80implement the SHA3-224, SHA3-256, SHA3-384, and SHA3-512 algorithms
81and produce 224, 256, 384 and 512 bits of output from a given input,
82respectively.
83.Sh RETURN VALUES
84These functions return pointers to static
85.Vt EVP_MD
86objects implementing the hash functions.
87.Sh SEE ALSO
88.Xr evp 3 ,
89.Xr EVP_DigestInit 3 ,
90.Xr EVP_MD_meth_new 3
91.Sh STANDARDS
92NIST FIPS 202
93