PROVIDER-RAND(7ossl)

📦

version 15.1 · 3 versions

15.1 · freebsd 15.1 (latest)
14.5 · freebsd 14.5
nixpkgs unstable

💖 PROVIDER-RAND(7ossl) 💖

okay so bestie, welcome to the OpenSSL manual page for provider-rand — that's the 7ossl one, iykyk. this page is literally about the random number generation library <-> provider functions, and the vibe is very "function pointer dispatch table main character energy." no cap.

✨ NAME ✨

provider-rand - The random number generation library <-> provider functions

slay, that's the whole name. it's giving randomness provider realness 🎀

🦋 SYNOPSIS 🦋

here's the synopsis, and it's important: none of these are actual functions — they're displayed like this for the function signatures for functions that are offered as function pointers in OSSL_DISPATCH arrays. literally the comment says it, so we're keeping it exact.

#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>

/*
 * None of these are actual functions, but are displayed like this for
 * the function signatures for functions that are offered as function
 * pointers in OSSL_DISPATCH arrays.
 */

/* Context management */
void *OSSL_FUNC_rand_newctx(void *provctx, void *parent,
                            const OSSL_DISPATCH *parent_calls);
void OSSL_FUNC_rand_freectx(void *ctx);

/* 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 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,
                            const unsigned char *addin, size_t addin_len);
int OSSL_FUNC_rand_reseed(void *ctx, int prediction_resistance,
                          const unsigned char *ent, size_t ent_len,
                          const unsigned char *addin, size_t addin_len);

/* Random number generator functions: additional */
size_t OSSL_FUNC_rand_nonce(void *ctx, unsigned char *out, size_t outlen,
                            int strength, size_t min_noncelen,
                            size_t max_noncelen);
size_t OSSL_FUNC_rand_get_seed(void *ctx, unsigned char **buffer,
                               int entropy, size_t min_len, size_t max_len,
                               int prediction_resistance,
                               const unsigned char *adin, size_t adin_len);
void OSSL_FUNC_rand_clear_seed(void *ctx, unsigned char *buffer, size_t b_len);
int OSSL_FUNC_rand_verify_zeroization(void *ctx);

/* Context Locking */
int OSSL_FUNC_rand_enable_locking(void *ctx);
int OSSL_FUNC_rand_lock(void *ctx);
void OSSL_FUNC_rand_unlock(void *ctx);

/* RAND parameter descriptors */
const OSSL_PARAM *OSSL_FUNC_rand_gettable_params(void *provctx);
const OSSL_PARAM *OSSL_FUNC_rand_gettable_ctx_params(void *ctx, void *provctx);
const OSSL_PARAM *OSSL_FUNC_rand_settable_ctx_params(void *ctx, void *provctx);

/* RAND parameters */
int OSSL_FUNC_rand_get_params(OSSL_PARAM params[]);
int OSSL_FUNC_rand_get_ctx_params(void *ctx, OSSL_PARAM params[]);
int OSSL_FUNC_rand_set_ctx_params(void *ctx, const OSSL_PARAM params[]);

💫 DESCRIPTION 💫

ok so real talk: this page is mainly for provider authors, bestie. if that's not you, go peek at provider(7) first, k?

The RAND operation is what lets providers implement random number generation algorithms and random number sources and then hand them to applications through the API function EVP_RAND(3). it's giving very much the plug that makes randomness happen ✨

🎀 Context Management Functions 🎀

OSSL_FUNC_rand_newctx() — should create and return a pointer to a provider side structure that holds context information during a rand operation. that pointer gets passed back in a bunch of the other rand operation function calls, so like… keep track of it 💅
- the provctx parameter is the provider context that was generated during provider initialisation (see provider(7)).
- the parent parameter specifies another rand instance to be used for seeding purposes. if it's NULL and the specific instance supports it, the operating system will be used for seeding. 🫶
- the parent_calls parameter points to the dispatch table for parent. so the parent does not need to come from the same provider as the new instance — cross-provider collab era 👑
OSSL_FUNC_rand_freectx() — is passed a pointer to the provider side rand context in the mctx parameter. if it receives NULL as the ctx value, it should not do anything other than return (like, just leave, no drama 🙈). this function should free any resources associated with that context.

🔥 Random Number Generator Functions: NIST 🔥

these functions correspond to those defined in NIST SP 800-90A and SP 800-90C. very official, very secure, we love to see it.

