diff options
Diffstat (limited to 'static/freebsd/man7/EVP_KDF-TLS1_PRF.7')
| -rw-r--r-- | static/freebsd/man7/EVP_KDF-TLS1_PRF.7 | 200 |
1 files changed, 200 insertions, 0 deletions
diff --git a/static/freebsd/man7/EVP_KDF-TLS1_PRF.7 b/static/freebsd/man7/EVP_KDF-TLS1_PRF.7 new file mode 100644 index 00000000..de4b6526 --- /dev/null +++ b/static/freebsd/man7/EVP_KDF-TLS1_PRF.7 @@ -0,0 +1,200 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) +.\" +.\" 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 +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l +.\" ======================================================================== +.\" +.IX Title "EVP_KDF-TLS1_PRF 7ossl" +.TH EVP_KDF-TLS1_PRF 7ossl 2026-04-07 3.5.6 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 +EVP_KDF\-TLS1_PRF \- The TLS1 PRF EVP_KDF implementation +.SH DESCRIPTION +.IX Header "DESCRIPTION" +Support for computing the \fBTLS1\fR PRF through the \fBEVP_KDF\fR API. +.PP +The EVP_KDF\-TLS1_PRF algorithm implements the PRF used by TLS versions up to +and including TLS 1.2. +.PP +The output is considered to be keying material. +.SS Identity +.IX Subsection "Identity" +"TLS1\-PRF" is the name for this implementation; it +can be used with the \fBEVP_KDF_fetch()\fR function. +.SS "Supported parameters" +.IX Subsection "Supported parameters" +The supported parameters are: +.IP """properties"" (\fBOSSL_KDF_PARAM_PROPERTIES\fR) <UTF8 string>" 4 +.IX Item """properties"" (OSSL_KDF_PARAM_PROPERTIES) <UTF8 string>" +.PD 0 +.IP """digest"" (\fBOSSL_KDF_PARAM_DIGEST\fR) <UTF8 string>" 4 +.IX Item """digest"" (OSSL_KDF_PARAM_DIGEST) <UTF8 string>" +.PD +These parameters work as described in "PARAMETERS" in \fBEVP_KDF\fR\|(3). +.Sp +The \fBOSSL_KDF_PARAM_DIGEST\fR parameter is used to set the message digest +associated with the TLS PRF. +\&\fBEVP_md5_sha1()\fR is treated as a special case which uses the +PRF algorithm using both \fBMD5\fR and \fBSHA1\fR as used in TLS 1.0 and 1.1. +.IP """secret"" (\fBOSSL_KDF_PARAM_SECRET\fR) <octet string>" 4 +.IX Item """secret"" (OSSL_KDF_PARAM_SECRET) <octet string>" +This parameter sets the secret value of the TLS PRF. +Any existing secret value is replaced. +.IP """seed"" (\fBOSSL_KDF_PARAM_SEED\fR) <octet string>" 4 +.IX 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 TLS PRF. +.PP +The OpenSSL FIPS provider also supports the following parameters: +.IP """fips\-indicator"" (\fBOSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4 +.IX Item """fips-indicator"" (OSSL_KDF_PARAM_FIPS_APPROVED_INDICATOR) <integer>" +A getter that returns 1 if the operation is FIPS approved, or 0 otherwise. +This may be used after calling EVP_KDF_derive. It returns 0 if any "***\-check" +related parameter is set to 0 and the check fails. +.IP """ems_check"" (\fBOSSL_KDF_PARAM_FIPS_EMS_CHECK\fR) <integer>" 4 +.IX Item """ems_check"" (OSSL_KDF_PARAM_FIPS_EMS_CHECK) <integer>" +The default value of 1 causes an error during \fBEVP_KDF_derive()\fR if +"master secret" is used instead of "extended master secret" Setting this to zero +will ignore the error and set the approved "fips\-indicator" to 0. +This option breaks FIPS compliance if it causes the approved "fips\-indicator" +to return 0. +.IP """digest\-check"" (\fBOSSL_KDF_PARAM_FIPS_DIGEST_CHECK\fR) <integer>" 4 +.IX Item """digest-check"" (OSSL_KDF_PARAM_FIPS_DIGEST_CHECK) <integer>" +The default value of 1 causes an error during \fBEVP_KDF_CTX_set_params()\fR if +used digest is not approved. +Setting this to zero will ignore the error and set the approved +"fips\-indicator" to 0. +This option breaks FIPS compliance if it causes the approved "fips\-indicator" +to return 0. +.Sp +According to SP 800\-135r1, the following are approved digest algorithms: +SHA2\-256, SHA2\-384, SHA2\-512. +.IP """key\-check"" (\fBOSSL_KDF_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4 +.IX Item """key-check"" (OSSL_KDF_PARAM_FIPS_KEY_CHECK) <integer>" +The default value of 1 causes an error during \fBEVP_KDF_CTX_set_params()\fR if the +length of used key\-derivation key (\fBOSSL_KDF_PARAM_SECRET\fR) is shorter than 112 +bits. +Setting this to zero will ignore the error and set the approved +"fips\-indicator" to 0. +This option breaks FIPS compliance if it causes the approved "fips\-indicator" +to return 0. +.SH NOTES +.IX Header "NOTES" +A context for the TLS PRF can be obtained by calling: +.PP +.Vb 2 +\& EVP_KDF *kdf = EVP_KDF_fetch(NULL, "TLS1\-PRF", NULL); +\& EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf); +.Ve +.PP +The digest, secret value and seed must be set before a key is derived otherwise +an error will occur. +.PP +The output length of the PRF is specified by the \fIkeylen\fR parameter to the +\&\fBEVP_KDF_derive()\fR function. +.SH EXAMPLES +.IX Header "EXAMPLES" +This example derives 10 bytes using SHA\-256 with the secret key "secret" +and seed value "seed": +.PP +.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 +.SH "CONFORMING TO" +.IX Header "CONFORMING TO" +RFC 2246, RFC 5246 and NIST SP 800\-135 r1 +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBEVP_KDF\fR\|(3), +\&\fBEVP_KDF_CTX_new\fR\|(3), +\&\fBEVP_KDF_CTX_free\fR\|(3), +\&\fBEVP_KDF_CTX_set_params\fR\|(3), +\&\fBEVP_KDF_derive\fR\|(3), +"PARAMETERS" in \fBEVP_KDF\fR\|(3) +.SH HISTORY +.IX Header "HISTORY" +This functionality was added in OpenSSL 3.0. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2018\-2024 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>. |