2
0

EVP_MD-SHAKE.pod 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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 only available with the default provider, and
  12. includes the following varieties:
  13. =over 4
  14. =item KECCAK-KMAC-128
  15. Known names are "KECCAK-KMAC-128" and "KECCAK-KMAC128"
  16. =item KECCAK-KMAC-256
  17. Known names are "KECCAK-KMAC-256" and "KECCAK-KMAC256"
  18. =item SHAKE-128
  19. Known names are "SHAKE-128" and "SHAKE128"
  20. =item SHAKE-256
  21. Known names are "SHAKE-256" and "SHAKE256"
  22. =back
  23. =head2 Gettable Parameters
  24. This implementation supports the common gettable parameters described
  25. in L<EVP_MD-common(7)>.
  26. =head2 Settable Context Parameters
  27. These implementations support the following L<OSSL_PARAM(3)> entries,
  28. settable for an B<EVP_MD_CTX> with L<EVP_MD_CTX_set_params(3)>:
  29. =over 4
  30. =item "xoflen" (B<OSSL_DIGEST_PARAM_XOFLEN>) <unsigned integer>
  31. Sets the digest length for extendable output functions.
  32. The length of the "xoflen" parameter should not exceed that of a B<size_t>.
  33. =back
  34. =head1 SEE ALSO
  35. L<EVP_MD_CTX_set_params(3)>, L<provider-digest(7)>, L<OSSL_PROVIDER-default(7)>
  36. =head1 COPYRIGHT
  37. Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
  38. Licensed under the Apache License 2.0 (the "License"). You may not use
  39. this file except in compliance with the License. You can obtain a copy
  40. in the file LICENSE in the source distribution or at
  41. L<https://www.openssl.org/source/license.html>.
  42. =cut