Debian Codegraph @

upstream/debian-unstable/man3/RAND_set_rand_method.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_SET_RAND_METHOD 3SSL"
58 .TH RAND_SET_RAND_METHOD 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_set_rand_method, RAND_get_rand_method, RAND_OpenSSL \- select RAND method
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/rand.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 3.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 1
76 \& RAND_METHOD *RAND_OpenSSL(void);
77 \&
78 \& int RAND_set_rand_method(const RAND_METHOD *meth);
79 \&
80 \& const RAND_METHOD *RAND_get_rand_method(void);
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 All of the functions described on this page are deprecated.
85 Applications should instead use \fBRAND_set_DRBG_type\fR\|(3),
86 \&\fBEVP_RAND\fR\|(3) and \fBEVP_RAND\fR\|(7).
87 .PP
88 A \fBRAND_METHOD\fR specifies the functions that OpenSSL uses for random number
89 generation.
90 .PP
91 \&\fBRAND_OpenSSL()\fR returns the default \fBRAND_METHOD\fR implementation by OpenSSL.
92 This implementation ensures that the PRNG state is unique for each thread.
93 .PP
94 If an \fBENGINE\fR is loaded that provides the RAND API, however, it will
95 be used instead of the method returned by \fBRAND_OpenSSL()\fR. This is deprecated
96 in OpenSSL 3.0.
97 .PP
98 \&\fBRAND_set_rand_method()\fR makes \fBmeth\fR the method for PRNG use. If an
99 ENGINE was providing the method, it will be released first.
100 .PP
101 \&\fBRAND_get_rand_method()\fR returns a pointer to the current \fBRAND_METHOD\fR.
102 .SH "THE RAND_METHOD STRUCTURE"
103 .IX Header "THE RAND_METHOD STRUCTURE"
104 .Vb 8
105 \& typedef struct rand_meth_st {
106 \& int (*seed)(const void *buf, int num);
107 \& int (*bytes)(unsigned char *buf, int num);
108 \& void (*cleanup)(void);
109 \& int (*add)(const void *buf, int num, double entropy);
110 \& int (*pseudorand)(unsigned char *buf, int num);
111 \& int (*status)(void);
112 \& } RAND_METHOD;
113 .Ve
114 .PP
115 The fields point to functions that are used by, in order,
116 \&\fBRAND_seed()\fR, \fBRAND_bytes()\fR, internal RAND cleanup, \fBRAND_add()\fR, \fBRAND_pseudo_rand()\fR
117 and \fBRAND_status()\fR.
118 Each pointer may be NULL if the function is not implemented.
119 .SH "RETURN VALUES"
120 .IX Header "RETURN VALUES"
121 \&\fBRAND_set_rand_method()\fR returns 1 on success and 0 on failure.
122 \&\fBRAND_get_rand_method()\fR and \fBRAND_OpenSSL()\fR return pointers to the respective
123 methods.
124 .SH "SEE ALSO"
125 .IX Header "SEE ALSO"
126 \&\fBEVP_RAND\fR\|(3),
127 \&\fBRAND_set_DRBG_type\fR\|(3),
128 \&\fBRAND_bytes\fR\|(3),
129 \&\fBENGINE_by_id\fR\|(3),
130 \&\fBEVP_RAND\fR\|(7),
131 \&\fBRAND\fR\|(7)
132 .SH HISTORY
133 .IX Header "HISTORY"
134 All of these functions were deprecated in OpenSSL 3.0.
135 .SH COPYRIGHT
136 .IX Header "COPYRIGHT"
137 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
138 .PP
139 Licensed under the Apache License 2.0 (the "License"). You may not use
140 this file except in compliance with the License. You can obtain a copy
141 in the file LICENSE in the source distribution or at
142 <https://www.openssl.org/source/license.html>.