1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
62 . tm Index:\\$1\t\\n%\t"\\$2"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . \" simple accents for nroff and troff
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
133 .\" ========================================================================
135 .IX Title "EVP_PKEY_CTX_SET_TLS1_PRF_MD 3"
136 .TH EVP_PKEY_CTX_SET_TLS1_PRF_MD 3 "2020-12-08" "1.1.1i" "OpenSSL"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
142 EVP_PKEY_CTX_set_tls1_prf_md, EVP_PKEY_CTX_set1_tls1_prf_secret, EVP_PKEY_CTX_add1_tls1_prf_seed \- TLS PRF key derivation algorithm
144 .IX Header "SYNOPSIS"
146 \& #include <openssl/kdf.h>
148 \& int EVP_PKEY_CTX_set_tls1_prf_md(EVP_PKEY_CTX *pctx, const EVP_MD *md);
149 \& int EVP_PKEY_CTX_set1_tls1_prf_secret(EVP_PKEY_CTX *pctx,
150 \& unsigned char *sec, int seclen);
151 \& int EVP_PKEY_CTX_add1_tls1_prf_seed(EVP_PKEY_CTX *pctx,
152 \& unsigned char *seed, int seedlen);
155 .IX Header "DESCRIPTION"
156 The \fB\s-1EVP_PKEY_TLS1_PRF\s0\fR algorithm implements the \s-1PRF\s0 key derivation function for
157 \&\s-1TLS.\s0 It has no associated private key and only implements key derivation
158 using \fBEVP_PKEY_derive\fR\|(3).
160 \&\fBEVP_PKEY_set_tls1_prf_md()\fR sets the message digest associated with the
161 \&\s-1TLS PRF.\s0 \fBEVP_md5_sha1()\fR is treated as a special case which uses the \s-1PRF\s0
162 algorithm using both \fB\s-1MD5\s0\fR and \fB\s-1SHA1\s0\fR as used in \s-1TLS 1.0\s0 and 1.1.
164 \&\fBEVP_PKEY_CTX_set_tls1_prf_secret()\fR sets the secret value of the \s-1TLS PRF\s0
165 to \fBseclen\fR bytes of the buffer \fBsec\fR. Any existing secret value is replaced
166 and any seed is reset.
168 \&\fBEVP_PKEY_CTX_add1_tls1_prf_seed()\fR sets the seed to \fBseedlen\fR bytes of \fBseed\fR.
169 If a seed is already set it is appended to the existing value.
171 .IX Header "STRING CTRLS"
172 The \s-1TLS PRF\s0 also supports string based control operations using
173 \&\fBEVP_PKEY_CTX_ctrl_str\fR\|(3).
174 The \fBtype\fR parameter \*(L"md\*(R" uses the supplied \fBvalue\fR as the name of the digest
176 The \fBtype\fR parameters \*(L"secret\*(R" and \*(L"seed\*(R" use the supplied \fBvalue\fR parameter
177 as a secret or seed value.
178 The names \*(L"hexsecret\*(R" and \*(L"hexseed\*(R" are similar except they take a hex string
179 which is converted to binary.
182 All these functions are implemented as macros.
184 A context for the \s-1TLS PRF\s0 can be obtained by calling:
187 \& EVP_PKEY_CTX *pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_TLS1_PRF, NULL);
190 The digest, secret value and seed must be set before a key is derived or an
193 The total length of all seeds cannot exceed 1024 bytes in length: this should
194 be more than enough for any normal use of the \s-1TLS PRF.\s0
196 The output length of the \s-1PRF\s0 is specified by the length parameter in the
197 \&\fBEVP_PKEY_derive()\fR function. Since the output length is variable, setting
198 the buffer to \fB\s-1NULL\s0\fR is not meaningful for the \s-1TLS PRF.\s0
200 Optimised versions of the \s-1TLS PRF\s0 can be implemented in an \s-1ENGINE.\s0
202 .IX Header "RETURN VALUES"
203 All these functions return 1 for success and 0 or a negative value for failure.
204 In particular a return value of \-2 indicates the operation is not supported by
205 the public key algorithm.
207 .IX Header "EXAMPLES"
208 This example derives 10 bytes using \s-1SHA\-256\s0 with the secret key \*(L"secret\*(R"
209 and seed value \*(L"seed\*(R":
212 \& EVP_PKEY_CTX *pctx;
213 \& unsigned char out[10];
214 \& size_t outlen = sizeof(out);
216 \& pctx = EVP_PKEY_CTX_new_id(EVP_PKEY_TLS1_PRF, NULL);
217 \& if (EVP_PKEY_derive_init(pctx) <= 0)
219 \& if (EVP_PKEY_CTX_set_tls1_prf_md(pctx, EVP_sha256()) <= 0)
221 \& if (EVP_PKEY_CTX_set1_tls1_prf_secret(pctx, "secret", 6) <= 0)
223 \& if (EVP_PKEY_CTX_add1_tls1_prf_seed(pctx, "seed", 4) <= 0)
225 \& if (EVP_PKEY_derive(pctx, out, &outlen) <= 0)
229 .IX Header "SEE ALSO"
230 \&\fBEVP_PKEY_CTX_new\fR\|(3),
231 \&\fBEVP_PKEY_CTX_ctrl_str\fR\|(3),
232 \&\fBEVP_PKEY_derive\fR\|(3)
234 .IX Header "COPYRIGHT"
235 Copyright 2016\-2019 The OpenSSL Project Authors. All Rights Reserved.
237 Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
238 this file except in compliance with the License. You can obtain a copy
239 in the file \s-1LICENSE\s0 in the source distribution or at
240 <https://www.openssl.org/source/license.html>.