Debian Codegraph @

upstream/debian-unstable/man7/life_cycle-kdf.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-KDF 7SSL"
58 .TH LIFE_CYCLE-KDF 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\-kdf \- The KDF algorithm life\-cycle
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 All key derivation functions (KDFs) and pseudo random functions (PRFs)
68 go through a number of stages in their life-cycle:
69 .IP start 4
70 .IX Item "start"
71 This state represents the KDF/PRF 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 KDF/PRF after it has been allocated.
76 .IP deriving 4
77 .IX Item "deriving"
78 This state represents the KDF/PRF when it is set up and capable of generating
79 output.
80 .IP freed 4
81 .IX Item "freed"
82 This state is entered when the KDF/PRF is freed. It is the terminal state
83 for all life-cycle transitions.
84 .SS "State Transition Diagram"
85 .IX Subsection "State Transition Diagram"
86 The usual life-cycle of a KDF/PRF is illustrated:
87 +-------------------+
88 | start |
89 +-------------------+
90 |
91 | EVP_KDF_CTX_new
92 v
93 +-------------------+
94 | newed | <+
95 +-------------------+ |
96 | |
97 | EVP_KDF_derive |
98 v | EVP_KDF_CTX_reset
99 EVP_KDF_derive +-------------------+ |
100 + - - - - - - - - | | |
101 ' | deriving | |
102 + - - - - - - - -> | | -+
103 +-------------------+
104 |
105 | EVP_KDF_CTX_free
106 v
107 +-------------------+
108 | freed |
109 +-------------------+
110 .SS "Formal State Transitions"
111 .IX Subsection "Formal State Transitions"
112 This section defines all of the legal state transitions.
113 This is the canonical list.
114 Function Call ------------- Current State -------------
115 start newed deriving freed
116 EVP_KDF_CTX_new newed
117 EVP_KDF_derive deriving deriving
118 EVP_KDF_CTX_free freed freed freed
119 EVP_KDF_CTX_reset newed newed
120 EVP_KDF_CTX_get_params newed deriving
121 EVP_KDF_CTX_set_params newed deriving
122 EVP_KDF_CTX_gettable_params newed deriving
123 EVP_KDF_CTX_settable_params newed deriving
124 .SH NOTES
125 .IX Header "NOTES"
126 At some point the EVP layer will begin enforcing the transitions described
127 herein.
128 .SH "SEE ALSO"
129 .IX Header "SEE ALSO"
130 \&\fBprovider\-kdf\fR\|(7), \fBEVP_KDF\fR\|(3).
131 .SH HISTORY
132 .IX Header "HISTORY"
133 The provider KDF interface was introduced in OpenSSL 3.0.
134 .SH COPYRIGHT
135 .IX Header "COPYRIGHT"
136 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
137 .PP
138 Licensed under the Apache License 2.0 (the "License"). You may not use
139 this file except in compliance with the License. You can obtain a copy
140 in the file LICENSE in the source distribution or at
141 <https://www.openssl.org/source/license.html>.