2
0

EVP_RAND-HASH-DRBG.pod 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. =pod
  2. =head1 NAME
  3. EVP_RAND-HASH-DRBG - The HASH DRBG EVP_RAND implementation
  4. =head1 DESCRIPTION
  5. Support for the hash deterministic random bit generator through the
  6. B<EVP_RAND> API.
  7. =head2 Identity
  8. "HASH-DRBG" is the name for this implementation; it can be used with the
  9. EVP_RAND_fetch() function.
  10. =head2 Supported parameters
  11. The supported parameters are:
  12. =over 4
  13. =item "state" (B<OSSL_RAND_PARAM_STATE>) <integer>
  14. =item "strength" (B<OSSL_RAND_PARAM_STRENGTH>) <unsigned integer>
  15. =item "max_request" (B<OSSL_RAND_PARAM_MAX_REQUEST>) <unsigned integer>
  16. =item "reseed_requests" (B<OSSL_DRBG_PARAM_RESEED_REQUESTS>) <unsigned integer>
  17. =item "reseed_time_interval" (B<OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL>) <integer>
  18. =item "min_entropylen" (B<OSSL_DRBG_PARAM_MIN_ENTROPYLEN>) <unsigned integer>
  19. =item "max_entropylen" (B<OSSL_DRBG_PARAM_MAX_ENTROPYLEN>) <unsigned integer>
  20. =item "min_noncelen" (B<OSSL_DRBG_PARAM_MIN_NONCELEN>) <unsigned integer>
  21. =item "max_noncelen" (B<OSSL_DRBG_PARAM_MAX_NONCELEN>) <unsigned integer>
  22. =item "max_perslen" (B<OSSL_DRBG_PARAM_MAX_PERSLEN>) <unsigned integer>
  23. =item "max_adinlen" (B<OSSL_DRBG_PARAM_MAX_ADINLEN>) <unsigned integer>
  24. =item "reseed_counter" (B<OSSL_DRBG_PARAM_RESEED_COUNTER>) <unsigned integer>
  25. =item "properties" (B<OSSL_DRBG_PARAM_PROPERTIES>) <UTF8 string>
  26. =item "digest" (B<OSSL_DRBG_PARAM_DIGEST>) <UTF8 string>
  27. These parameters work as described in L<EVP_RAND(3)/PARAMETERS>.
  28. =back
  29. =head1 NOTES
  30. A context for HASH DRBG can be obtained by calling:
  31. EVP_RAND *rand = EVP_RAND_fetch(NULL, "HASH-DRBG", NULL);
  32. EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand);
  33. =head1 EXAMPLES
  34. EVP_RAND *rand;
  35. EVP_RAND_CTX *rctx;
  36. unsigned char bytes[100];
  37. OSSL_PARAM params[2], *p = params;
  38. unsigned int strength = 128;
  39. rand = EVP_RAND_fetch(NULL, "HASH-DRBG", NULL);
  40. rctx = EVP_RAND_CTX_new(rand, NULL);
  41. EVP_RAND_free(rand);
  42. *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_DIGEST, SN_sha512, 0);
  43. *p = OSSL_PARAM_construct_end();
  44. EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params);
  45. EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0);
  46. EVP_RAND_CTX_free(rctx);
  47. =head1 CONFORMING TO
  48. NIST SP 800-90A and SP 800-90B
  49. =head1 SEE ALSO
  50. L<EVP_RAND(3)>,
  51. L<EVP_RAND(3)/PARAMETERS>
  52. =head1 COPYRIGHT
  53. Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
  54. Licensed under the Apache License 2.0 (the "License"). You may not use
  55. this file except in compliance with the License. You can obtain a copy
  56. in the file LICENSE in the source distribution or at
  57. L<https://www.openssl.org/source/license.html>.
  58. =cut