summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/RAND_get0_primary.3ssl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/RAND_get0_primary.3ssl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/RAND_get0_primary.3ssl')
-rw-r--r--upstream/debian-unstable/man3/RAND_get0_primary.3ssl147
1 files changed, 147 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/RAND_get0_primary.3ssl b/upstream/debian-unstable/man3/RAND_get0_primary.3ssl
new file mode 100644
index 00000000..e74e3b36
--- /dev/null
+++ b/upstream/debian-unstable/man3/RAND_get0_primary.3ssl
@@ -0,0 +1,147 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" 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'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "RAND_GET0_PRIMARY 3SSL"
+.TH RAND_GET0_PRIMARY 3SSL 2024-02-03 3.1.5 OpenSSL
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+RAND_get0_primary,
+RAND_get0_public,
+RAND_get0_private,
+RAND_set0_public,
+RAND_set0_private
+\&\- get access to the global EVP_RAND_CTX instances
+.SH SYNOPSIS
+.IX 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);
+\& int RAND_set0_public(OSSL_LIB_CTX *ctx, EVP_RAND_CTX *rand);
+\& int RAND_set0_private(OSSL_LIB_CTX *ctx, EVP_RAND_CTX *rand);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+The default RAND API implementation (\fBRAND_OpenSSL()\fR) utilizes three
+shared DRBG instances which are accessed via the RAND API:
+.PP
+The \fIpublic\fR and \fIprivate\fR DRBG are thread-local instances, which are used
+by \fBRAND_bytes()\fR and \fBRAND_priv_bytes()\fR, respectively.
+The \fIprimary\fR DRBG is a global instance, which is not intended to be used
+directly, but is used internally to reseed the other two instances.
+.PP
+The three get functions provide access to the shared DRBG instances.
+.PP
+The two set functions allow the public and private DRBG instances to be
+replaced by another random number generator.
+.SH "RETURN VALUES"
+.IX Header "RETURN VALUES"
+\&\fBRAND_get0_primary()\fR returns a pointer to the \fIprimary\fR DRBG instance
+for the given OSSL_LIB_CTX \fBctx\fR.
+.PP
+\&\fBRAND_get0_public()\fR returns a pointer to the \fIpublic\fR DRBG instance
+for the given OSSL_LIB_CTX \fBctx\fR.
+.PP
+\&\fBRAND_get0_private()\fR returns a pointer to the \fIprivate\fR DRBG instance
+for the given OSSL_LIB_CTX \fBctx\fR.
+.PP
+\&\fBRAND_set0_public()\fR and \fBRAND_set0_private()\fR return 1 on success and 0
+on error.
+.SH NOTES
+.IX Header "NOTES"
+It is not thread-safe to access the \fIprimary\fR DRBG instance.
+The \fIpublic\fR and \fIprivate\fR 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.
+.PP
+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.
+.PP
+During initialization, it is possible to change the reseed interval
+and reseed time interval.
+It is also possible to exchange the reseeding callbacks entirely.
+.PP
+To set the type of DRBG that will be instantiated, use the
+\&\fBRAND_set_DRBG_type\fR\|(3) call before accessing the random number generation
+infrastructure.
+.PP
+The two set functions, operate on the the current thread. If you want to
+use the same random number generator across all threads, each thread
+must individually call the set functions.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBEVP_RAND\fR\|(3),
+\&\fBRAND_set_DRBG_type\fR\|(3)
+.SH HISTORY
+.IX Header "HISTORY"
+\&\fBRAND_set0_public()\fR and \fBRAND_set0_private()\fR were added in OpenSSL 3.1.
+.PP
+The remaining functions were added in OpenSSL 3.0.
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright 2020\-2022 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+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>.