Debian Codegraph @

upstream/debian-unstable/man7/life_cycle-rand.7ssl

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 "LIFE_CYCLE-RAND 7SSL"
58 .TH LIFE_CYCLE-RAND 7SSL 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 life_cycle\-rand \- The RAND algorithm life\-cycle
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 All random number generator (RANDs)
68 go through a number of stages in their life-cycle:
69 .IP start 4
70 .IX Item "start"
71 This state represents the RAND before it has been allocated. It is the
72 starting state for any life-cycle transitions.
73 .IP newed 4
74 .IX Item "newed"
75 This state represents the RAND after it has been allocated but unable to
76 generate any output.
77 .IP instantiated 4
78 .IX Item "instantiated"
79 This state represents the RAND when it is set up and capable of generating
80 output.
81 .IP uninstantiated 4
82 .IX Item "uninstantiated"
83 This state represents the RAND when it has been shutdown and it is no longer
84 capable of generating output.
85 .IP freed 4
86 .IX Item "freed"
87 This state is entered when the RAND is freed. It is the terminal state
88 for all life-cycle transitions.
89 .SS "State Transition Diagram"
90 .IX Subsection "State Transition Diagram"
91 The usual life-cycle of a RAND is illustrated:
92 +-------------------------+
93 | start |
94 +-------------------------+
95 |
96 | EVP_RAND_CTX_new
97 v
98 +-------------------------+
99 | newed |
100 +-------------------------+
101 |
102 | EVP_RAND_instantiate
103 v
104 EVP_RAND_generate +-------------------------+
105 +-------------------- | |
106 | | instantiated |
107 +-------------------> | | <+
108 +-------------------------+ '
109 | '
110 | EVP_RAND_uninstantiate ' EVP_RAND_instantiate
111 v '
112 +-------------------------+ '
113 | uninstantiated | -+
114 +-------------------------+
115 |
116 | EVP_RAND_CTX_free
117 v
118 +-------------------------+
119 | freed |
120 +-------------------------+
121 .SS "Formal State Transitions"
122 .IX Subsection "Formal State Transitions"
123 This section defines all of the legal state transitions.
124 This is the canonical list.
125 Function Call ------------------ Current State ------------------
126 start newed instantiated uninstantiated freed
127 EVP_RAND_CTX_new newed
128 EVP_RAND_instantiate instantiated
129 EVP_RAND_generate instantiated
130 EVP_RAND_uninstantiate uninstantiated
131 EVP_RAND_CTX_free freed freed freed freed
132 EVP_RAND_CTX_get_params newed instantiated uninstantiated freed
133 EVP_RAND_CTX_set_params newed instantiated uninstantiated freed
134 EVP_RAND_CTX_gettable_params newed instantiated uninstantiated freed
135 EVP_RAND_CTX_settable_params newed instantiated uninstantiated freed
136 .SH NOTES
137 .IX Header "NOTES"
138 At some point the EVP layer will begin enforcing the transitions described
139 herein.
140 .SH "SEE ALSO"
141 .IX Header "SEE ALSO"
142 \&\fBprovider\-rand\fR\|(7), \fBEVP_RAND\fR\|(3).
143 .SH HISTORY
144 .IX Header "HISTORY"
145 The provider RAND interface was introduced in OpenSSL 3.0.
146 .SH COPYRIGHT
147 .IX Header "COPYRIGHT"
148 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
149 .PP
150 Licensed under the Apache License 2.0 (the "License"). You may not use
151 this file except in compliance with the License. You can obtain a copy
152 in the file LICENSE in the source distribution or at
153 <https://www.openssl.org/source/license.html>.