OSSL_FUNC_rand_instantiate() — used to instantiate the DRBG ctx at a requested security strength. plus, prediction_resistance can be requested. additional input addin of length addin_len bytes can optionally be provided. the parameters specified in params configure the DRBG, and these should be processed before instantiation. ✨
OSSL_FUNC_rand_uninstantiate() — used to uninstantiate the DRBG ctx. after being uninstantiated, a DRBG is unable to produce output until it is instantiated anew. so like, it's on a break. no output for you 💀
OSSL_FUNC_rand_generate() — used to generate random bytes from the DRBG ctx. it will generate outlen bytes and place them into the buffer pointed to by out. the generated bytes will meet the specified security strength and, if prediction_resistance is true, the bytes will be produced after reseeding from a live entropy source. additional input addin of length addin_len bytes can optionally be provided. slay 🌈

🌸 Random Number Generator Functions: Additional 🌸

OSSL_FUNC_rand_nonce() — used to generate a nonce of the given strength with a length from min_noncelen to max_noncelen. if the output buffer out is NULL, the length of the nonce should be returned. iykyk 🎀
OSSL_FUNC_rand_get_seed() — used by deterministic generators to obtain their seeding material from their parent. the seed bytes will meet the specified security level of entropy bits and there will be between min_len and max_len inclusive bytes in total. if prediction_resistance is true, the bytes will be produced from a live entropy source. additional input addin of length addin_len bytes can optionally be provided. a pointer to the seed material is returned in *buffer, and this must be freed by a later call to OSSL_FUNC_rand_clear_seed(). don't forget, bestie, that's a leak otherwise 😭
OSSL_FUNC_rand_clear_seed() — frees a seed buffer of length b_len bytes which was previously allocated by OSSL_FUNC_rand_get_seed(). the cleanup queen we deserve 👑
OSSL_FUNC_rand_verify_zeroization() — used to determine if the internal state of the DRBG is zero. this capability is mandated by NIST as part of the self tests, and it is unlikely to be useful in other circumstances. so like, it's a vibe check that only NIST asked for 🙈

🔒 Context Locking 🔒

when DRBGs are used by multiple threads, there must be locking employed to ensure their proper operation. but because locking introduces an overhead, it is disabled by default. tradeoffs, bestie, tradeoffs.

OSSL_FUNC_rand_enable_locking() — allows locking to be turned on for a DRBG and all of its parent DRBGs. from this call onwards, the DRBG can be used in a thread safe manner. it's giving main character energy for your multithreaded app ✨
OSSL_FUNC_rand_lock() — used to lock a DRBG. once locked, exclusive access is guaranteed. no sharing, no interruptions 💅
OSSL_FUNC_rand_unlock() — used to unlock a DRBG. ok you can come back in now 🫶

🦋 Rand Parameters 🦋

see OSSL_PARAM(3) for further details on the parameters structure these functions use.

