Debian Codegraph @

upstream/debian-unstable/man3/RAND_get0_primary.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "RAND_GET0_PRIMARY 3SSL"
58 .TH RAND_GET0_PRIMARY 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 RAND_get0_primary,
65 RAND_get0_public,
66 RAND_get0_private,
67 RAND_set0_public,
68 RAND_set0_private
69 \&\- get access to the global EVP_RAND_CTX instances
70 .SH SYNOPSIS
71 .IX Header "SYNOPSIS"
72 .Vb 1
73 \& #include <openssl/rand.h>
74 \&
75 \& EVP_RAND_CTX *RAND_get0_primary(OSSL_LIB_CTX *ctx);
76 \& EVP_RAND_CTX *RAND_get0_public(OSSL_LIB_CTX *ctx);
77 \& EVP_RAND_CTX *RAND_get0_private(OSSL_LIB_CTX *ctx);
78 \& int RAND_set0_public(OSSL_LIB_CTX *ctx, EVP_RAND_CTX *rand);
79 \& int RAND_set0_private(OSSL_LIB_CTX *ctx, EVP_RAND_CTX *rand);
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 The default RAND API implementation (\fBRAND_OpenSSL()\fR) utilizes three
84 shared DRBG instances which are accessed via the RAND API:
85 .PP
86 The \fIpublic\fR and \fIprivate\fR DRBG are thread-local instances, which are used
87 by \fBRAND_bytes()\fR and \fBRAND_priv_bytes()\fR, respectively.
88 The \fIprimary\fR DRBG is a global instance, which is not intended to be used
89 directly, but is used internally to reseed the other two instances.
90 .PP
91 The three get functions provide access to the shared DRBG instances.
92 .PP
93 The two set functions allow the public and private DRBG instances to be
94 replaced by another random number generator.
95 .SH "RETURN VALUES"
96 .IX Header "RETURN VALUES"
97 \&\fBRAND_get0_primary()\fR returns a pointer to the \fIprimary\fR DRBG instance
98 for the given OSSL_LIB_CTX \fBctx\fR.
99 .PP
100 \&\fBRAND_get0_public()\fR returns a pointer to the \fIpublic\fR DRBG instance
101 for the given OSSL_LIB_CTX \fBctx\fR.
102 .PP
103 \&\fBRAND_get0_private()\fR returns a pointer to the \fIprivate\fR DRBG instance
104 for the given OSSL_LIB_CTX \fBctx\fR.
105 .PP
106 \&\fBRAND_set0_public()\fR and \fBRAND_set0_private()\fR return 1 on success and 0
107 on error.
108 .SH NOTES
109 .IX Header "NOTES"
110 It is not thread-safe to access the \fIprimary\fR DRBG instance.
111 The \fIpublic\fR and \fIprivate\fR DRBG instance can be accessed safely, because
112 they are thread-local. Note however, that changes to these two instances
113 apply only to the current thread.
114 .PP
115 For that reason it is recommended not to change the settings of these
116 three instances directly.
117 Instead, an application should change the default settings for new DRBG instances
118 at initialization time, before creating additional threads.
119 .PP
120 During initialization, it is possible to change the reseed interval
121 and reseed time interval.
122 It is also possible to exchange the reseeding callbacks entirely.
123 .PP
124 To set the type of DRBG that will be instantiated, use the
125 \&\fBRAND_set_DRBG_type\fR\|(3) call before accessing the random number generation
126 infrastructure.
127 .PP
128 The two set functions, operate on the current thread. If you want to
129 use the same random number generator across all threads, each thread
130 must individually call the set functions.
131 .SH "SEE ALSO"
132 .IX Header "SEE ALSO"
133 \&\fBEVP_RAND\fR\|(3),
134 \&\fBRAND_set_DRBG_type\fR\|(3)
135 .SH HISTORY
136 .IX Header "HISTORY"
137 \&\fBRAND_set0_public()\fR and \fBRAND_set0_private()\fR were added in OpenSSL 3.1.
138 .PP
139 The remaining functions were added in OpenSSL 3.0.
140 .SH COPYRIGHT
141 .IX Header "COPYRIGHT"
142 Copyright 2020\-2024 The OpenSSL Project Authors. All Rights Reserved.
143 .PP
144 Licensed under the Apache License 2.0 (the "License"). You may not use
145 this file except in compliance with the License. You can obtain a copy
146 in the file LICENSE in the source distribution or at
147 <https://www.openssl.org/source/license.html>.