EVP_sha3_224.pod 1.9 KB

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