2 * Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
5 * Licensed under the Apache License 2.0 (the "License"). You may not use
6 * this file except in compliance with the License. You can obtain a copy
7 * in the file LICENSE in the source distribution or at
8 * https://www.openssl.org/source/license.html
12 #include <openssl/core_names.h>
13 #include <openssl/core_dispatch.h>
14 #include <openssl/err.h>
15 #include <openssl/evp.h>
16 #include <openssl/params.h>
17 #include <openssl/proverr.h>
18 #include "internal/packet.h"
19 #include "internal/der.h"
20 #include "prov/provider_ctx.h"
21 #include "prov/providercommon.h"
22 #include "prov/implementations.h"
23 #include "prov/provider_util.h"
24 #include "prov/der_wrap.h"
26 #define X942KDF_MAX_INLEN (1 << 30)
28 static OSSL_FUNC_kdf_newctx_fn x942kdf_new;
29 static OSSL_FUNC_kdf_freectx_fn x942kdf_free;
30 static OSSL_FUNC_kdf_reset_fn x942kdf_reset;
31 static OSSL_FUNC_kdf_derive_fn x942kdf_derive;
32 static OSSL_FUNC_kdf_settable_ctx_params_fn x942kdf_settable_ctx_params;
33 static OSSL_FUNC_kdf_set_ctx_params_fn x942kdf_set_ctx_params;
34 static OSSL_FUNC_kdf_gettable_ctx_params_fn x942kdf_gettable_ctx_params;
35 static OSSL_FUNC_kdf_get_ctx_params_fn x942kdf_get_ctx_params;
40 unsigned char *secret;
42 unsigned char *acvpinfo;
44 unsigned char *partyuinfo, *partyvinfo, *supp_pubinfo, *supp_privinfo;
45 size_t partyuinfo_len, partyvinfo_len, supp_pubinfo_len, supp_privinfo_len;
47 const unsigned char *cek_oid;
53 * A table of allowed wrapping algorithms, oids and the associated output
55 * NOTE: RC2wrap and camellia128_wrap have been removed as there are no
56 * corresponding ciphers for these operations.
60 const unsigned char *oid;
62 size_t keklen; /* size in bytes */
64 { "AES-128-WRAP", ossl_der_oid_id_aes128_wrap, DER_OID_SZ_id_aes128_wrap,
66 { "AES-192-WRAP", ossl_der_oid_id_aes192_wrap, DER_OID_SZ_id_aes192_wrap,
68 { "AES-256-WRAP", ossl_der_oid_id_aes256_wrap, DER_OID_SZ_id_aes256_wrap,
71 { "DES3-WRAP", ossl_der_oid_id_alg_CMS3DESwrap,
72 DER_OID_SZ_id_alg_CMS3DESwrap, 24 },
76 static int find_alg_id(OSSL_LIB_CTX *libctx, const char *algname,
77 const char *propq, size_t *id)
83 cipher = EVP_CIPHER_fetch(libctx, algname, propq);
85 for (i = 0; i < OSSL_NELEM(kek_algs); i++) {
86 if (EVP_CIPHER_is_a(cipher, kek_algs[i].name)) {
93 ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_CEK_ALG);
95 EVP_CIPHER_free(cipher);
99 static int DER_w_keyinfo(WPACKET *pkt,
100 const unsigned char *der_oid, size_t der_oidlen,
101 unsigned char **pcounter)
103 return ossl_DER_w_begin_sequence(pkt, -1)
104 /* Store the initial value of 1 into the counter */
105 && ossl_DER_w_octet_string_uint32(pkt, -1, 1)
106 /* Remember where we stored the counter in the buffer */
108 || (*pcounter = WPACKET_get_curr(pkt)) != NULL)
109 && ossl_DER_w_precompiled(pkt, -1, der_oid, der_oidlen)
110 && ossl_DER_w_end_sequence(pkt, -1);
113 static int der_encode_sharedinfo(WPACKET *pkt, unsigned char *buf, size_t buflen,
114 const unsigned char *der_oid, size_t der_oidlen,
115 const unsigned char *acvp, size_t acvplen,
116 const unsigned char *partyu, size_t partyulen,
117 const unsigned char *partyv, size_t partyvlen,
118 const unsigned char *supp_pub, size_t supp_publen,
119 const unsigned char *supp_priv, size_t supp_privlen,
120 uint32_t keylen_bits, unsigned char **pcounter)
122 return (buf != NULL ? WPACKET_init_der(pkt, buf, buflen) :
123 WPACKET_init_null_der(pkt))
124 && ossl_DER_w_begin_sequence(pkt, -1)
125 && (supp_priv == NULL
126 || ossl_DER_w_octet_string(pkt, 3, supp_priv, supp_privlen))
128 || ossl_DER_w_octet_string(pkt, 2, supp_pub, supp_publen))
130 || ossl_DER_w_octet_string_uint32(pkt, 2, keylen_bits))
131 && (partyv == NULL || ossl_DER_w_octet_string(pkt, 1, partyv, partyvlen))
132 && (partyu == NULL || ossl_DER_w_octet_string(pkt, 0, partyu, partyulen))
133 && (acvp == NULL || ossl_DER_w_precompiled(pkt, -1, acvp, acvplen))
134 && DER_w_keyinfo(pkt, der_oid, der_oidlen, pcounter)
135 && ossl_DER_w_end_sequence(pkt, -1)
136 && WPACKET_finish(pkt);
140 * Encode the other info structure.
142 * The ANS X9.42-2003 standard uses OtherInfo:
144 * OtherInfo ::= SEQUENCE {
145 * keyInfo KeySpecificInfo,
146 * partyUInfo [0] OCTET STRING OPTIONAL,
147 * partyVInfo [1] OCTET STRING OPTIONAL,
148 * suppPubInfo [2] OCTET STRING OPTIONAL,
149 * suppPrivInfo [3] OCTET STRING OPTIONAL
152 * KeySpecificInfo ::= SEQUENCE {
153 * algorithm OBJECT IDENTIFIER,
154 * counter OCTET STRING SIZE (4..4)
157 * RFC2631 Section 2.1.2 Contains the following definition for OtherInfo
159 * OtherInfo ::= SEQUENCE {
160 * keyInfo KeySpecificInfo,
161 * partyAInfo [0] OCTET STRING OPTIONAL,
162 * suppPubInfo [2] OCTET STRING
164 * Where suppPubInfo is the key length (in bits) (stored into 4 bytes)
166 * |keylen| is the length (in bytes) of the generated KEK. It is stored into
167 * suppPubInfo (in bits). It is ignored if the value is 0.
168 * |cek_oid| The oid of the key wrapping algorithm.
169 * |cek_oidlen| The length (in bytes) of the key wrapping algorithm oid,
170 * |acvp| is the optional blob of DER data representing one or more of the
171 * OtherInfo fields related to |partyu|, |partyv|, |supp_pub| and |supp_priv|.
172 * This field should noramlly be NULL. If |acvp| is non NULL then |partyu|,
173 * |partyv|, |supp_pub| and |supp_priv| should all be NULL.
174 * |acvp_len| is the |acvp| length (in bytes).
175 * |partyu| is the optional public info contributed by the initiator.
176 * It can be NULL. (It is also used as the ukm by CMS).
177 * |partyu_len| is the |partyu| length (in bytes).
178 * |partyv| is the optional public info contributed by the responder.
180 * |partyv_len| is the |partyv| length (in bytes).
181 * |supp_pub| is the optional additional, mutually-known public information.
182 * It can be NULL. |keylen| should be 0 if this is not NULL.
183 * |supp_pub_len| is the |supp_pub| length (in bytes).
184 * |supp_priv| is the optional additional, mutually-known private information.
186 * |supp_priv_len| is the |supp_priv| length (in bytes).
187 * |der| is the returned encoded data. It must be freed by the caller.
188 * |der_len| is the returned size of the encoded data.
189 * |out_ctr| returns a pointer to the counter data which is embedded inside the
190 * encoded data. This allows the counter bytes to be updated without
193 * Returns: 1 if successfully encoded, or 0 otherwise.
194 * Assumptions: |der|, |der_len| & |out_ctr| are not NULL.
197 x942_encode_otherinfo(size_t keylen,
198 const unsigned char *cek_oid, size_t cek_oid_len,
199 const unsigned char *acvp, size_t acvp_len,
200 const unsigned char *partyu, size_t partyu_len,
201 const unsigned char *partyv, size_t partyv_len,
202 const unsigned char *supp_pub, size_t supp_pub_len,
203 const unsigned char *supp_priv, size_t supp_priv_len,
204 unsigned char **der, size_t *der_len,
205 unsigned char **out_ctr)
208 unsigned char *pcounter = NULL, *der_buf = NULL;
209 size_t der_buflen = 0;
211 uint32_t keylen_bits;
213 /* keylenbits must fit into 4 bytes */
214 if (keylen > 0xFFFFFF)
216 keylen_bits = 8 * keylen;
218 /* Calculate the size of the buffer */
219 if (!der_encode_sharedinfo(&pkt, NULL, 0, cek_oid, cek_oid_len,
221 partyu, partyu_len, partyv, partyv_len,
222 supp_pub, supp_pub_len, supp_priv, supp_priv_len,
224 || !WPACKET_get_total_written(&pkt, &der_buflen))
226 WPACKET_cleanup(&pkt);
227 /* Alloc the buffer */
228 der_buf = OPENSSL_zalloc(der_buflen);
231 /* Encode into the buffer */
232 if (!der_encode_sharedinfo(&pkt, der_buf, der_buflen, cek_oid, cek_oid_len,
234 partyu, partyu_len, partyv, partyv_len,
235 supp_pub, supp_pub_len, supp_priv, supp_priv_len,
236 keylen_bits, &pcounter))
239 * Since we allocated the exact size required, the buffer should point to the
240 * start of the alllocated buffer at this point.
242 if (WPACKET_get_curr(&pkt) != der_buf)
246 * The data for the DER encoded octet string of a 32 bit counter = 1
247 * should be 04 04 00 00 00 01
248 * So just check the header is correct and skip over it.
249 * This counter will be incremented in the kdf update loop.
252 || pcounter[0] != 0x04
253 || pcounter[1] != 0x04)
255 *out_ctr = (pcounter + 2);
257 *der_len = der_buflen;
260 WPACKET_cleanup(&pkt);
264 static int x942kdf_hash_kdm(const EVP_MD *kdf_md,
265 const unsigned char *z, size_t z_len,
266 const unsigned char *other, size_t other_len,
268 unsigned char *derived_key, size_t derived_key_len)
271 size_t counter, out_len, len = derived_key_len;
272 unsigned char mac[EVP_MAX_MD_SIZE];
273 unsigned char *out = derived_key;
274 EVP_MD_CTX *ctx = NULL, *ctx_init = NULL;
276 if (z_len > X942KDF_MAX_INLEN
277 || other_len > X942KDF_MAX_INLEN
278 || derived_key_len > X942KDF_MAX_INLEN
279 || derived_key_len == 0) {
280 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_LENGTH);
284 hlen = EVP_MD_size(kdf_md);
287 out_len = (size_t)hlen;
289 ctx = EVP_MD_CTX_create();
290 ctx_init = EVP_MD_CTX_create();
291 if (ctx == NULL || ctx_init == NULL)
294 if (!EVP_DigestInit(ctx_init, kdf_md))
297 for (counter = 1;; counter++) {
298 /* updating the ctr modifies 4 bytes in the 'other' buffer */
299 ctr[0] = (unsigned char)((counter >> 24) & 0xff);
300 ctr[1] = (unsigned char)((counter >> 16) & 0xff);
301 ctr[2] = (unsigned char)((counter >> 8) & 0xff);
302 ctr[3] = (unsigned char)(counter & 0xff);
304 if (!EVP_MD_CTX_copy_ex(ctx, ctx_init)
305 || !EVP_DigestUpdate(ctx, z, z_len)
306 || !EVP_DigestUpdate(ctx, other, other_len))
308 if (len >= out_len) {
309 if (!EVP_DigestFinal_ex(ctx, out, NULL))
316 if (!EVP_DigestFinal_ex(ctx, mac, NULL))
318 memcpy(out, mac, len);
324 EVP_MD_CTX_free(ctx);
325 EVP_MD_CTX_free(ctx_init);
326 OPENSSL_cleanse(mac, sizeof(mac));
330 static void *x942kdf_new(void *provctx)
334 if (!ossl_prov_is_running())
337 if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
338 ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
339 ctx->provctx = provctx;
340 ctx->use_keybits = 1;
344 static void x942kdf_reset(void *vctx)
346 KDF_X942 *ctx = (KDF_X942 *)vctx;
347 void *provctx = ctx->provctx;
349 ossl_prov_digest_reset(&ctx->digest);
350 OPENSSL_clear_free(ctx->secret, ctx->secret_len);
351 OPENSSL_clear_free(ctx->acvpinfo, ctx->acvpinfo_len);
352 OPENSSL_clear_free(ctx->partyuinfo, ctx->partyuinfo_len);
353 OPENSSL_clear_free(ctx->partyvinfo, ctx->partyvinfo_len);
354 OPENSSL_clear_free(ctx->supp_pubinfo, ctx->supp_pubinfo_len);
355 OPENSSL_clear_free(ctx->supp_privinfo, ctx->supp_privinfo_len);
356 memset(ctx, 0, sizeof(*ctx));
357 ctx->provctx = provctx;
358 ctx->use_keybits = 1;
361 static void x942kdf_free(void *vctx)
363 KDF_X942 *ctx = (KDF_X942 *)vctx;
371 static int x942kdf_set_buffer(unsigned char **out, size_t *out_len,
374 if (p->data_size == 0 || p->data == NULL)
379 return OSSL_PARAM_get_octet_string(p, (void **)out, 0, out_len);
382 static size_t x942kdf_size(KDF_X942 *ctx)
385 const EVP_MD *md = ossl_prov_digest_md(&ctx->digest);
388 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
391 len = EVP_MD_size(md);
392 return (len <= 0) ? 0 : (size_t)len;
395 static int x942kdf_derive(void *vctx, unsigned char *key, size_t keylen)
397 KDF_X942 *ctx = (KDF_X942 *)vctx;
401 unsigned char *der = NULL;
404 if (!ossl_prov_is_running())
408 * These 2 options encode to the same field so only one of them should be
411 if (ctx->use_keybits && ctx->supp_pubinfo != NULL) {
412 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_PUBINFO);
416 * If the blob of acvp data is used then the individual info fields that it
417 * replaces should not also be defined.
419 if (ctx->acvpinfo != NULL
420 && (ctx->partyuinfo != NULL
421 || ctx->partyvinfo != NULL
422 || ctx->supp_pubinfo != NULL
423 || ctx->supp_privinfo != NULL)) {
424 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
427 if (ctx->secret == NULL) {
428 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SECRET);
431 md = ossl_prov_digest_md(&ctx->digest);
433 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
436 if (ctx->cek_oid == NULL || ctx->cek_oid_len == 0) {
437 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CEK_ALG);
440 if (ctx->partyuinfo != NULL && ctx->partyuinfo_len >= X942KDF_MAX_INLEN) {
442 * Note the ukm length MUST be 512 bits if it is used.
443 * For backwards compatibility the old check is being done.
445 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_UKM_LENGTH);
448 /* generate the otherinfo der */
449 if (!x942_encode_otherinfo(ctx->use_keybits ? ctx->dkm_len : 0,
450 ctx->cek_oid, ctx->cek_oid_len,
451 ctx->acvpinfo, ctx->acvpinfo_len,
452 ctx->partyuinfo, ctx->partyuinfo_len,
453 ctx->partyvinfo, ctx->partyvinfo_len,
454 ctx->supp_pubinfo, ctx->supp_pubinfo_len,
455 ctx->supp_privinfo, ctx->supp_privinfo_len,
456 &der, &der_len, &ctr)) {
457 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_ENCODING);
460 ret = x942kdf_hash_kdm(md, ctx->secret, ctx->secret_len,
461 der, der_len, ctr, key, keylen);
466 static int x942kdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
468 const OSSL_PARAM *p, *pq;
469 KDF_X942 *ctx = vctx;
470 OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
471 const char *propq = NULL;
474 if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
477 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SECRET);
479 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY);
480 if (p != NULL && !x942kdf_set_buffer(&ctx->secret, &ctx->secret_len, p))
483 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_ACVPINFO);
485 && !x942kdf_set_buffer(&ctx->acvpinfo, &ctx->acvpinfo_len, p))
488 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_PARTYUINFO);
490 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_UKM);
492 && !x942kdf_set_buffer(&ctx->partyuinfo, &ctx->partyuinfo_len, p))
495 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_PARTYVINFO);
497 && !x942kdf_set_buffer(&ctx->partyvinfo, &ctx->partyvinfo_len, p))
500 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_USE_KEYBITS);
501 if (p != NULL && !OSSL_PARAM_get_int(p, &ctx->use_keybits))
504 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_SUPP_PUBINFO);
506 if (!x942kdf_set_buffer(&ctx->supp_pubinfo, &ctx->supp_pubinfo_len, p))
508 ctx->use_keybits = 0;
511 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_SUPP_PRIVINFO);
513 && !x942kdf_set_buffer(&ctx->supp_privinfo, &ctx->supp_privinfo_len, p))
516 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_CEK_ALG);
518 if (p->data_type != OSSL_PARAM_UTF8_STRING)
520 pq = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_PROPERTIES);
522 * We already grab the properties during ossl_prov_digest_load_from_params()
523 * so there is no need to check the validity again..
527 if (find_alg_id(provctx, p->data, propq, &id) == 0)
529 ctx->cek_oid = kek_algs[id].oid;
530 ctx->cek_oid_len = kek_algs[id].oid_len;
531 ctx->dkm_len = kek_algs[id].keklen;
536 static const OSSL_PARAM *x942kdf_settable_ctx_params(ossl_unused void *provctx)
538 static const OSSL_PARAM known_settable_ctx_params[] = {
539 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
540 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
541 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SECRET, NULL, 0),
542 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
543 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_UKM, NULL, 0),
544 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_ACVPINFO, NULL, 0),
545 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_PARTYUINFO, NULL, 0),
546 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_PARTYVINFO, NULL, 0),
547 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_SUPP_PUBINFO, NULL, 0),
548 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_SUPP_PRIVINFO, NULL, 0),
549 OSSL_PARAM_int(OSSL_KDF_PARAM_X942_USE_KEYBITS, NULL),
550 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_CEK_ALG, NULL, 0),
553 return known_settable_ctx_params;
556 static int x942kdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
558 KDF_X942 *ctx = (KDF_X942 *)vctx;
561 if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
562 return OSSL_PARAM_set_size_t(p, x942kdf_size(ctx));
566 static const OSSL_PARAM *x942kdf_gettable_ctx_params(ossl_unused void *provctx)
568 static const OSSL_PARAM known_gettable_ctx_params[] = {
569 OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
572 return known_gettable_ctx_params;
575 const OSSL_DISPATCH ossl_kdf_x942_kdf_functions[] = {
576 { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))x942kdf_new },
577 { OSSL_FUNC_KDF_FREECTX, (void(*)(void))x942kdf_free },
578 { OSSL_FUNC_KDF_RESET, (void(*)(void))x942kdf_reset },
579 { OSSL_FUNC_KDF_DERIVE, (void(*)(void))x942kdf_derive },
580 { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
581 (void(*)(void))x942kdf_settable_ctx_params },
582 { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))x942kdf_set_ctx_params },
583 { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
584 (void(*)(void))x942kdf_gettable_ctx_params },
585 { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))x942kdf_get_ctx_params },