EVP_MD-SHAKE.pod 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. =pod
  2. =head1 NAME
  3. EVP_MD-SHAKE, EVP_MD-KECCAK-KMAC
  4. - The SHAKE / KECCAK family EVP_MD implementations
  5. =head1 DESCRIPTION
  6. Support for computing SHAKE or KECCAK-KMAC digests through the
  7. B<EVP_MD> API.
  8. KECCAK-KMAC is a special digest that's used by the KMAC EVP_MAC
  9. implementation (see L<EVP_MAC-KMAC(7)>).
  10. =head2 Identities
  11. This implementation is available in the FIPS provider as well as the default
  12. provider, and includes the following varieties:
  13. =over 4
  14. =item KECCAK-KMAC-128
  15. Known names are "KECCAK-KMAC-128" and "KECCAK-KMAC128"
  16. This is used by L<EVP_MAC-KMAC128(7)>
  17. =item KECCAK-KMAC-256
  18. Known names are "KECCAK-KMAC-256" and "KECCAK-KMAC256"
  19. This is used by L<EVP_MAC-KMAC256(7)>
  20. =item SHAKE-128
  21. Known names are "SHAKE-128" and "SHAKE128"
  22. =item SHAKE-256
  23. Known names are "SHAKE-256" and "SHAKE256"
  24. =back
  25. =head2 Gettable Parameters
  26. This implementation supports the common gettable parameters described
  27. in L<EVP_MD-common(7)>.
  28. =head2 Settable Context Parameters
  29. These implementations support the following L<OSSL_PARAM(3)> entries,
  30. settable for an B<EVP_MD_CTX> with L<EVP_MD_CTX_set_params(3)>:
  31. =over 4
  32. =item "xoflen" (B<OSSL_DIGEST_PARAM_XOFLEN>) <unsigned integer>
  33. Sets the digest length for extendable output functions.
  34. The length of the "xoflen" parameter should not exceed that of a B<size_t>.
  35. For backwards compatibility reasons the default xoflen length for SHAKE-128 is
  36. 16 (bytes) which results in a security strength of only 64 bits. To ensure the
  37. maximum security strength of 128 bits, the xoflen should be set to at least 32.
  38. For backwards compatibility reasons the default xoflen length for SHAKE-256 is
  39. 32 (bytes) which results in a security strength of only 128 bits. To ensure the
  40. maximum security strength of 256 bits, the xoflen should be set to at least 64.
  41. =back
  42. =head1 SEE ALSO
  43. L<EVP_MD_CTX_set_params(3)>, L<provider-digest(7)>, L<OSSL_PROVIDER-default(7)>
  44. =head1 COPYRIGHT
  45. Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved.
  46. Licensed under the Apache License 2.0 (the "License"). You may not use
  47. this file except in compliance with the License. You can obtain a copy
  48. in the file LICENSE in the source distribution or at
  49. L<https://www.openssl.org/source/license.html>.
  50. =cut