1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
.\" -*- 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 "LIFE_CYCLE-DIGEST 7ssl"
.TH LIFE_CYCLE-DIGEST 7ssl 2024-04-28 3.3.0 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
life_cycle\-digest \- The digest algorithm life\-cycle
.SH DESCRIPTION
.IX Header "DESCRIPTION"
All message digests (MDs) go through a number of stages in their life-cycle:
.IP start 4
.IX Item "start"
This state represents the MD before it has been allocated. It is the
starting state for any life-cycle transitions.
.IP newed 4
.IX Item "newed"
This state represents the MD after it has been allocated.
.IP initialised 4
.IX Item "initialised"
This state represents the MD when it is set up and capable of processing
input.
.IP updated 4
.IX Item "updated"
This state represents the MD when it is set up and capable of processing
additional input or generating output.
.IP finaled 4
.IX Item "finaled"
This state represents the MD when it has generated output.
For an XOF digest, this state represents the MD when it has generated a
single-shot output.
.IP squeezed 4
.IX Item "squeezed"
For an XOF digest, this state represents the MD when it has generated output.
It can be called multiple times to generate more output. The output length is
variable for each call.
.IP freed 4
.IX Item "freed"
This state is entered when the MD is freed. It is the terminal state
for all life-cycle transitions.
.SS "State Transition Diagram"
.IX Subsection "State Transition Diagram"
The usual life-cycle of a MD is illustrated:
+--------------------+
| start |
+--------------------+
| EVP_MD_CTX_reset
| EVP_MD_CTX_new +-------------------------------------------------+
v v |
EVP_MD_CTX_reset + - - - - - - - - - - - - - - - - - - - - - - + EVP_MD_CTX_reset |
+-------------------> ' newed ' <--------------------+ |
| + - - - - - - - - - - - - - - - - - - - - - - + | |
| | | |
| | EVP_DigestInit | |
| v | |
| EVP_DigestInit + - - - - - - - - - - - - - - - - - - - - - - + | |
+----+-------------------> ' initialised ' <+ EVP_DigestInit | |
| | + - - - - - - - - - - - - - - - - - - - - - - + | | |
| | | ^ | | |
| | | EVP_DigestUpdate | EVP_DigestInit | | |
| | v | | | |
| | +---------------------------------------------+ | | |
| +-------------------- | | | | |
| | | | | |
| EVP_DigestUpdate | | | | |
| +-------------------- | | | | |
| | | updated | | | |
| +-------------------> | | | | |
| | | | | |
| | | | | |
+----+------------------------- | | -+-------------------+----+ |
| | +---------------------------------------------+ | | | |
| | | | | | |
| | | EVP_DigestSqueeze +-------------------+ | | |
| | v | | | |
| | EVP_DigestSqueeze +---------------------------------------------+ | | |
| | +-------------------- | | | | |
| | | | squeezed | | | |
| | +-------------------> | | ---------------------+ | |
| | +---------------------------------------------+ | |
| | | | |
| | +---------------------------------------+ | |
| | | | |
| | +---------------------------------------------+ EVP_DigestFinalXOF | | |
| +------------------------- | finaled | <--------------------+----+ |
| +---------------------------------------------+ | |
| EVP_DigestFinal ^ | | | |
+---------------------------------+ | | EVP_MD_CTX_free | |
| v | |
| +------------------+ EVP_MD_CTX_free | |
| | freed | <--------------------+ |
| +------------------+ |
| |
+------------------------------------------------------+
.SS "Formal State Transitions"
.IX Subsection "Formal State Transitions"
This section defines all of the legal state transitions.
This is the canonical list.
Function Call --------------------- Current State -----------------------------------
start newed initialised updated finaled squeezed freed
EVP_MD_CTX_new newed
EVP_DigestInit initialised initialised initialised initialised initialised
EVP_DigestUpdate updated updated
EVP_DigestFinal finaled
EVP_DigestFinalXOF finaled
EVP_DigestSqueeze squeezed squeezed
EVP_MD_CTX_free freed freed freed freed freed
EVP_MD_CTX_reset newed newed newed newed
EVP_MD_CTX_get_params newed initialised updated
EVP_MD_CTX_set_params newed initialised updated
EVP_MD_CTX_gettable_params newed initialised updated
EVP_MD_CTX_settable_params newed initialised updated
EVP_MD_CTX_copy_ex newed initialised updated squeezed
.SH NOTES
.IX Header "NOTES"
At some point the EVP layer will begin enforcing the transitions described
herein.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBprovider\-digest\fR\|(7), \fBEVP_DigestInit\fR\|(3)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2021\-2023 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>.
|
