2 * Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright 2019 Red Hat, Inc.
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 * This implements https://csrc.nist.gov/publications/detail/sp/800-108/final
13 * section 5.1 ("counter mode") and section 5.2 ("feedback mode") in both HMAC
14 * and CMAC. That document does not name the KDFs it defines; the name is
16 * https://csrc.nist.gov/Projects/Cryptographic-Algorithm-Validation-Program/Key-Derivation
18 * Note that section 5.3 ("double-pipeline mode") is not implemented, though
19 * it would be possible to do so in the future.
21 * These versions all assume the counter is used. It would be relatively
22 * straightforward to expose a configuration handle should the need arise.
24 * Variable names attempt to match those of SP800-108.
31 #include <openssl/core_names.h>
32 #include <openssl/evp.h>
33 #include <openssl/hmac.h>
34 #include <openssl/kdf.h>
35 #include <openssl/params.h>
37 #include "internal/cryptlib.h"
38 #include "crypto/evp.h"
39 #include "internal/numbers.h"
40 #include "prov/implementations.h"
41 #include "prov/provider_ctx.h"
42 #include "prov/provider_util.h"
43 #include "prov/providercommonerr.h"
47 #define MIN(a, b) ((a) < (b)) ? (a) : (b)
54 /* Our context structure. */
58 EVP_MAC_CTX
*ctx_init
;
60 /* Names are lowercased versions of those found in SP800-108. */
65 unsigned char *context
;
71 /* Definitions needed for typechecking. */
72 static OSSL_FUNC_kdf_newctx_fn kbkdf_new
;
73 static OSSL_FUNC_kdf_freectx_fn kbkdf_free
;
74 static OSSL_FUNC_kdf_reset_fn kbkdf_reset
;
75 static OSSL_FUNC_kdf_derive_fn kbkdf_derive
;
76 static OSSL_FUNC_kdf_settable_ctx_params_fn kbkdf_settable_ctx_params
;
77 static OSSL_FUNC_kdf_set_ctx_params_fn kbkdf_set_ctx_params
;
79 /* Not all platforms have htobe32(). */
80 static uint32_t be32(uint32_t host
)
88 if (!is_endian
.little
)
91 big
|= (host
& 0xff000000) >> 24;
92 big
|= (host
& 0x00ff0000) >> 8;
93 big
|= (host
& 0x0000ff00) << 8;
94 big
|= (host
& 0x000000ff) << 24;
98 static void *kbkdf_new(void *provctx
)
102 ctx
= OPENSSL_zalloc(sizeof(*ctx
));
104 ERR_raise(ERR_LIB_PROV
, ERR_R_MALLOC_FAILURE
);
108 ctx
->provctx
= provctx
;
112 static void kbkdf_free(void *vctx
)
114 KBKDF
*ctx
= (KBKDF
*)vctx
;
122 static void kbkdf_reset(void *vctx
)
124 KBKDF
*ctx
= (KBKDF
*)vctx
;
126 EVP_MAC_free_ctx(ctx
->ctx_init
);
127 OPENSSL_clear_free(ctx
->context
, ctx
->context_len
);
128 OPENSSL_clear_free(ctx
->label
, ctx
->label_len
);
129 OPENSSL_clear_free(ctx
->ki
, ctx
->ki_len
);
130 OPENSSL_clear_free(ctx
->iv
, ctx
->iv_len
);
131 memset(ctx
, 0, sizeof(*ctx
));
134 /* SP800-108 section 5.1 or section 5.2 depending on mode. */
135 static int derive(EVP_MAC_CTX
*ctx_init
, kbkdf_mode mode
, unsigned char *iv
,
136 size_t iv_len
, unsigned char *label
, size_t label_len
,
137 unsigned char *context
, size_t context_len
,
138 unsigned char *k_i
, size_t h
, uint32_t l
, unsigned char *ko
,
142 EVP_MAC_CTX
*ctx
= NULL
;
143 size_t written
= 0, to_write
, k_i_len
= iv_len
;
144 const unsigned char zero
= 0;
147 /* Setup K(0) for feedback mode. */
149 memcpy(k_i
, iv
, iv_len
);
151 for (counter
= 1; written
< ko_len
; counter
++) {
154 ctx
= EVP_MAC_dup_ctx(ctx_init
);
158 /* Perform feedback, if appropriate. */
159 if (mode
== FEEDBACK
&& !EVP_MAC_update(ctx
, k_i
, k_i_len
))
162 if (!EVP_MAC_update(ctx
, (unsigned char *)&i
, 4)
163 || !EVP_MAC_update(ctx
, label
, label_len
)
164 || !EVP_MAC_update(ctx
, &zero
, 1)
165 || !EVP_MAC_update(ctx
, context
, context_len
)
166 || !EVP_MAC_update(ctx
, (unsigned char *)&l
, 4)
167 || !EVP_MAC_final(ctx
, k_i
, NULL
, h
))
170 to_write
= ko_len
- written
;
171 memcpy(ko
+ written
, k_i
, MIN(to_write
, h
));
175 EVP_MAC_free_ctx(ctx
);
181 EVP_MAC_free_ctx(ctx
);
185 static int kbkdf_derive(void *vctx
, unsigned char *key
, size_t keylen
)
187 KBKDF
*ctx
= (KBKDF
*)vctx
;
189 unsigned char *k_i
= NULL
;
190 uint32_t l
= be32(keylen
* 8);
193 /* label, context, and iv are permitted to be empty. Check everything
195 if (ctx
->ctx_init
== NULL
) {
196 if (ctx
->ki_len
== 0 || ctx
->ki
== NULL
) {
197 ERR_raise(ERR_LIB_PROV
, PROV_R_NO_KEY_SET
);
200 /* Could either be missing MAC or missing message digest or missing
201 * cipher - arbitrarily, I pick this one. */
202 ERR_raise(ERR_LIB_PROV
, PROV_R_MISSING_MAC
);
206 h
= EVP_MAC_size(ctx
->ctx_init
);
209 if (ctx
->iv_len
!= 0 && ctx
->iv_len
!= h
) {
210 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_SEED_LENGTH
);
214 k_i
= OPENSSL_zalloc(h
);
218 ret
= derive(ctx
->ctx_init
, ctx
->mode
, ctx
->iv
, ctx
->iv_len
, ctx
->label
,
219 ctx
->label_len
, ctx
->context
, ctx
->context_len
, k_i
, h
, l
,
223 OPENSSL_cleanse(key
, keylen
);
224 OPENSSL_clear_free(k_i
, h
);
228 static int kbkdf_set_buffer(unsigned char **out
, size_t *out_len
,
231 if (p
->data
== NULL
|| p
->data_size
== 0)
234 OPENSSL_clear_free(*out
, *out_len
);
236 return OSSL_PARAM_get_octet_string(p
, (void **)out
, 0, out_len
);
239 static int kbkdf_set_ctx_params(void *vctx
, const OSSL_PARAM params
[])
241 KBKDF
*ctx
= (KBKDF
*)vctx
;
242 OPENSSL_CTX
*libctx
= PROV_LIBRARY_CONTEXT_OF(ctx
->provctx
);
244 OSSL_PARAM mparams
[2];
246 if (!ossl_prov_macctx_load_from_params(&ctx
->ctx_init
, params
, NULL
,
249 else if (ctx
->ctx_init
!= NULL
250 && !EVP_MAC_is_a(EVP_MAC_get_ctx_mac(ctx
->ctx_init
),
252 && !EVP_MAC_is_a(EVP_MAC_get_ctx_mac(ctx
->ctx_init
),
253 OSSL_MAC_NAME_CMAC
)) {
254 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_MAC
);
258 p
= OSSL_PARAM_locate_const(params
, OSSL_KDF_PARAM_MODE
);
259 if (p
!= NULL
&& strncasecmp("counter", p
->data
, p
->data_size
) == 0) {
262 && strncasecmp("feedback", p
->data
, p
->data_size
) == 0) {
263 ctx
->mode
= FEEDBACK
;
264 } else if (p
!= NULL
) {
265 ERR_raise(ERR_LIB_PROV
, PROV_R_INVALID_MODE
);
269 p
= OSSL_PARAM_locate_const(params
, OSSL_KDF_PARAM_KEY
);
270 if (p
!= NULL
&& !kbkdf_set_buffer(&ctx
->ki
, &ctx
->ki_len
, p
))
273 p
= OSSL_PARAM_locate_const(params
, OSSL_KDF_PARAM_SALT
);
274 if (p
!= NULL
&& !kbkdf_set_buffer(&ctx
->label
, &ctx
->label_len
, p
))
277 p
= OSSL_PARAM_locate_const(params
, OSSL_KDF_PARAM_INFO
);
278 if (p
!= NULL
&& !kbkdf_set_buffer(&ctx
->context
, &ctx
->context_len
, p
))
281 p
= OSSL_PARAM_locate_const(params
, OSSL_KDF_PARAM_SEED
);
282 if (p
!= NULL
&& !kbkdf_set_buffer(&ctx
->iv
, &ctx
->iv_len
, p
))
285 /* Set up digest context, if we can. */
286 if (ctx
->ctx_init
!= NULL
&& ctx
->ki_len
!= 0) {
287 mparams
[0] = OSSL_PARAM_construct_octet_string(OSSL_MAC_PARAM_KEY
,
288 ctx
->ki
, ctx
->ki_len
);
289 mparams
[1] = OSSL_PARAM_construct_end();
291 if (!EVP_MAC_set_ctx_params(ctx
->ctx_init
, mparams
)
292 || !EVP_MAC_init(ctx
->ctx_init
))
299 static const OSSL_PARAM
*kbkdf_settable_ctx_params(void)
301 static const OSSL_PARAM known_settable_ctx_params
[] = {
302 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO
, NULL
, 0),
303 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT
, NULL
, 0),
304 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY
, NULL
, 0),
305 OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SEED
, NULL
, 0),
306 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST
, NULL
, 0),
307 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_CIPHER
, NULL
, 0),
308 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MAC
, NULL
, 0),
309 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE
, NULL
, 0),
311 OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES
, NULL
, 0),
314 return known_settable_ctx_params
;
317 static int kbkdf_get_ctx_params(void *vctx
, OSSL_PARAM params
[])
321 p
= OSSL_PARAM_locate(params
, OSSL_KDF_PARAM_SIZE
);
325 /* KBKDF can produce results as large as you like. */
326 return OSSL_PARAM_set_size_t(p
, SIZE_MAX
);
329 static const OSSL_PARAM
*kbkdf_gettable_ctx_params(void)
331 static const OSSL_PARAM known_gettable_ctx_params
[] =
332 { OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE
, NULL
), OSSL_PARAM_END
};
333 return known_gettable_ctx_params
;
336 const OSSL_DISPATCH kdf_kbkdf_functions
[] = {
337 { OSSL_FUNC_KDF_NEWCTX
, (void(*)(void))kbkdf_new
},
338 { OSSL_FUNC_KDF_FREECTX
, (void(*)(void))kbkdf_free
},
339 { OSSL_FUNC_KDF_RESET
, (void(*)(void))kbkdf_reset
},
340 { OSSL_FUNC_KDF_DERIVE
, (void(*)(void))kbkdf_derive
},
341 { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS
,
342 (void(*)(void))kbkdf_settable_ctx_params
},
343 { OSSL_FUNC_KDF_SET_CTX_PARAMS
, (void(*)(void))kbkdf_set_ctx_params
},
344 { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS
,
345 (void(*)(void))kbkdf_gettable_ctx_params
},
346 { OSSL_FUNC_KDF_GET_CTX_PARAMS
, (void(*)(void))kbkdf_get_ctx_params
},