xref: /freebsd/secure/lib/libcrypto/man/man7/EVP_KDF-X942-ASN1.7 (revision bdcbfde31e8e9b343f113a1956384bdf30d1ed62)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

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 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-X942-ASN1 7ossl"
EVP_KDF-X942-ASN1 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
EVP_KDF-X942-ASN1 - The X9.42-2003 asn1 EVP_KDF implementation
"DESCRIPTION"
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).
"Identity"
Subsection "Identity" \*(L"X942KDF-ASN1\*(R" or \*(L"X942KDF\*(R" 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). Item "secret (OSSL_KDF_PARAM_SECRET) <octet string>" The shared secret used for key derivation. This parameter sets the secret. Item "acvp-info (OSSL_KDF_PARAM_X942_ACVPINFO) <octet string>" 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. Item "partyu-info (OSSL_KDF_PARAM_X942_PARTYUINFO) <octet string>" An optional octet string containing public info contributed by the initiator. Item "ukm (OSSL_KDF_PARAM_UKM) <octet string>" An alias for \*(L"partyu-info\*(R". In \s-1CMS\s0 this is the user keying material. Item "partyv-info (OSSL_KDF_PARAM_X942_PARTYVINFO) <octet string>" An optional octet string containing public info contributed by the responder. Item "supp-pubinfo (OSSL_KDF_PARAM_X942_SUPP_PUBINFO) <octet string>" An optional octet string containing some additional, mutually-known public information. Setting this value also sets \*(L"use-keybits\*(R" to 0. Item "use-keybits (OSSL_KDF_PARAM_X942_USE_KEYBITS) <integer>" 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". Item "supp-privinfo (OSSL_KDF_PARAM_X942_SUPP_PRIVINFO) <octet string>" An optional octet string containing some additional, mutually-known private information. Item "cekalg (OSSL_KDF_PARAM_CEK_ALG) <UTF8 string>" 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

"NOTES"
Header "NOTES" A context for X942KDF can be obtained by calling:

.Vb 2 EVP_KDF *kdf = EVP_KDF_fetch(NULL, "X942KDF", NULL); EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf); .Ve

The output length of an X942KDF is specified via the keylen parameter to the EVP_KDF_derive\|(3) function.

"EXAMPLES"
Header "EXAMPLES" This example derives 24 bytes, with the secret key \*(L"secret\*(R" and random user keying material:

.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

"CONFORMING TO"
Header "CONFORMING TO" \s-1ANS1 X9.42-2003 RFC 2631\s0
"SEE ALSO"
Header "SEE ALSO" \s-1EVP_KDF\s0\|(3), \fBEVP_KDF_CTX_new\|(3), \fBEVP_KDF_CTX_free\|(3), \fBEVP_KDF_CTX_set_params\|(3), \fBEVP_KDF_CTX_get_kdf_size\|(3), \fBEVP_KDF_derive\|(3), \*(L"\s-1PARAMETERS\*(R"\s0 in \s-1EVP_KDF\s0\|(3)
"HISTORY"
Header "HISTORY" This functionality was added in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2019-2022 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>.