OSSL_FUNC_rand_get_params() — gets details of parameter values associated with the provider algorithm and stores them in params.
OSSL_FUNC_rand_set_ctx_params() — sets rand parameters associated with the given provider side rand context ctx to params. any parameter settings are additional to any that were previously set (so it's additive, not a reset, ok?). passing NULL for params should return true. ✨
OSSL_FUNC_rand_get_ctx_params() — gets details of currently set parameter values associated with the given provider side rand context ctx and stores them in params. passing NULL for params should return true. 👑
OSSL_FUNC_rand_gettable_params(), OSSL_FUNC_rand_gettable_ctx_params(), and OSSL_FUNC_rand_settable_ctx_params() — all return constant OSSL_PARAM(3) arrays as descriptors of the parameters that OSSL_FUNC_rand_get_params(), OSSL_FUNC_rand_get_ctx_params(), and OSSL_FUNC_rand_set_ctx_params() can handle, respectively. OSSL_FUNC_rand_gettable_ctx_params() and OSSL_FUNC_rand_settable_ctx_params() will return the parameters associated with the provider side context ctx in its current state if it is not NULL. otherwise, they return the parameters associated with the provider side algorithm provctx.

parameters currently recognised by built-in rands are as follows. not all parameters are relevant to, or are understood by all rands, so don't assume, bestie:

"state" (OSSL_RAND_PARAM_STATE) <integer> — returns the state of the random number generator. 🎀
"strength" (OSSL_RAND_PARAM_STRENGTH) <unsigned integer> — returns the bit strength of the random number generator.
"fips-indicator" (OSSL_RAND_PARAM_FIPS_APPROVED_INDICATOR) <integer> — a getter that returns 1 if the operation is FIPS approved, or 0 otherwise. this option is used by the OpenSSL FIPS provider and is not supported by all EVP_RAND sources.

for rands that are also deterministic random bit generators (DRBGs), these additional parameters are recognised. again, not all parameters are relevant to, or are understood by all DRBG rands:

"reseed_requests" (OSSL_DRBG_PARAM_RESEED_REQUESTS) <unsigned integer> — reads or set the number of generate requests before reseeding the associated RAND ctx.
"reseed_time_interval" (OSSL_DRBG_PARAM_RESEED_TIME_INTERVAL) <integer> — reads or set the number of elapsed seconds before reseeding the associated RAND ctx. ⏰
"max_request" (OSSL_DRBG_PARAM_RESEED_REQUESTS) <unsigned integer> — specifies the maximum number of bytes that can be generated in a single call to OSSL_FUNC_rand_generate.
"min_entropylen" (OSSL_DRBG_PARAM_MIN_ENTROPYLEN) <unsigned integer> and "max_entropylen" (OSSL_DRBG_PARAM_MAX_ENTROPYLEN) <unsigned integer> — specify the minimum and maximum number of bytes of random material that can be used to seed the DRBG.
"min_noncelen" (OSSL_DRBG_PARAM_MIN_NONCELEN) <unsigned integer> and "max_noncelen" (OSSL_DRBG_PARAM_MAX_NONCELEN) <unsigned integer> — specify the minimum and maximum number of bytes of nonce that can be used to instantiate the DRBG.
"max_perslen" (OSSL_DRBG_PARAM_MAX_PERSLEN) <unsigned integer> and "max_adinlen" (OSSL_DRBG_PARAM_MAX_ADINLEN) <unsigned integer> — specify the minimum and maximum number of bytes of personalisation string that can be used with the DRBG.
"reseed_counter" (OSSL_DRBG_PARAM_RESEED_COUNTER) <unsigned integer> — specifies the number of times the DRBG has been seeded or reseeded. 🔁
"digest" (OSSL_DRBG_PARAM_DIGEST) <UTF8 string>, "cipher" (OSSL_DRBG_PARAM_CIPHER) <UTF8 string>, "mac" (OSSL_DRBG_PARAM_MAC) <UTF8 string> — sets the name of the underlying cipher, digest or MAC to be used. it must name a suitable algorithm for the DRBG that's being used. no random picks, ok? 💅
"properties" (OSSL_DRBG_PARAM_PROPERTIES) <UTF8 string> — sets the properties to be queried when trying to fetch an underlying algorithm. this must be given together with the algorithm naming parameter to be considered valid. they're a package deal 🫶

the OpenSSL FIPS provider also supports the following parameters:

"fips-indicator" (OSSL_DRBG_PARAM_FIPS_APPROVED_INDICATOR) <integer> — a getter that returns 1 if the operation is FIPS approved, or 0 otherwise. this may be used after calling OSSL_FUNC_rand_generate(). it may return 0 if the "digest-check" is set to 0.
"digest-check" (OSSL_DRBG_PARAM_FIPS_DIGEST_CHECK) <integer> — if required this parameter should be set before the digest is set. the default value of 1 causes an error when the digest is set if the digest is not FIPS approved (e.g. truncated digests). setting this to 0 will ignore the error and set the approved "fips-indicator" to 0.

⚠️ heads up bestie: this option breaks FIPS compliance if it causes the approved "fips-indicator" to return 0. like, actually. be careful.

⭐ RETURN VALUES ⭐

OSSL_FUNC_rand_newctx() — should return the newly created provider side rand context, or NULL on failure.
OSSL_FUNC_rand_gettable_params(), OSSL_FUNC_rand_gettable_ctx_params() and OSSL_FUNC_rand_settable_ctx_params() — should return a constant OSSL_PARAM(3) array, or NULL if none is offered.
OSSL_FUNC_rand_nonce() — returns the size of the generated nonce, or 0 on error.
OSSL_FUNC_rand_get_seed() — returns the size of the generated seed, or 0 on error.
all of the remaining functions — should return 1 for success or 0 on error. classic ✅

🧚 NOTES 🧚

the RAND life-cycle is described in life_cycle-rand(7). providers should ensure that the various transitions listed there are supported 🫶. at some point the EVP layer will begin enforcing the listed transitions, so like… get on that.

💜 HISTORY 💜

the provider RAND interface was introduced in OpenSSL 3.0. the Rand Parameters "fips-indicator" and "digest-check" were added in OpenSSL 3.4. glow-up confirmed ✨

🍓 COPYRIGHT 🍓

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.

sooo that's the whole page, bestie 💖 this was PROVIDER-RAND(7ossl), version 3.5.6, dated 2026-04-07 — go forth and generate randomness responsibly, ily, bye 🎀🦋✨

📦 where this page comes from

freebsd 15.1: base 15.1
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-04: a language model's rewrite of the original, under its terms