Add EVP_KDF-X942 to the fips module
[openssl.git] / doc / man7 / EVP_KDF-X942-ASN1.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_KDF-X942-ASN1 - The X9.42-2003 asn1 EVP_KDF implementation
6
7 =head1 DESCRIPTION
8
9 The EVP_KDF-X942-ASN1 algorithm implements the key derivation function
10 X942KDF-ASN1. It is used by DH KeyAgreement, to derive a key using input such as
11 a shared secret key and other info. The other info is DER encoded data that
12 contains a 32 bit counter as well as optional fields for "partyu-info",
13 "partyv-info", "supp-pubinfo" and "supp-privinfo".
14 This kdf is used by Cryptographic Message Syntax (CMS).
15
16 =head2 Identity
17
18 "X942KDF-ASN1" or "X942KDF" is the name for this implementation; it
19 can be used with the EVP_KDF_fetch() function.
20
21 =head2 Supported parameters
22
23 The supported parameters are:
24
25 =over 4
26
27 =item "properties" (B<OSSL_KDF_PARAM_PROPERTIES>) <UTF8 string>
28
29 =item "digest" (B<OSSL_KDF_PARAM_DIGEST>) <UTF8 string>
30
31 These parameters work as described in L<EVP_KDF(3)/PARAMETERS>.
32
33 =item "key" (B<OSSL_KDF_PARAM_KEY>) <octet string>
34
35 The shared secret used for key derivation.  This parameter sets the secret.
36
37 =item "partyu-info" (B<OSSL_KDF_PARAM_X942_PARTYUINFO>) <octet string>
38
39 An optional octet string containing public info contributed by the initiator.
40
41 =item "ukm" (B<OSSL_KDF_PARAM_UKM>) <octet string>
42
43 An alias for "partyu-info".
44 In CMS this is the user keying material.
45
46 =item "partyv-info" (B<OSSL_KDF_PARAM_X942_PARTYVINFO>) <octet string>
47
48 An optional octet string containing public info contributed by the responder.
49
50 =item "supp-pubinfo" (B<OSSL_KDF_PARAM_X942_SUPP_PUBINFO>) <octet string>
51
52 An optional octet string containing some additional, mutually-known public
53 information. Setting this value also sets "use-keybits" to 0.
54
55 =item "use-keybits" (B<OSSL_KDF_PARAM_X942_SUPP_PRIVINFO>) <integer>
56
57 The default value of 1 will use the KEK key length (in bits) as the
58 "supp-pubinfo". A value of 0 disables setting the "supp-pubinfo".
59
60 =item "supp-privinfo" (B<OSSL_KDF_PARAM_X942_SUPP_PRIVINFO>) <octet string>
61
62 An optional octet string containing some additional, mutually-known private
63 information.
64
65 =item "cekalg" (B<OSSL_KDF_PARAM_CEK_ALG>) <UTF8 string>
66
67 This parameter sets the CEK wrapping algorithm name.
68 Valid values are "AES-128-WRAP", "AES-192-WRAP", "AES-256-WRAP" and "DES3-WRAP".
69
70 =back
71
72 =head1 NOTES
73
74 A context for X942KDF can be obtained by calling:
75
76  EVP_KDF *kdf = EVP_KDF_fetch(NULL, "X942KDF", NULL);
77  EVP_KDF_CTX *kctx = EVP_KDF_CTX_new(kdf);
78
79 The output length of an X942KDF is specified via the I<keylen>
80 parameter to the L<EVP_KDF_derive(3)> function.
81
82 =head1 EXAMPLES
83
84 This example derives 24 bytes, with the secret key "secret" and random user
85 keying material:
86
87   EVP_KDF_CTX *kctx;
88   EVP_KDF_CTX *kctx;
89   unsigned char out[192/8];
90   unsignred char ukm[64];
91   OSSL_PARAM params[5], *p = params;
92
93   if (RAND_bytes(ukm, sizeof(ukm)) <= 0)
94       error("RAND_bytes");
95
96   kdf = EVP_KDF_fetch(NULL, "X942KDF", NULL);
97   if (kctx == NULL)
98       error("EVP_KDF_fetch");
99   kctx = EVP_KDF_CTX_new(kdf);
100   EVP_KDF_free(kdf);
101   if (kctx == NULL)
102       error("EVP_KDF_CTX_new");
103
104   *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_DIGEST, "SHA256", 0);
105   *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SECRET,
106                                            "secret", (size_t)6);
107   *p++ = OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_UKM, ukm, sizeof(ukm));
108   *p++ = OSSL_PARAM_construct_utf8_string(OSSL_KDF_PARAM_CEK_ALG, "AES-256-WRAP, 0);
109   *p = OSSL_PARAM_construct_end();
110   if (EVP_KDF_CTX_set_params(kctx, params) <= 0)
111       error("EVP_KDF_CTX_set_params");
112
113   if (EVP_KDF_derive(kctx, out, sizeof(out)) <= 0)
114       error("EVP_KDF_derive");
115
116   EVP_KDF_CTX_free(kctx);
117
118 =head1 CONFORMING TO
119
120 ANS1 X9.42-2003
121 RFC 2631
122
123 =head1 SEE ALSO
124
125 L<EVP_KDF(3)>,
126 L<EVP_KDF_CTX_new(3)>,
127 L<EVP_KDF_CTX_free(3)>,
128 L<EVP_KDF_CTX_set_params(3)>,
129 L<EVP_KDF_CTX_get_kdf_size(3)>,
130 L<EVP_KDF_derive(3)>,
131 L<EVP_KDF(3)/PARAMETERS>
132
133 =head1 HISTORY
134
135 This functionality was added to OpenSSL 3.0.
136
137 =head1 COPYRIGHT
138
139 Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
140
141 Licensed under the Apache License 2.0 (the "License").  You may not use
142 this file except in compliance with the License.  You can obtain a copy
143 in the file LICENSE in the source distribution or at
144 L<https://www.openssl.org/source/license.html>.
145
146 =cut