xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/RAND_set_rand_method.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: RAND_set_rand_method.3,v 1.25 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_set_rand_method 3"
RAND_set_rand_method 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
RAND_set_rand_method, RAND_get_rand_method, RAND_OpenSSL - select RAND method
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/rand.h> .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 1 RAND_METHOD *RAND_OpenSSL(void); \& int RAND_set_rand_method(const RAND_METHOD *meth); \& const RAND_METHOD *RAND_get_rand_method(void); .Ve

DESCRIPTION
Header "DESCRIPTION" All of the functions described on this page are deprecated. Applications should instead use RAND_set_DRBG_type\|(3), \fBEVP_RAND\|(3) and EVP_RAND\|(7).

A RAND_METHOD specifies the functions that OpenSSL uses for random number generation.

\fBRAND_OpenSSL() returns the default RAND_METHOD implementation by OpenSSL. This implementation ensures that the PRNG state is unique for each thread.

If an ENGINE is loaded that provides the RAND API, however, it will be used instead of the method returned by RAND_OpenSSL(). This is deprecated in OpenSSL 3.0.

\fBRAND_set_rand_method() makes meth the method for PRNG use. If an ENGINE was providing the method, it will be released first.

\fBRAND_get_rand_method() returns a pointer to the current RAND_METHOD.

"THE RAND_METHOD STRUCTURE"
Header "THE RAND_METHOD STRUCTURE" .Vb 8 typedef struct rand_meth_st { int (*seed)(const void *buf, int num); int (*bytes)(unsigned char *buf, int num); void (*cleanup)(void); int (*add)(const void *buf, int num, double entropy); int (*pseudorand)(unsigned char *buf, int num); int (*status)(void); } RAND_METHOD; .Ve

The fields point to functions that are used by, in order, \fBRAND_seed(), RAND_bytes(), internal RAND cleanup, RAND_add(), RAND_pseudo_rand() and RAND_status(). Each pointer may be NULL if the function is not implemented.

"RETURN VALUES"
Header "RETURN VALUES" \fBRAND_set_rand_method() returns 1 on success and 0 on failure. \fBRAND_get_rand_method() and RAND_OpenSSL() return pointers to the respective methods.
"SEE ALSO"
Header "SEE ALSO" \fBEVP_RAND\|(3), \fBRAND_set_DRBG_type\|(3), \fBRAND_bytes\|(3), \fBENGINE_by_id\|(3), \fBEVP_RAND\|(7), \fBRAND\|(7)
HISTORY
Header "HISTORY" All of these functions were deprecated in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2000-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>.