| 1 | =pod
|
|---|
| 2 |
|
|---|
| 3 | =head1 NAME
|
|---|
| 4 |
|
|---|
| 5 | EVP_RAND-HMAC-DRBG - The HMAC DRBG EVP_RAND implementation
|
|---|
| 6 |
|
|---|
| 7 | =head1 DESCRIPTION
|
|---|
| 8 |
|
|---|
| 9 | Support for the HMAC deterministic random bit generator through the
|
|---|
| 10 | B<EVP_RAND> API.
|
|---|
| 11 |
|
|---|
| 12 | =head2 Identity
|
|---|
| 13 |
|
|---|
| 14 | "HMAC-DRBG" is the name for this implementation; it can be used with the
|
|---|
| 15 | EVP_RAND_fetch() function.
|
|---|
| 16 |
|
|---|
| 17 | =head2 Supported parameters
|
|---|
| 18 |
|
|---|
| 19 | The supported parameters are:
|
|---|
| 20 |
|
|---|
| 21 | =over 4
|
|---|
| 22 |
|
|---|
| 23 | =item "state" (B<OSSL_RAND_PARAM_STATE>) <integer>
|
|---|
| 24 |
|
|---|
| 25 | =item "strength" (B<OSSL_RAND_PARAM_STRENGTH>) <unsigned integer>
|
|---|
| 26 |
|
|---|
| 27 | =item "max_request" (B<OSSL_RAND_PARAM_MAX_REQUEST>) <unsigned integer>
|
|---|
| 28 |
|
|---|
| 29 | =item "reseed_requests" (B<OSSL_DRBG_PARAM_RESEED_REQUESTS>) <unsigned integer>
|
|---|
| 30 |
|
|---|
| 31 | =item "reseed_time_interval" (B<OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL>) <integer>
|
|---|
| 32 |
|
|---|
| 33 | =item "min_entropylen" (B<OSSL_DRBG_PARAM_MIN_ENTROPYLEN>) <unsigned integer>
|
|---|
| 34 |
|
|---|
| 35 | =item "max_entropylen" (B<OSSL_DRBG_PARAM_MAX_ENTROPYLEN>) <unsigned integer>
|
|---|
| 36 |
|
|---|
| 37 | =item "min_noncelen" (B<OSSL_DRBG_PARAM_MIN_NONCELEN>) <unsigned integer>
|
|---|
| 38 |
|
|---|
| 39 | =item "max_noncelen" (B<OSSL_DRBG_PARAM_MAX_NONCELEN>) <unsigned integer>
|
|---|
| 40 |
|
|---|
| 41 | =item "max_perslen" (B<OSSL_DRBG_PARAM_MAX_PERSLEN>) <unsigned integer>
|
|---|
| 42 |
|
|---|
| 43 | =item "max_adinlen" (B<OSSL_DRBG_PARAM_MAX_ADINLEN>) <unsigned integer>
|
|---|
| 44 |
|
|---|
| 45 | =item "reseed_counter" (B<OSSL_DRBG_PARAM_RESEED_COUNTER>) <unsigned integer>
|
|---|
| 46 |
|
|---|
| 47 | =item "properties" (B<OSSL_DRBG_PARAM_PROPERTIES>) <UTF8 string>
|
|---|
| 48 |
|
|---|
| 49 | =item "mac" (B<OSSL_DRBG_PARAM_MAC>) <UTF8 string>
|
|---|
| 50 |
|
|---|
| 51 | =item "digest" (B<OSSL_DRBG_PARAM_DIGEST>) <UTF8 string>
|
|---|
| 52 |
|
|---|
| 53 | These parameters work as described in L<EVP_RAND(3)/PARAMETERS>.
|
|---|
| 54 |
|
|---|
| 55 | =back
|
|---|
| 56 |
|
|---|
| 57 | =head1 NOTES
|
|---|
| 58 |
|
|---|
| 59 | When using the FIPS provider, only these digests are permitted (as per
|
|---|
| 60 | L<FIPS 140-3 IG D.R|https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>):
|
|---|
| 61 |
|
|---|
| 62 | =over 4
|
|---|
| 63 |
|
|---|
| 64 | =item SHA-1
|
|---|
| 65 |
|
|---|
| 66 | =item SHA2-256
|
|---|
| 67 |
|
|---|
| 68 | =item SHA2-512
|
|---|
| 69 |
|
|---|
| 70 | =item SHA3-256
|
|---|
| 71 |
|
|---|
| 72 | =item SHA3-512
|
|---|
| 73 |
|
|---|
| 74 | =back
|
|---|
| 75 |
|
|---|
| 76 | A context for HMAC DRBG can be obtained by calling:
|
|---|
| 77 |
|
|---|
| 78 | EVP_RAND *rand = EVP_RAND_fetch(NULL, "HMAC-DRBG", NULL);
|
|---|
| 79 | EVP_RAND_CTX *rctx = EVP_RAND_CTX_new(rand);
|
|---|
| 80 |
|
|---|
| 81 | =head1 EXAMPLES
|
|---|
| 82 |
|
|---|
| 83 | EVP_RAND *rand;
|
|---|
| 84 | EVP_RAND_CTX *rctx;
|
|---|
| 85 | unsigned char bytes[100];
|
|---|
| 86 | OSSL_PARAM params[3], *p = params;
|
|---|
| 87 | unsigned int strength = 128;
|
|---|
| 88 |
|
|---|
| 89 | rand = EVP_RAND_fetch(NULL, "HMAC-DRBG", NULL);
|
|---|
| 90 | rctx = EVP_RAND_CTX_new(rand, NULL);
|
|---|
| 91 | EVP_RAND_free(rand);
|
|---|
| 92 |
|
|---|
| 93 | *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_MAC, SN_hmac, 0);
|
|---|
| 94 | *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_DIGEST, SN_sha256, 0);
|
|---|
| 95 | *p = OSSL_PARAM_construct_end();
|
|---|
| 96 | EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params);
|
|---|
| 97 |
|
|---|
| 98 | EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0);
|
|---|
| 99 |
|
|---|
| 100 | EVP_RAND_CTX_free(rctx);
|
|---|
| 101 |
|
|---|
| 102 | =head1 CONFORMING TO
|
|---|
| 103 |
|
|---|
| 104 | NIST SP 800-90A and SP 800-90B
|
|---|
| 105 |
|
|---|
| 106 | =head1 SEE ALSO
|
|---|
| 107 |
|
|---|
| 108 | L<EVP_RAND(3)>,
|
|---|
| 109 | L<EVP_RAND(3)/PARAMETERS>,
|
|---|
| 110 | L<openssl-fipsinstall(1)>
|
|---|
| 111 |
|
|---|
| 112 |
|
|---|
| 113 | =head1 HISTORY
|
|---|
| 114 |
|
|---|
| 115 | OpenSSL 3.1.1 introduced the B<-no_drbg_truncated_digests> option to
|
|---|
| 116 | fipsinstall which restricts the permitted digests when using the FIPS
|
|---|
| 117 | provider in a complaint manner. For details refer to
|
|---|
| 118 | L<FIPS 140-3 IG D.R|https://csrc.nist.gov/CSRC/media/Projects/cryptographic-module-validation-program/documents/fips%20140-3/FIPS%20140-3%20IG.pdf>).
|
|---|
| 119 |
|
|---|
| 120 | =head1 COPYRIGHT
|
|---|
| 121 |
|
|---|
| 122 | Copyright 2020-2023 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 123 |
|
|---|
| 124 | Licensed under the Apache License 2.0 (the "License"). You may not use
|
|---|
| 125 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 126 | in the file LICENSE in the source distribution or at
|
|---|
| 127 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 128 |
|
|---|
| 129 | =cut
|
|---|
