EVP_KDF-TLS1_PRF.7 revision 1.2.2.3 $NetBSD: EVP_KDF-TLS1_PRF.7,v 1.2.2.3 2023/11/02 19:32:23 sborrill Exp $ Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) Standard preamble: ========================================================================..
..
..
Set up some character translations and predefined strings. \*(-- will give an unbreakable dash, \*(PI will give pi, \*(L" will give a left double quote, and \*(R" will give a right double quote. \*(C+ will give a nicer C++. Capital omega is used to do unbreakable dashes and therefore won't be available. \*(C` and \*(C' expand to `' in nroff, nothing in troff, for use with C<>..tr \(*W-
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. 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'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #]
.\}
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
. \" corrections for vroff
. \" for low resolution devices (crt and lpr)
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
======================================================================== Title "EVP_KDF-TLS1_PRF 7" EVP_KDF-TLS1_PRF 7 "2023-05-07" "3.0.12" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents..nh
"NAME"
EVP_KDF-TLS1_PRF - The TLS1 PRF EVP_KDF implementation
"DESCRIPTION"
Header "DESCRIPTION" Support for computing the
\s-1TLS1\s0 \s-1PRF\s0 through the
\s-1EVP_KDF\s0 \s-1API.\s0
The \s-1EVP_KDF-TLS1_PRF\s0 algorithm implements the \s-1PRF\s0 used by \s-1TLS\s0 versions up to
and including \s-1TLS 1.2.\s0
"Identity"
Subsection "Identity" \*(L"\s-1TLS1-PRF\*(R"\s0 is the name for this implementation; it
can be used with the
EVP_KDF_fetch() function.
"Supported parameters"
Subsection "Supported parameters" The supported parameters are:
Item "properties (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" 0
Item "digest (OSSL_KDF_PARAM_DIGEST) <UTF8 string>"
These parameters work as described in \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_KDF\s0\|(3).
.Sp
The \s-1OSSL_KDF_PARAM_DIGEST\s0 parameter is used to set the message digest
associated with the \s-1TLS PRF.\s0
\fBEVP_md5_sha1() is treated as a special case which uses the
\s-1PRF\s0 algorithm using both \s-1MD5\s0 and \s-1SHA1\s0 as used in \s-1TLS 1.0\s0 and 1.1.
Item "secret (OSSL_KDF_PARAM_SECRET) <octet string>" This parameter sets the secret value of the \s-1TLS PRF.\s0
Any existing secret value is replaced.
Item "seed (OSSL_KDF_PARAM_SEED) <octet string>" This parameter sets the context seed.
The length of the context seed cannot exceed 1024 bytes;
this should be more than enough for any normal use of the \s-1TLS PRF.\s0
"NOTES"
Header "NOTES" A context for the \s-1TLS PRF\s0 can be obtained by calling:
.Vb 2
EVP_KDF *kdf = EVP_KDF_fetch(NULL, "TLS1-PRF", NULL);
EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf);
.Ve
The digest, secret value and seed must be set before a key is derived otherwise
an error will occur.
The output length of the \s-1PRF\s0 is specified by the keylen parameter to the
\fBEVP_KDF_derive() function.
"EXAMPLES"
Header "EXAMPLES" This example derives 10 bytes using \s-1SHA-256\s0 with the secret key \*(L"secret\*(R"
and seed value \*(L"seed\*(R":
.Vb 4
EVP_KDF *kdf;
EVP_KDF_CTX *kctx;
unsigned char out[10];
OSSL_PARAM params[4], *p = params;
\&
kdf = EVP_KDF_fetch(NULL, "TLS1-PRF", NULL);
kctx = EVP_KDF_CTX_new(kdf);
EVP_KDF_free(kdf);
\&
*p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST,
SN_sha256, strlen(SN_sha256));
*p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SECRET,
"secret", (size_t)6);
*p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
"seed", (size_t)4);
*p = OSSL_PARAM_construct_end();
if (EVP_KDF_derive(kctx, out, sizeof(out), params) <= 0) {
error("EVP_KDF_derive");
}
EVP_KDF_CTX_free(kctx);
.Ve
"CONFORMING TO"
Header "CONFORMING TO" \s-1RFC 2246, RFC 5246\s0 and \s-1NIST SP 800-135\s0 r1
"SEE ALSO"
Header "SEE ALSO" \s-1
EVP_KDF\s0\|(3),
\fBEVP_KDF_CTX_new\|(3),
\fBEVP_KDF_CTX_free\|(3),
\fBEVP_KDF_CTX_set_params\|(3),
\fBEVP_KDF_derive\|(3),
\*(L"\s-1PARAMETERS\*(R"\s0 in \s-1
EVP_KDF\s0\|(3)
"HISTORY"
Header "HISTORY" This functionality was added in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.