EVP_KDF-HMAC-DRBG.pod 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. =pod
  2. =head1 NAME
  3. EVP_KDF-HMAC-DRBG
  4. - The HMAC DRBG DETERMINISTIC EVP_KDF implementation
  5. =head1 DESCRIPTION
  6. Support for a deterministic HMAC DRBG using the B<EVP_KDF> API. This is similar
  7. to L<EVP_RAND-HMAC-DRBG(7)>, but uses fixed values for its entropy and nonce
  8. values. This is used to generate deterministic nonce value required by ECDSA
  9. and DSA (as defined in RFC 6979).
  10. =head2 Identity
  11. "HMAC-DRBG-KDF" is the name for this implementation; it can be used
  12. with the EVP_KDF_fetch() function.
  13. =head2 Supported parameters
  14. The supported parameters are:
  15. =over 4
  16. =item "digest" (B<OSSL_DRBG_PARAM_DIGEST>) <UTF8 string>
  17. =item "properties" (B<OSSL_DRBG_PARAM_PROPERTIES>) <UTF8 string>
  18. These parameters work as described in L<EVP_KDF(3)/PARAMETERS>.
  19. =item "entropy" (B<OSSL_KDF_PARAM_HMACDRBG_ENTROPY>) <octet string>
  20. Sets the entropy bytes supplied to the HMAC-DRBG.
  21. =item "nonce" (B<OSSL_KDF_PARAM_HMACDRBG_NONCE>) <octet string>
  22. Sets the nonce bytes supplied to the HMAC-DRBG.
  23. =back
  24. =head1 NOTES
  25. A context for KDF HMAC DRBG can be obtained by calling:
  26. EVP_KDF *kdf = EVP_KDF_fetch(NULL, "HMAC-DRBG-KDF", NULL);
  27. EVP_KDF_CTX *kdf_ctx = EVP_KDF_CTX_new(kdf, NULL);
  28. =head1 CONFORMING TO
  29. RFC 6979
  30. =head1 SEE ALSO
  31. L<EVP_KDF(3)>,
  32. L<EVP_KDF(3)/PARAMETERS>
  33. =head1 HISTORY
  34. The EVP_KDF-HMAC-DRBG functionality was added in OpenSSL 3.2.
  35. =head1 COPYRIGHT
  36. Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved.
  37. Licensed under the Apache License 2.0 (the "License"). You may not use
  38. this file except in compliance with the License. You can obtain a copy
  39. in the file LICENSE in the source distribution or at
  40. L<https://www.openssl.org/source/license.html>.
  41. =cut