.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" 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 .. .\" 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 C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . 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\} .el\{\ . 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. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, 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 .\" .\" 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 .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . 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 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . 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 .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "EVP_KDF-X942-ASN1 7ossl" .TH EVP_KDF-X942-ASN1 7ossl "2024-01-30" "3.2.1" "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\-X942\-ASN1 \- The X9.42\-2003 asn1 EVP_KDF implementation .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \s-1EVP_KDF\-X942\-ASN1\s0 algorithm implements the key derivation function X942KDF\-ASN1. It is used by \s-1DH\s0 KeyAgreement, to derive a key using input such as a shared secret key and other info. The other info is \s-1DER\s0 encoded data that contains a 32 bit counter as well as optional fields for \*(L"partyu-info\*(R", \&\*(L"partyv-info\*(R", \*(L"supp-pubinfo\*(R" and \*(L"supp-privinfo\*(R". This kdf is used by Cryptographic Message Syntax (\s-1CMS\s0). .SS "Identity" .IX Subsection "Identity" \&\*(L"X942KDF\-ASN1\*(R" or \*(L"X942KDF\*(R" is the name for this implementation; it can be used with the \fIEVP_KDF_fetch()\fR function. .SS "Supported parameters" .IX Subsection "Supported parameters" The supported parameters are: .ie n .IP """properties"" (\fB\s-1OSSL_KDF_PARAM_PROPERTIES\s0\fR) <\s-1UTF8\s0 string>" 4 .el .IP "``properties'' (\fB\s-1OSSL_KDF_PARAM_PROPERTIES\s0\fR) <\s-1UTF8\s0 string>" 4 .IX Item "properties (OSSL_KDF_PARAM_PROPERTIES) " .PD 0 .ie n .IP """digest"" (\fB\s-1OSSL_KDF_PARAM_DIGEST\s0\fR) <\s-1UTF8\s0 string>" 4 .el .IP "``digest'' (\fB\s-1OSSL_KDF_PARAM_DIGEST\s0\fR) <\s-1UTF8\s0 string>" 4 .IX Item "digest (OSSL_KDF_PARAM_DIGEST) " .PD These parameters work as described in \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1\fIEVP_KDF\s0\fR\|(3). .ie n .IP """secret"" (\fB\s-1OSSL_KDF_PARAM_SECRET\s0\fR) " 4 .el .IP "``secret'' (\fB\s-1OSSL_KDF_PARAM_SECRET\s0\fR) " 4 .IX Item "secret (OSSL_KDF_PARAM_SECRET) " The shared secret used for key derivation. This parameter sets the secret. .ie n .IP """acvp-info"" (\fB\s-1OSSL_KDF_PARAM_X942_ACVPINFO\s0\fR) " 4 .el .IP "``acvp-info'' (\fB\s-1OSSL_KDF_PARAM_X942_ACVPINFO\s0\fR) " 4 .IX Item "acvp-info (OSSL_KDF_PARAM_X942_ACVPINFO) " This value should not be used in production and should only be used for \s-1ACVP\s0 testing. It is an optional octet string containing a combined \s-1DER\s0 encoded blob of any of the optional fields related to \*(L"partyu-info\*(R", \*(L"partyv-info\*(R", \&\*(L"supp-pubinfo\*(R" and \*(L"supp-privinfo\*(R". If it is specified then none of these other fields should be used. .ie n .IP """partyu-info"" (\fB\s-1OSSL_KDF_PARAM_X942_PARTYUINFO\s0\fR) " 4 .el .IP "``partyu-info'' (\fB\s-1OSSL_KDF_PARAM_X942_PARTYUINFO\s0\fR) " 4 .IX Item "partyu-info (OSSL_KDF_PARAM_X942_PARTYUINFO) " An optional octet string containing public info contributed by the initiator. .ie n .IP """ukm"" (\fB\s-1OSSL_KDF_PARAM_UKM\s0\fR) " 4 .el .IP "``ukm'' (\fB\s-1OSSL_KDF_PARAM_UKM\s0\fR) " 4 .IX Item "ukm (OSSL_KDF_PARAM_UKM) " An alias for \*(L"partyu-info\*(R". In \s-1CMS\s0 this is the user keying material. .ie n .IP """partyv-info"" (\fB\s-1OSSL_KDF_PARAM_X942_PARTYVINFO\s0\fR) " 4 .el .IP "``partyv-info'' (\fB\s-1OSSL_KDF_PARAM_X942_PARTYVINFO\s0\fR) " 4 .IX Item "partyv-info (OSSL_KDF_PARAM_X942_PARTYVINFO) " An optional octet string containing public info contributed by the responder. .ie n .IP """supp-pubinfo"" (\fB\s-1OSSL_KDF_PARAM_X942_SUPP_PUBINFO\s0\fR) " 4 .el .IP "``supp-pubinfo'' (\fB\s-1OSSL_KDF_PARAM_X942_SUPP_PUBINFO\s0\fR) " 4 .IX Item "supp-pubinfo (OSSL_KDF_PARAM_X942_SUPP_PUBINFO) " An optional octet string containing some additional, mutually-known public information. Setting this value also sets \*(L"use-keybits\*(R" to 0. .ie n .IP """use-keybits"" (\fB\s-1OSSL_KDF_PARAM_X942_USE_KEYBITS\s0\fR) " 4 .el .IP "``use-keybits'' (\fB\s-1OSSL_KDF_PARAM_X942_USE_KEYBITS\s0\fR) " 4 .IX Item "use-keybits (OSSL_KDF_PARAM_X942_USE_KEYBITS) " The default value of 1 will use the \s-1KEK\s0 key length (in bits) as the \&\*(L"supp-pubinfo\*(R". A value of 0 disables setting the \*(L"supp-pubinfo\*(R". .ie n .IP """supp-privinfo"" (\fB\s-1OSSL_KDF_PARAM_X942_SUPP_PRIVINFO\s0\fR) " 4 .el .IP "``supp-privinfo'' (\fB\s-1OSSL_KDF_PARAM_X942_SUPP_PRIVINFO\s0\fR) " 4 .IX Item "supp-privinfo (OSSL_KDF_PARAM_X942_SUPP_PRIVINFO) " An optional octet string containing some additional, mutually-known private information. .ie n .IP """cekalg"" (\fB\s-1OSSL_KDF_PARAM_CEK_ALG\s0\fR) <\s-1UTF8\s0 string>" 4 .el .IP "``cekalg'' (\fB\s-1OSSL_KDF_PARAM_CEK_ALG\s0\fR) <\s-1UTF8\s0 string>" 4 .IX Item "cekalg (OSSL_KDF_PARAM_CEK_ALG) " This parameter sets the \s-1CEK\s0 wrapping algorithm name. Valid values are \*(L"\s-1AES\-128\-WRAP\*(R", \*(L"AES\-192\-WRAP\*(R", \*(L"AES\-256\-WRAP\*(R"\s0 and \*(L"\s-1DES3\-WRAP\*(R".\s0 .SH "NOTES" .IX Header "NOTES" A context for X942KDF can be obtained by calling: .PP .Vb 2 \& EVP_KDF *kdf = EVP_KDF_fetch(NULL, "X942KDF", NULL); \& EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf); .Ve .PP The output length of an X942KDF is specified via the \fIkeylen\fR parameter to the \fIEVP_KDF_derive\fR\|(3) function. .SH "EXAMPLES" .IX Header "EXAMPLES" This example derives 24 bytes, with the secret key \*(L"secret\*(R" and random user keying material: .PP .Vb 5 \& EVP_KDF_CTX *kctx; \& EVP_KDF_CTX *kctx; \& unsigned char out[192/8]; \& unsignred char ukm[64]; \& OSSL_PARAM params[5], *p = params; \& \& if (RAND_bytes(ukm, sizeof(ukm)) <= 0) \& error("RAND_bytes"); \& \& kdf = EVP_KDF_fetch(NULL, "X942KDF", NULL); \& if (kctx == NULL) \& error("EVP_KDF_fetch"); \& kctx = EVP_KDF_CTX_new(kdf); \& EVP_KDF_free(kdf); \& if (kctx == NULL) \& error("EVP_KDF_CTX_new"); \& \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST, "SHA256", 0); \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SECRET, \& "secret", (size_t)6); \& *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_UKM, ukm, sizeof(ukm)); \& *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_CEK_ALG, "AES\-256\-WRAP, 0); \& *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" \&\s-1ANS1 X9.42\-2003 RFC 2631\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1\fIEVP_KDF\s0\fR\|(3), \&\fIEVP_KDF_CTX_new\fR\|(3), \&\fIEVP_KDF_CTX_free\fR\|(3), \&\fIEVP_KDF_CTX_set_params\fR\|(3), \&\fIEVP_KDF_CTX_get_kdf_size\fR\|(3), \&\fIEVP_KDF_derive\fR\|(3), \&\*(L"\s-1PARAMETERS\*(R"\s0 in \s-1\fIEVP_KDF\s0\fR\|(3) .SH "HISTORY" .IX Header "HISTORY" This functionality was added in OpenSSL 3.0. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2019\-2021 The OpenSSL Project Authors. All Rights Reserved. .PP 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 .