doc/man3/EVP_sha3_224.pod

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