$NetBSD: RAND_get0_primary.3,v 1.5 2024/09/08 13:08:29 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "RAND_get0_primary 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
RAND_get0_primary, RAND_get0_public, RAND_get0_private \- get access to the global EVP_RAND_CTX instances Header "SYNOPSIS" .Vb 1 #include <openssl/rand.h> \& EVP_RAND_CTX *RAND_get0_primary(OSSL_LIB_CTX *ctx); EVP_RAND_CTX *RAND_get0_public(OSSL_LIB_CTX *ctx); EVP_RAND_CTX *RAND_get0_private(OSSL_LIB_CTX *ctx); .Ve Header "DESCRIPTION" The default RAND API implementation (RAND_OpenSSL()) utilizes three shared DRBG instances which are accessed via the RAND API:

The public and private DRBG are thread-local instances, which are used by RAND_bytes() and RAND_priv_bytes(), respectively. The primary DRBG is a global instance, which is not intended to be used directly, but is used internally to reseed the other two instances.

These functions here provide access to the shared DRBG instances.

Header "RETURN VALUES" \fBRAND_get0_primary() returns a pointer to the primary DRBG instance for the given OSSL_LIB_CTX ctx.

\fBRAND_get0_public() returns a pointer to the public DRBG instance for the given OSSL_LIB_CTX ctx.

\fBRAND_get0_private() returns a pointer to the private DRBG instance for the given OSSL_LIB_CTX ctx.

In all the above cases the ctx parameter can be NULL in which case the default OSSL_LIB_CTX is used.

Header "NOTES" It is not thread-safe to access the primary DRBG instance. The public and private DRBG instance can be accessed safely, because they are thread-local. Note however, that changes to these two instances apply only to the current thread.

For that reason it is recommended not to change the settings of these three instances directly. Instead, an application should change the default settings for new DRBG instances at initialization time, before creating additional threads.

During initialization, it is possible to change the reseed interval and reseed time interval. It is also possible to exchange the reseeding callbacks entirely.

To set the type of DRBG that will be instantiated, use the \fBRAND_set_DRBG_type\|(3) call before accessing the random number generation infrastructure.

Header "SEE ALSO" \fBEVP_RAND\|(3), \fBRAND_set_DRBG_type\|(3) Header "HISTORY" These functions were added in OpenSSL 3.0. Header "COPYRIGHT" Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.

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>.