Blame doc/man3/EVP_sha3_224.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
EVP_sha3_224,
Packit c4476c
EVP_sha3_256,
Packit c4476c
EVP_sha3_384,
Packit c4476c
EVP_sha3_512,
Packit c4476c
EVP_shake128,
Packit c4476c
EVP_shake256
Packit c4476c
- SHA-3 For EVP
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/evp.h>
Packit c4476c
Packit c4476c
 const EVP_MD *EVP_sha3_224(void);
Packit c4476c
 const EVP_MD *EVP_sha3_256(void);
Packit c4476c
 const EVP_MD *EVP_sha3_384(void);
Packit c4476c
 const EVP_MD *EVP_sha3_512(void);
Packit c4476c
Packit c4476c
 const EVP_MD *EVP_shake128(void);
Packit c4476c
 const EVP_MD *EVP_shake256(void);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SHA-3 (Secure Hash Algorithm 3) is a family of cryptographic hash functions
Packit c4476c
standardized in NIST FIPS 202, first published in 2015. It is based on the
Packit c4476c
Keccak algorithm.
Packit c4476c
Packit c4476c
=over 4
Packit c4476c
Packit c4476c
=item EVP_sha3_224(),
Packit c4476c
EVP_sha3_256(),
Packit c4476c
EVP_sha3_384(),
Packit c4476c
EVP_sha3_512()
Packit c4476c
Packit c4476c
The SHA-3 SHA-3-224, SHA-3-256, SHA-3-384, and SHA-3-512 algorithms
Packit c4476c
respectively. They produce 224, 256, 384 and 512 bits of output from a given
Packit c4476c
input.
Packit c4476c
Packit c4476c
=item EVP_shake128(),
Packit c4476c
EVP_shake256()
Packit c4476c
Packit c4476c
The SHAKE-128 and SHAKE-256 Extendable Output Functions (XOF) that can generate
Packit c4476c
a variable hash length.
Packit c4476c
Packit c4476c
Specifically, B<EVP_shake128> provides an overall security of 128 bits, while
Packit c4476c
B<EVP_shake256> provides that of 256 bits.
Packit c4476c
Packit c4476c
=back
Packit c4476c
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
These functions return a B<EVP_MD> structure that contains the
Packit c4476c
implementation of the symmetric cipher. See L<EVP_MD_meth_new(3)> for
Packit c4476c
details of the B<EVP_MD> structure.
Packit c4476c
Packit c4476c
=head1 CONFORMING TO
Packit c4476c
Packit c4476c
NIST FIPS 202.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<evp(7)>,
Packit c4476c
L<EVP_DigestInit(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut
Packit c4476c