2 * Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
3 * Copyright (c) 2018, 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/evp.h>
13 #include <openssl/err.h>
14 #include <openssl/buffer.h>
15 #include <openssl/kdf.h>
16 #include <openssl/core.h>
17 #include <openssl/core_names.h>
18 #include <openssl/params.h>
19 #include "internal/numbers.h"
20 #include "internal/evp_int.h"
27 * EVP_PKEY implementations collect bits of certain data
29 BUF_MEM *collected_seed;
30 BUF_MEM *collected_info;
33 static void pkey_kdf_free_collected(EVP_PKEY_KDF_CTX *pkctx)
35 BUF_MEM_free(pkctx->collected_seed);
36 pkctx->collected_seed = NULL;
37 BUF_MEM_free(pkctx->collected_info);
38 pkctx->collected_info = NULL;
41 static int pkey_kdf_init(EVP_PKEY_CTX *ctx)
43 EVP_PKEY_KDF_CTX *pkctx;
45 const char *kdf_name = OBJ_nid2sn(ctx->pmeth->pkey_id);
48 pkctx = OPENSSL_zalloc(sizeof(*pkctx));
52 kdf = EVP_KDF_fetch(NULL, kdf_name, NULL);
53 kctx = EVP_KDF_CTX_new(kdf);
65 static void pkey_kdf_cleanup(EVP_PKEY_CTX *ctx)
67 EVP_PKEY_KDF_CTX *pkctx = ctx->data;
69 EVP_KDF_CTX_free(pkctx->kctx);
70 pkey_kdf_free_collected(pkctx);
74 static int collect(BUF_MEM **collector, void *data, size_t datalen)
78 if (*collector == NULL)
79 *collector = BUF_MEM_new();
80 if (*collector == NULL) {
81 ERR_raise(ERR_LIB_EVP, ERR_R_MALLOC_FAILURE);
85 i = (*collector)->length; /* BUF_MEM_grow() changes it! */
86 if (!BUF_MEM_grow(*collector, i + datalen))
88 memcpy((*collector)->data + i, data, datalen);
92 static int pkey_kdf_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
94 EVP_PKEY_KDF_CTX *pkctx = ctx->data;
95 EVP_KDF_CTX *kctx = pkctx->kctx;
96 enum { T_OCTET_STRING, T_UINT64, T_DIGEST, T_INT } cmd;
97 const char *name, *mdname;
98 BUF_MEM **collector = NULL;
99 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
102 case EVP_PKEY_CTRL_PASS:
103 cmd = T_OCTET_STRING;
104 name = OSSL_KDF_PARAM_PASSWORD;
106 case EVP_PKEY_CTRL_HKDF_SALT:
107 case EVP_PKEY_CTRL_SCRYPT_SALT:
108 cmd = T_OCTET_STRING;
109 name = OSSL_KDF_PARAM_SALT;
111 case EVP_PKEY_CTRL_TLS_MD:
112 case EVP_PKEY_CTRL_HKDF_MD:
114 name = OSSL_KDF_PARAM_DIGEST;
116 case EVP_PKEY_CTRL_TLS_SECRET:
117 cmd = T_OCTET_STRING;
118 name = OSSL_KDF_PARAM_SECRET;
120 * Perform the semantics described in
121 * EVP_PKEY_CTX_add1_tls1_prf_seed(3)
123 if (ctx->pmeth->pkey_id == NID_tls1_prf)
124 BUF_MEM_free(pkctx->collected_seed);
126 case EVP_PKEY_CTRL_TLS_SEED:
127 cmd = T_OCTET_STRING;
128 name = OSSL_KDF_PARAM_SEED;
129 collector = &pkctx->collected_seed;
131 case EVP_PKEY_CTRL_HKDF_KEY:
132 cmd = T_OCTET_STRING;
133 name = OSSL_KDF_PARAM_KEY;
135 case EVP_PKEY_CTRL_HKDF_INFO:
136 cmd = T_OCTET_STRING;
137 name = OSSL_KDF_PARAM_INFO;
138 collector = &pkctx->collected_info;
140 case EVP_PKEY_CTRL_HKDF_MODE:
142 name = OSSL_KDF_PARAM_MODE;
144 case EVP_PKEY_CTRL_SCRYPT_N:
146 name = OSSL_KDF_PARAM_SCRYPT_N;
148 case EVP_PKEY_CTRL_SCRYPT_R:
149 cmd = T_UINT64; /* Range checking occurs on the provider side */
150 name = OSSL_KDF_PARAM_SCRYPT_R;
152 case EVP_PKEY_CTRL_SCRYPT_P:
153 cmd = T_UINT64; /* Range checking occurs on the provider side */
154 name = OSSL_KDF_PARAM_SCRYPT_P;
156 case EVP_PKEY_CTRL_SCRYPT_MAXMEM_BYTES:
158 name = OSSL_KDF_PARAM_SCRYPT_MAXMEM;
164 if (collector != NULL) {
167 return collect(collector, p2, p1);
169 OPENSSL_assert("You shouldn't be here");
178 OSSL_PARAM_construct_octet_string(name, (unsigned char *)p2,
183 mdname = EVP_MD_name((const EVP_MD *)p2);
184 params[0] = OSSL_PARAM_construct_utf8_string(name, (char *)mdname,
189 * These are special because the helper macros pass a pointer to the
190 * stack, so a local copy is required.
193 params[0] = OSSL_PARAM_construct_int(name, &p1);
197 params[0] = OSSL_PARAM_construct_uint64(name, (uint64_t *)p2);
201 return EVP_KDF_CTX_set_params(kctx, params);
204 static int pkey_kdf_ctrl_str(EVP_PKEY_CTX *ctx, const char *type,
207 EVP_PKEY_KDF_CTX *pkctx = ctx->data;
208 EVP_KDF_CTX *kctx = pkctx->kctx;
209 const EVP_KDF *kdf = EVP_KDF_CTX_kdf(kctx);
210 BUF_MEM **collector = NULL;
211 const OSSL_PARAM *defs = EVP_KDF_CTX_settable_params(kdf);
212 OSSL_PARAM params[2] = { OSSL_PARAM_END, OSSL_PARAM_END };
215 /* Deal with ctrl name aliasing */
216 if (strcmp(type, "md") == 0)
217 type = OSSL_KDF_PARAM_DIGEST;
218 /* scrypt uses 'N', params uses 'n' */
219 if (strcmp(type, "N") == 0)
220 type = OSSL_KDF_PARAM_SCRYPT_N;
222 if (!OSSL_PARAM_allocate_from_text(¶ms[0], defs, type,
223 value, strlen(value)))
227 * We do the same special casing of seed and info here as in
230 if (strcmp(params[0].key, OSSL_KDF_PARAM_SEED) == 0)
231 collector = &pkctx->collected_seed;
232 else if (strcmp(params[0].key, OSSL_KDF_PARAM_INFO) == 0)
233 collector = &pkctx->collected_info;
235 if (collector != NULL)
236 ok = collect(collector, params[0].data, params[0].data_size);
238 ok = EVP_KDF_CTX_set_params(kctx, params);
239 OPENSSL_free(params[0].data);
243 static int pkey_kdf_derive_init(EVP_PKEY_CTX *ctx)
245 EVP_PKEY_KDF_CTX *pkctx = ctx->data;
247 pkey_kdf_free_collected(pkctx);
248 if (pkctx->kctx != NULL)
249 EVP_KDF_reset(pkctx->kctx);
254 * For fixed-output algorithms the keylen parameter is an "out" parameter
255 * otherwise it is an "in" parameter.
257 static int pkey_kdf_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
260 EVP_PKEY_KDF_CTX *pkctx = ctx->data;
261 EVP_KDF_CTX *kctx = pkctx->kctx;
262 size_t outlen = EVP_KDF_size(kctx);
265 if (pkctx->collected_seed != NULL) {
266 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
269 OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_SEED,
270 pkctx->collected_seed->data,
271 pkctx->collected_seed->length);
273 r = EVP_KDF_CTX_set_params(kctx, params);
274 pkey_kdf_free_collected(pkctx);
278 if (pkctx->collected_info != NULL) {
279 OSSL_PARAM params[] = { OSSL_PARAM_END, OSSL_PARAM_END };
282 OSSL_PARAM_construct_octet_string(OSSL_KDF_PARAM_INFO,
283 pkctx->collected_info->data,
284 pkctx->collected_info->length);
286 r = EVP_KDF_CTX_set_params(kctx, params);
287 pkey_kdf_free_collected(pkctx);
291 if (outlen == 0 || outlen == SIZE_MAX) {
292 /* Variable-output algorithm */
296 /* Fixed-output algorithm */
301 return EVP_KDF_derive(kctx, key, *keylen);
304 #ifndef OPENSSL_NO_SCRYPT
305 const EVP_PKEY_METHOD scrypt_pkey_meth = {
329 pkey_kdf_derive_init,
336 const EVP_PKEY_METHOD tls1_prf_pkey_meth = {
360 pkey_kdf_derive_init,
366 const EVP_PKEY_METHOD hkdf_pkey_meth = {
390 pkey_kdf_derive_init,