2 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
12 #include <openssl/hmac.h>
13 #include <openssl/kdf.h>
14 #include <openssl/evp.h>
15 #include "internal/cryptlib.h"
16 #include "internal/evp_int.h"
18 #define HKDF_MAXBUF 1024
20 static unsigned char *HKDF(const EVP_MD *evp_md,
21 const unsigned char *salt, size_t salt_len,
22 const unsigned char *key, size_t key_len,
23 const unsigned char *info, size_t info_len,
24 unsigned char *okm, size_t okm_len);
26 static unsigned char *HKDF_Extract(const EVP_MD *evp_md,
27 const unsigned char *salt, size_t salt_len,
28 const unsigned char *key, size_t key_len,
29 unsigned char *prk, size_t *prk_len);
31 static unsigned char *HKDF_Expand(const EVP_MD *evp_md,
32 const unsigned char *prk, size_t prk_len,
33 const unsigned char *info, size_t info_len,
34 unsigned char *okm, size_t okm_len);
43 unsigned char info[HKDF_MAXBUF];
47 static int pkey_hkdf_init(EVP_PKEY_CTX *ctx)
51 if ((kctx = OPENSSL_zalloc(sizeof(*kctx))) == NULL) {
52 KDFerr(KDF_F_PKEY_HKDF_INIT, ERR_R_MALLOC_FAILURE);
61 static void pkey_hkdf_cleanup(EVP_PKEY_CTX *ctx)
63 HKDF_PKEY_CTX *kctx = ctx->data;
64 OPENSSL_clear_free(kctx->salt, kctx->salt_len);
65 OPENSSL_clear_free(kctx->key, kctx->key_len);
66 OPENSSL_cleanse(kctx->info, kctx->info_len);
70 static int pkey_hkdf_ctrl(EVP_PKEY_CTX *ctx, int type, int p1, void *p2)
72 HKDF_PKEY_CTX *kctx = ctx->data;
75 case EVP_PKEY_CTRL_HKDF_MD:
82 case EVP_PKEY_CTRL_HKDF_MODE:
86 case EVP_PKEY_CTRL_HKDF_SALT:
87 if (p1 == 0 || p2 == NULL)
93 if (kctx->salt != NULL)
94 OPENSSL_clear_free(kctx->salt, kctx->salt_len);
96 kctx->salt = OPENSSL_memdup(p2, p1);
97 if (kctx->salt == NULL)
103 case EVP_PKEY_CTRL_HKDF_KEY:
107 if (kctx->key != NULL)
108 OPENSSL_clear_free(kctx->key, kctx->key_len);
110 kctx->key = OPENSSL_memdup(p2, p1);
111 if (kctx->key == NULL)
117 case EVP_PKEY_CTRL_HKDF_INFO:
118 if (p1 == 0 || p2 == NULL)
121 if (p1 < 0 || p1 > (int)(HKDF_MAXBUF - kctx->info_len))
124 memcpy(kctx->info + kctx->info_len, p2, p1);
125 kctx->info_len += p1;
134 static int pkey_hkdf_ctrl_str(EVP_PKEY_CTX *ctx, const char *type,
137 if (strcmp(type, "mode") == 0) {
140 if (strcmp(value, "EXTRACT_AND_EXPAND") == 0)
141 mode = EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND;
142 else if (strcmp(value, "EXTRACT_ONLY") == 0)
143 mode = EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY;
144 else if (strcmp(value, "EXPAND_ONLY") == 0)
145 mode = EVP_PKEY_HKDEF_MODE_EXPAND_ONLY;
149 return EVP_PKEY_CTX_hkdf_mode(ctx, mode);
152 if (strcmp(type, "md") == 0)
153 return EVP_PKEY_CTX_md(ctx, EVP_PKEY_OP_DERIVE,
154 EVP_PKEY_CTRL_HKDF_MD, value);
156 if (strcmp(type, "salt") == 0)
157 return EVP_PKEY_CTX_str2ctrl(ctx, EVP_PKEY_CTRL_HKDF_SALT, value);
159 if (strcmp(type, "hexsalt") == 0)
160 return EVP_PKEY_CTX_hex2ctrl(ctx, EVP_PKEY_CTRL_HKDF_SALT, value);
162 if (strcmp(type, "key") == 0)
163 return EVP_PKEY_CTX_str2ctrl(ctx, EVP_PKEY_CTRL_HKDF_KEY, value);
165 if (strcmp(type, "hexkey") == 0)
166 return EVP_PKEY_CTX_hex2ctrl(ctx, EVP_PKEY_CTRL_HKDF_KEY, value);
168 if (strcmp(type, "info") == 0)
169 return EVP_PKEY_CTX_str2ctrl(ctx, EVP_PKEY_CTRL_HKDF_INFO, value);
171 if (strcmp(type, "hexinfo") == 0)
172 return EVP_PKEY_CTX_hex2ctrl(ctx, EVP_PKEY_CTRL_HKDF_INFO, value);
174 KDFerr(KDF_F_PKEY_HKDF_CTRL_STR, KDF_R_UNKNOWN_PARAMETER_TYPE);
178 static int pkey_hkdf_derive_init(EVP_PKEY_CTX *ctx)
180 HKDF_PKEY_CTX *kctx = ctx->data;
182 OPENSSL_clear_free(kctx->key, kctx->key_len);
183 OPENSSL_clear_free(kctx->salt, kctx->salt_len);
184 OPENSSL_cleanse(kctx->info, kctx->info_len);
185 memset(kctx, 0, sizeof(*kctx));
190 static int pkey_hkdf_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
193 HKDF_PKEY_CTX *kctx = ctx->data;
195 if (kctx->md == NULL) {
196 KDFerr(KDF_F_PKEY_HKDF_DERIVE, KDF_R_MISSING_MESSAGE_DIGEST);
199 if (kctx->key == NULL) {
200 KDFerr(KDF_F_PKEY_HKDF_DERIVE, KDF_R_MISSING_KEY);
204 switch (kctx->mode) {
205 case EVP_PKEY_HKDEF_MODE_EXTRACT_AND_EXPAND:
206 return HKDF(kctx->md, kctx->salt, kctx->salt_len, kctx->key,
207 kctx->key_len, kctx->info, kctx->info_len, key,
210 case EVP_PKEY_HKDEF_MODE_EXTRACT_ONLY:
212 *keylen = EVP_MD_size(kctx->md);
215 return HKDF_Extract(kctx->md, kctx->salt, kctx->salt_len, kctx->key,
216 kctx->key_len, key, keylen) != NULL;
218 case EVP_PKEY_HKDEF_MODE_EXPAND_ONLY:
219 return HKDF_Expand(kctx->md, kctx->key, kctx->key_len, kctx->info,
220 kctx->info_len, key, *keylen) != NULL;
227 const EVP_PKEY_METHOD hkdf_pkey_meth = {
251 pkey_hkdf_derive_init,
257 static unsigned char *HKDF(const EVP_MD *evp_md,
258 const unsigned char *salt, size_t salt_len,
259 const unsigned char *key, size_t key_len,
260 const unsigned char *info, size_t info_len,
261 unsigned char *okm, size_t okm_len)
263 unsigned char prk[EVP_MAX_MD_SIZE];
267 if (!HKDF_Extract(evp_md, salt, salt_len, key, key_len, prk, &prk_len))
270 ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
271 OPENSSL_cleanse(prk, sizeof(prk));
276 static unsigned char *HKDF_Extract(const EVP_MD *evp_md,
277 const unsigned char *salt, size_t salt_len,
278 const unsigned char *key, size_t key_len,
279 unsigned char *prk, size_t *prk_len)
281 unsigned int tmp_len;
283 if (!HMAC(evp_md, salt, salt_len, key, key_len, prk, &tmp_len))
290 static unsigned char *HKDF_Expand(const EVP_MD *evp_md,
291 const unsigned char *prk, size_t prk_len,
292 const unsigned char *info, size_t info_len,
293 unsigned char *okm, size_t okm_len)
296 unsigned char *ret = NULL;
300 unsigned char prev[EVP_MAX_MD_SIZE];
302 size_t done_len = 0, dig_len = EVP_MD_size(evp_md);
304 size_t n = okm_len / dig_len;
305 if (okm_len % dig_len)
308 if (n > 255 || okm == NULL)
311 if ((hmac = HMAC_CTX_new()) == NULL)
314 if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
317 for (i = 1; i <= n; i++) {
319 const unsigned char ctr = i;
322 if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
325 if (!HMAC_Update(hmac, prev, dig_len))
329 if (!HMAC_Update(hmac, info, info_len))
332 if (!HMAC_Update(hmac, &ctr, 1))
335 if (!HMAC_Final(hmac, prev, NULL))
338 copy_len = (done_len + dig_len > okm_len) ?
342 memcpy(okm + done_len, prev, copy_len);
344 done_len += copy_len;
349 OPENSSL_cleanse(prev, sizeof(prev));