diff options
author | Pauli <ppzgs1@gmail.com> | 2021-02-26 10:56:46 +1000 |
---|---|---|
committer | Pauli <ppzgs1@gmail.com> | 2021-02-28 17:25:49 +1000 |
commit | f8a5822cff0b05df8fa937b5aca72ef5b4c1b47a (patch) | |
tree | d22dab0afed98afb10bccc6bac8b431d378d08d0 /doc/man7 | |
parent | 7198bd1a8f44be994106d3dba4bbb3362147b144 (diff) |
doc: update documenation with params argument on DRBG instantiate calls
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14310)
Diffstat (limited to 'doc/man7')
-rw-r--r-- | doc/man7/EVP_RAND-CTR-DRBG.pod | 2 | ||||
-rw-r--r-- | doc/man7/EVP_RAND-HASH-DRBG.pod | 2 | ||||
-rw-r--r-- | doc/man7/EVP_RAND-HMAC-DRBG.pod | 2 | ||||
-rw-r--r-- | doc/man7/EVP_RAND-SEED-SRC.pod | 2 | ||||
-rw-r--r-- | doc/man7/EVP_RAND-TEST-RAND.pod | 2 | ||||
-rw-r--r-- | doc/man7/provider-rand.pod | 6 |
6 files changed, 9 insertions, 7 deletions
diff --git a/doc/man7/EVP_RAND-CTR-DRBG.pod b/doc/man7/EVP_RAND-CTR-DRBG.pod index a31b22390a..61dfa2672e 100644 --- a/doc/man7/EVP_RAND-CTR-DRBG.pod +++ b/doc/man7/EVP_RAND-CTR-DRBG.pod @@ -81,7 +81,7 @@ A context for CTR DRBG can be obtained by calling: *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_CIPHER, SN_aes_256_ctr, 0); *p = OSSL_PARAM_construct_end(); - EVP_RAND_set_ctx_params(rctx, params); + EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params); EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0); diff --git a/doc/man7/EVP_RAND-HASH-DRBG.pod b/doc/man7/EVP_RAND-HASH-DRBG.pod index 631383c74a..a212add6d2 100644 --- a/doc/man7/EVP_RAND-HASH-DRBG.pod +++ b/doc/man7/EVP_RAND-HASH-DRBG.pod @@ -73,7 +73,7 @@ A context for HASH DRBG can be obtained by calling: *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_DIGEST, SN_sha512, 0); *p = OSSL_PARAM_construct_end(); - EVP_RAND_set_ctx_params(rctx, params); + EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params); EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0); diff --git a/doc/man7/EVP_RAND-HMAC-DRBG.pod b/doc/man7/EVP_RAND-HMAC-DRBG.pod index f04ae336fc..f345255efc 100644 --- a/doc/man7/EVP_RAND-HMAC-DRBG.pod +++ b/doc/man7/EVP_RAND-HMAC-DRBG.pod @@ -76,7 +76,7 @@ A context for HMAC DRBG can be obtained by calling: *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_MAC, SN_hmac, 0); *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_DIGEST, SN_sha256, 0); *p = OSSL_PARAM_construct_end(); - EVP_RAND_set_ctx_params(rctx, params); + EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params); EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0); diff --git a/doc/man7/EVP_RAND-SEED-SRC.pod b/doc/man7/EVP_RAND-SEED-SRC.pod index f301ed25f9..4d21e4cd6e 100644 --- a/doc/man7/EVP_RAND-SEED-SRC.pod +++ b/doc/man7/EVP_RAND-SEED-SRC.pod @@ -63,7 +63,7 @@ A context for the seed source can be obtained by calling: *p++ = OSSL_PARAM_construct_utf8_string(OSSL_DRBG_PARAM_CIPHER, SN_aes_256_ctr, 0); *p = OSSL_PARAM_construct_end(); - EVP_RAND_set_ctx_params(rctx, params); + EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params); EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0); diff --git a/doc/man7/EVP_RAND-TEST-RAND.pod b/doc/man7/EVP_RAND-TEST-RAND.pod index 9eb7001d64..c5f1a4d526 100644 --- a/doc/man7/EVP_RAND-TEST-RAND.pod +++ b/doc/man7/EVP_RAND-TEST-RAND.pod @@ -90,7 +90,7 @@ A context for a test generator can be obtained by calling: *p++ = OSSL_PARAM_construct_octet_string(OSSL_RAND_PARAM_TEST_NONCE, nonce, sizeof(nonce)); *p = OSSL_PARAM_construct_end(); - EVP_RAND_set_ctx_params(rctx, params); + EVP_RAND_instantiate(rctx, strength, 0, NULL, 0, params); EVP_RAND_generate(rctx, bytes, sizeof(bytes), strength, 0, NULL, 0); diff --git a/doc/man7/provider-rand.pod b/doc/man7/provider-rand.pod index 5de3a15f38..157f6227e9 100644 --- a/doc/man7/provider-rand.pod +++ b/doc/man7/provider-rand.pod @@ -26,7 +26,8 @@ functions /* Random number generator functions: NIST */ int OSSL_FUNC_rand_instantiate(void *ctx, unsigned int strength, int prediction_resistance, - const unsigned char *pstr, size_t pstr_len); + const unsigned char *pstr, size_t pstr_len, + const OSSL_PARAM params[]); int OSSL_FUNC_rand_uninstantiate(void *ctx); int OSSL_FUNC_rand_generate(void *ctx, unsigned char *out, size_t outlen, unsigned int strength, int prediction_resistance, @@ -97,7 +98,8 @@ These functions correspond to those defined in NIST SP 800-90A and SP 800-90C. OSSL_FUNC_rand_instantiate() is used to instantiate the DRBG I<ctx> at a requested security I<strength>. In addition, I<prediction_resistance> can be requested. Additional input I<addin> of length I<addin_len> bytes can optionally -be provided. +be provided. The parameters specified in I<params> configure the DRBG and these +should be processed before instantiation. OSSL_FUNC_rand_uninstantiate() is used to uninstantiate the DRBG I<ctx>. After being uninstantiated, a DRBG is unable to produce output until it is instantiated |