2 * Copyright 2019-2022 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
11 #include "internal/e_os.h"
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 "internal/nelem.h"
21 #include "prov/provider_ctx.h"
22 #include "prov/providercommon.h"
23 #include "prov/implementations.h"
24 #include "prov/provider_util.h"
25 #include "prov/der_wrap.h"
27 #define X942KDF_MAX_INLEN (1 << 30)
29 static OSSL_FUNC_kdf_newctx_fn x942kdf_new;
30 static OSSL_FUNC_kdf_dupctx_fn x942kdf_dup;
31 static OSSL_FUNC_kdf_freectx_fn x942kdf_free;
32 static OSSL_FUNC_kdf_reset_fn x942kdf_reset;
33 static OSSL_FUNC_kdf_derive_fn x942kdf_derive;
34 static OSSL_FUNC_kdf_settable_ctx_params_fn x942kdf_settable_ctx_params;
35 static OSSL_FUNC_kdf_set_ctx_params_fn x942kdf_set_ctx_params;
36 static OSSL_FUNC_kdf_gettable_ctx_params_fn x942kdf_gettable_ctx_params;
37 static OSSL_FUNC_kdf_get_ctx_params_fn x942kdf_get_ctx_params;
42 unsigned char *secret;
44 unsigned char *acvpinfo;
46 unsigned char *partyuinfo, *partyvinfo, *supp_pubinfo, *supp_privinfo;
47 size_t partyuinfo_len, partyvinfo_len, supp_pubinfo_len, supp_privinfo_len;
49 const unsigned char *cek_oid;
55 * A table of allowed wrapping algorithms, oids and the associated output
57 * NOTE: RC2wrap and camellia128_wrap have been removed as there are no
58 * corresponding ciphers for these operations.
62 const unsigned char *oid;
64 size_t keklen; /* size in bytes */
66 { "AES-128-WRAP", ossl_der_oid_id_aes128_wrap, DER_OID_SZ_id_aes128_wrap,
68 { "AES-192-WRAP", ossl_der_oid_id_aes192_wrap, DER_OID_SZ_id_aes192_wrap,
70 { "AES-256-WRAP", ossl_der_oid_id_aes256_wrap, DER_OID_SZ_id_aes256_wrap,
73 { "DES3-WRAP", ossl_der_oid_id_alg_CMS3DESwrap,
74 DER_OID_SZ_id_alg_CMS3DESwrap, 24 },
78 static int find_alg_id(OSSL_LIB_CTX *libctx, const char *algname,
79 const char *propq, size_t *id)
85 cipher = EVP_CIPHER_fetch(libctx, algname, propq);
87 for (i = 0; i < OSSL_NELEM(kek_algs); i++) {
88 if (EVP_CIPHER_is_a(cipher, kek_algs[i].name)) {
95 ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_CEK_ALG);
97 EVP_CIPHER_free(cipher);
101 static int DER_w_keyinfo(WPACKET *pkt,
102 const unsigned char *der_oid, size_t der_oidlen,
103 unsigned char **pcounter)
105 return ossl_DER_w_begin_sequence(pkt, -1)
106 /* Store the initial value of 1 into the counter */
107 && ossl_DER_w_octet_string_uint32(pkt, -1, 1)
108 /* Remember where we stored the counter in the buffer */
110 || (*pcounter = WPACKET_get_curr(pkt)) != NULL)
111 && ossl_DER_w_precompiled(pkt, -1, der_oid, der_oidlen)
112 && ossl_DER_w_end_sequence(pkt, -1);
115 static int der_encode_sharedinfo(WPACKET *pkt, unsigned char *buf, size_t buflen,
116 const unsigned char *der_oid, size_t der_oidlen,
117 const unsigned char *acvp, size_t acvplen,
118 const unsigned char *partyu, size_t partyulen,
119 const unsigned char *partyv, size_t partyvlen,
120 const unsigned char *supp_pub, size_t supp_publen,
121 const unsigned char *supp_priv, size_t supp_privlen,
122 uint32_t keylen_bits, unsigned char **pcounter)
124 return (buf != NULL ? WPACKET_init_der(pkt, buf, buflen) :
125 WPACKET_init_null_der(pkt))
126 && ossl_DER_w_begin_sequence(pkt, -1)
127 && (supp_priv == NULL
128 || ossl_DER_w_octet_string(pkt, 3, supp_priv, supp_privlen))
130 || ossl_DER_w_octet_string(pkt, 2, supp_pub, supp_publen))
132 || ossl_DER_w_octet_string_uint32(pkt, 2, keylen_bits))
133 && (partyv == NULL || ossl_DER_w_octet_string(pkt, 1, partyv, partyvlen))
134 && (partyu == NULL || ossl_DER_w_octet_string(pkt, 0, partyu, partyulen))
135 && (acvp == NULL || ossl_DER_w_precompiled(pkt, -1, acvp, acvplen))
136 && DER_w_keyinfo(pkt, der_oid, der_oidlen, pcounter)
137 && ossl_DER_w_end_sequence(pkt, -1)
138 && WPACKET_finish(pkt);
142 * Encode the other info structure.
144 * The ANS X9.42-2003 standard uses OtherInfo:
146 * OtherInfo ::= SEQUENCE {
147 * keyInfo KeySpecificInfo,
148 * partyUInfo [0] OCTET STRING OPTIONAL,
149 * partyVInfo [1] OCTET STRING OPTIONAL,
150 * suppPubInfo [2] OCTET STRING OPTIONAL,
151 * suppPrivInfo [3] OCTET STRING OPTIONAL
154 * KeySpecificInfo ::= SEQUENCE {
155 * algorithm OBJECT IDENTIFIER,
156 * counter OCTET STRING SIZE (4..4)
159 * RFC2631 Section 2.1.2 Contains the following definition for OtherInfo
161 * OtherInfo ::= SEQUENCE {
162 * keyInfo KeySpecificInfo,
163 * partyAInfo [0] OCTET STRING OPTIONAL,
164 * suppPubInfo [2] OCTET STRING
166 * Where suppPubInfo is the key length (in bits) (stored into 4 bytes)
168 * |keylen| is the length (in bytes) of the generated KEK. It is stored into
169 * suppPubInfo (in bits). It is ignored if the value is 0.
170 * |cek_oid| The oid of the key wrapping algorithm.
171 * |cek_oidlen| The length (in bytes) of the key wrapping algorithm oid,
172 * |acvp| is the optional blob of DER data representing one or more of the
173 * OtherInfo fields related to |partyu|, |partyv|, |supp_pub| and |supp_priv|.
174 * This field should normally be NULL. If |acvp| is non NULL then |partyu|,
175 * |partyv|, |supp_pub| and |supp_priv| should all be NULL.
176 * |acvp_len| is the |acvp| length (in bytes).
177 * |partyu| is the optional public info contributed by the initiator.
178 * It can be NULL. (It is also used as the ukm by CMS).
179 * |partyu_len| is the |partyu| length (in bytes).
180 * |partyv| is the optional public info contributed by the responder.
182 * |partyv_len| is the |partyv| length (in bytes).
183 * |supp_pub| is the optional additional, mutually-known public information.
184 * It can be NULL. |keylen| should be 0 if this is not NULL.
185 * |supp_pub_len| is the |supp_pub| length (in bytes).
186 * |supp_priv| is the optional additional, mutually-known private information.
188 * |supp_priv_len| is the |supp_priv| length (in bytes).
189 * |der| is the returned encoded data. It must be freed by the caller.
190 * |der_len| is the returned size of the encoded data.
191 * |out_ctr| returns a pointer to the counter data which is embedded inside the
192 * encoded data. This allows the counter bytes to be updated without
195 * Returns: 1 if successfully encoded, or 0 otherwise.
196 * Assumptions: |der|, |der_len| & |out_ctr| are not NULL.
199 x942_encode_otherinfo(size_t keylen,
200 const unsigned char *cek_oid, size_t cek_oid_len,
201 const unsigned char *acvp, size_t acvp_len,
202 const unsigned char *partyu, size_t partyu_len,
203 const unsigned char *partyv, size_t partyv_len,
204 const unsigned char *supp_pub, size_t supp_pub_len,
205 const unsigned char *supp_priv, size_t supp_priv_len,
206 unsigned char **der, size_t *der_len,
207 unsigned char **out_ctr)
210 unsigned char *pcounter = NULL, *der_buf = NULL;
211 size_t der_buflen = 0;
213 uint32_t keylen_bits;
215 /* keylenbits must fit into 4 bytes */
216 if (keylen > 0xFFFFFF)
218 keylen_bits = 8 * keylen;
220 /* Calculate the size of the buffer */
221 if (!der_encode_sharedinfo(&pkt, NULL, 0, cek_oid, cek_oid_len,
223 partyu, partyu_len, partyv, partyv_len,
224 supp_pub, supp_pub_len, supp_priv, supp_priv_len,
226 || !WPACKET_get_total_written(&pkt, &der_buflen))
228 WPACKET_cleanup(&pkt);
229 /* Alloc the buffer */
230 der_buf = OPENSSL_zalloc(der_buflen);
233 /* Encode into the buffer */
234 if (!der_encode_sharedinfo(&pkt, der_buf, der_buflen, cek_oid, cek_oid_len,
236 partyu, partyu_len, partyv, partyv_len,
237 supp_pub, supp_pub_len, supp_priv, supp_priv_len,
238 keylen_bits, &pcounter))
241 * Since we allocated the exact size required, the buffer should point to the
242 * start of the alllocated buffer at this point.
244 if (WPACKET_get_curr(&pkt) != der_buf)
248 * The data for the DER encoded octet string of a 32 bit counter = 1
249 * should be 04 04 00 00 00 01
250 * So just check the header is correct and skip over it.
251 * This counter will be incremented in the kdf update loop.
254 || pcounter[0] != 0x04
255 || pcounter[1] != 0x04)
257 *out_ctr = (pcounter + 2);
259 *der_len = der_buflen;
262 WPACKET_cleanup(&pkt);
266 static int x942kdf_hash_kdm(const EVP_MD *kdf_md,
267 const unsigned char *z, size_t z_len,
268 const unsigned char *other, size_t other_len,
270 unsigned char *derived_key, size_t derived_key_len)
273 size_t counter, out_len, len = derived_key_len;
274 unsigned char mac[EVP_MAX_MD_SIZE];
275 unsigned char *out = derived_key;
276 EVP_MD_CTX *ctx = NULL, *ctx_init = NULL;
278 if (z_len > X942KDF_MAX_INLEN
279 || other_len > X942KDF_MAX_INLEN
280 || derived_key_len > X942KDF_MAX_INLEN
281 || derived_key_len == 0) {
282 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_LENGTH);
286 hlen = EVP_MD_get_size(kdf_md);
289 out_len = (size_t)hlen;
291 ctx = EVP_MD_CTX_create();
292 ctx_init = EVP_MD_CTX_create();
293 if (ctx == NULL || ctx_init == NULL)
296 if (!EVP_DigestInit(ctx_init, kdf_md))
299 for (counter = 1;; counter++) {
300 /* updating the ctr modifies 4 bytes in the 'other' buffer */
301 ctr[0] = (unsigned char)((counter >> 24) & 0xff);
302 ctr[1] = (unsigned char)((counter >> 16) & 0xff);
303 ctr[2] = (unsigned char)((counter >> 8) & 0xff);
304 ctr[3] = (unsigned char)(counter & 0xff);
306 if (!EVP_MD_CTX_copy_ex(ctx, ctx_init)
307 || !EVP_DigestUpdate(ctx, z, z_len)
308 || !EVP_DigestUpdate(ctx, other, other_len))
310 if (len >= out_len) {
311 if (!EVP_DigestFinal_ex(ctx, out, NULL))
318 if (!EVP_DigestFinal_ex(ctx, mac, NULL))
320 memcpy(out, mac, len);
326 EVP_MD_CTX_free(ctx);
327 EVP_MD_CTX_free(ctx_init);
328 OPENSSL_cleanse(mac, sizeof(mac));
332 static void *x942kdf_new(void *provctx)
336 if (!ossl_prov_is_running())
339 if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) == NULL)
341 ctx->provctx = provctx;
342 ctx->use_keybits = 1;
346 static void x942kdf_reset(void *vctx)
348 KDF_X942 *ctx = (KDF_X942 *)vctx;
349 void *provctx = ctx->provctx;
351 ossl_prov_digest_reset(&ctx->digest);
352 OPENSSL_clear_free(ctx->secret, ctx->secret_len);
353 OPENSSL_clear_free(ctx->acvpinfo, ctx->acvpinfo_len);
354 OPENSSL_clear_free(ctx->partyuinfo, ctx->partyuinfo_len);
355 OPENSSL_clear_free(ctx->partyvinfo, ctx->partyvinfo_len);
356 OPENSSL_clear_free(ctx->supp_pubinfo, ctx->supp_pubinfo_len);
357 OPENSSL_clear_free(ctx->supp_privinfo, ctx->supp_privinfo_len);
358 memset(ctx, 0, sizeof(*ctx));
359 ctx->provctx = provctx;
360 ctx->use_keybits = 1;
363 static void x942kdf_free(void *vctx)
365 KDF_X942 *ctx = (KDF_X942 *)vctx;
373 static void *x942kdf_dup(void *vctx)
375 const KDF_X942 *src = (const KDF_X942 *)vctx;
378 dest = x942kdf_new(src->provctx);
380 if (!ossl_prov_memdup(src->secret, src->secret_len,
381 &dest->secret , &dest->secret_len)
382 || !ossl_prov_memdup(src->acvpinfo, src->acvpinfo_len,
383 &dest->acvpinfo , &dest->acvpinfo_len)
384 || !ossl_prov_memdup(src->partyuinfo, src->partyuinfo_len,
385 &dest->partyuinfo , &dest->partyuinfo_len)
386 || !ossl_prov_memdup(src->partyvinfo, src->partyvinfo_len,
387 &dest->partyvinfo , &dest->partyvinfo_len)
388 || !ossl_prov_memdup(src->supp_pubinfo, src->supp_pubinfo_len,
390 &dest->supp_pubinfo_len)
391 || !ossl_prov_memdup(src->supp_privinfo, src->supp_privinfo_len,
392 &dest->supp_privinfo,
393 &dest->supp_privinfo_len)
394 || !ossl_prov_digest_copy(&dest->digest, &src->digest))
396 dest->cek_oid = src->cek_oid;
397 dest->cek_oid_len = src->cek_oid_len;
398 dest->dkm_len = src->dkm_len;
399 dest->use_keybits = src->use_keybits;
408 static int x942kdf_set_buffer(unsigned char **out, size_t *out_len,
411 if (p->data_size == 0 || p->data == NULL)
416 return OSSL_PARAM_get_octet_string(p, (void **)out, 0, out_len);
419 static size_t x942kdf_size(KDF_X942 *ctx)
422 const EVP_MD *md = ossl_prov_digest_md(&ctx->digest);
425 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
428 len = EVP_MD_get_size(md);
429 return (len <= 0) ? 0 : (size_t)len;
432 static int x942kdf_derive(void *vctx, unsigned char *key, size_t keylen,
433 const OSSL_PARAM params[])
435 KDF_X942 *ctx = (KDF_X942 *)vctx;
439 unsigned char *der = NULL;
442 if (!ossl_prov_is_running() || !x942kdf_set_ctx_params(ctx, params))
446 * These 2 options encode to the same field so only one of them should be
449 if (ctx->use_keybits && ctx->supp_pubinfo != NULL) {
450 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_PUBINFO);
454 * If the blob of acvp data is used then the individual info fields that it
455 * replaces should not also be defined.
457 if (ctx->acvpinfo != NULL
458 && (ctx->partyuinfo != NULL
459 || ctx->partyvinfo != NULL
460 || ctx->supp_pubinfo != NULL
461 || ctx->supp_privinfo != NULL)) {
462 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
465 if (ctx->secret == NULL) {
466 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_SECRET);
469 md = ossl_prov_digest_md(&ctx->digest);
471 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
474 if (ctx->cek_oid == NULL || ctx->cek_oid_len == 0) {
475 ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_CEK_ALG);
478 if (ctx->partyuinfo != NULL && ctx->partyuinfo_len >= X942KDF_MAX_INLEN) {
480 * Note the ukm length MUST be 512 bits if it is used.
481 * For backwards compatibility the old check is being done.
483 ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_UKM_LENGTH);
486 /* generate the otherinfo der */
487 if (!x942_encode_otherinfo(ctx->use_keybits ? ctx->dkm_len : 0,
488 ctx->cek_oid, ctx->cek_oid_len,
489 ctx->acvpinfo, ctx->acvpinfo_len,
490 ctx->partyuinfo, ctx->partyuinfo_len,
491 ctx->partyvinfo, ctx->partyvinfo_len,
492 ctx->supp_pubinfo, ctx->supp_pubinfo_len,
493 ctx->supp_privinfo, ctx->supp_privinfo_len,
494 &der, &der_len, &ctr)) {
495 ERR_raise(ERR_LIB_PROV, PROV_R_BAD_ENCODING);
498 ret = x942kdf_hash_kdm(md, ctx->secret, ctx->secret_len,
499 der, der_len, ctr, key, keylen);
504 static int x942kdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
506 const OSSL_PARAM *p, *pq;
507 KDF_X942 *ctx = vctx;
508 OSSL_LIB_CTX *provctx = PROV_LIBCTX_OF(ctx->provctx);
509 const char *propq = NULL;
514 if (!ossl_prov_digest_load_from_params(&ctx->digest, params, provctx))
517 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SECRET);
519 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY);
520 if (p != NULL && !x942kdf_set_buffer(&ctx->secret, &ctx->secret_len, p))
523 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_ACVPINFO);
525 && !x942kdf_set_buffer(&ctx->acvpinfo, &ctx->acvpinfo_len, p))
528 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_PARTYUINFO);
530 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_UKM);
532 && !x942kdf_set_buffer(&ctx->partyuinfo, &ctx->partyuinfo_len, p))
535 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_PARTYVINFO);
537 && !x942kdf_set_buffer(&ctx->partyvinfo, &ctx->partyvinfo_len, p))
540 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_USE_KEYBITS);
541 if (p != NULL && !OSSL_PARAM_get_int(p, &ctx->use_keybits))
544 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_SUPP_PUBINFO);
546 if (!x942kdf_set_buffer(&ctx->supp_pubinfo, &ctx->supp_pubinfo_len, p))
548 ctx->use_keybits = 0;
551 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_X942_SUPP_PRIVINFO);
553 && !x942kdf_set_buffer(&ctx->supp_privinfo, &ctx->supp_privinfo_len, p))
556 p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_CEK_ALG);
558 if (p->data_type != OSSL_PARAM_UTF8_STRING)
560 pq = OSSL_PARAM_locate_const(params, OSSL_ALG_PARAM_PROPERTIES);
562 * We already grab the properties during ossl_prov_digest_load_from_params()
563 * so there is no need to check the validity again..
567 if (find_alg_id(provctx, p->data, propq, &id) == 0)
569 ctx->cek_oid = kek_algs[id].oid;
570 ctx->cek_oid_len = kek_algs[id].oid_len;
571 ctx->dkm_len = kek_algs[id].keklen;
576 static const OSSL_PARAM *x942kdf_settable_ctx_params(ossl_unused void *ctx,
577 ossl_unused void *provctx)
579 static const OSSL_PARAM known_settable_ctx_params[] = {
580 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0),
581 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0),
582 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SECRET, NULL, 0),
583 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0),
584 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_UKM, NULL, 0),
585 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_ACVPINFO, NULL, 0),
586 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_PARTYUINFO, NULL, 0),
587 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_PARTYVINFO, NULL, 0),
588 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_SUPP_PUBINFO, NULL, 0),
589 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_X942_SUPP_PRIVINFO, NULL, 0),
590 OSSL_PARAM_int(OSSL_KDF_PARAM_X942_USE_KEYBITS, NULL),
591 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_CEK_ALG, NULL, 0),
594 return known_settable_ctx_params;
597 static int x942kdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
599 KDF_X942 *ctx = (KDF_X942 *)vctx;
602 if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL)
603 return OSSL_PARAM_set_size_t(p, x942kdf_size(ctx));
607 static const OSSL_PARAM *x942kdf_gettable_ctx_params(ossl_unused void *ctx,
608 ossl_unused void *provctx)
610 static const OSSL_PARAM known_gettable_ctx_params[] = {
611 OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
614 return known_gettable_ctx_params;
617 const OSSL_DISPATCH ossl_kdf_x942_kdf_functions[] = {
618 { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))x942kdf_new },
619 { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))x942kdf_dup },
620 { OSSL_FUNC_KDF_FREECTX, (void(*)(void))x942kdf_free },
621 { OSSL_FUNC_KDF_RESET, (void(*)(void))x942kdf_reset },
622 { OSSL_FUNC_KDF_DERIVE, (void(*)(void))x942kdf_derive },
623 { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
624 (void(*)(void))x942kdf_settable_ctx_params },
625 { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))x942kdf_set_ctx_params },
626 { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
627 (void(*)(void))x942kdf_gettable_ctx_params },
628 { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))x942kdf_get_ctx_params },