hkdf.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761
  1. /*
  2. * Copyright 2016-2023 The OpenSSL Project Authors. All Rights Reserved.
  3. *
  4. * Licensed under the Apache License 2.0 (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
  8. */
  9. /*
  10. * HMAC low level APIs are deprecated for public use, but still ok for internal
  11. * use.
  12. */
  13. #include "internal/deprecated.h"
  14. #include <stdlib.h>
  15. #include <stdarg.h>
  16. #include <string.h>
  17. #include <openssl/hmac.h>
  18. #include <openssl/evp.h>
  19. #include <openssl/kdf.h>
  20. #include <openssl/core_names.h>
  21. #include <openssl/proverr.h>
  22. #include "internal/cryptlib.h"
  23. #include "internal/numbers.h"
  24. #include "internal/packet.h"
  25. #include "crypto/evp.h"
  26. #include "prov/provider_ctx.h"
  27. #include "prov/providercommon.h"
  28. #include "prov/implementations.h"
  29. #include "prov/provider_util.h"
  30. #include "internal/e_os.h"
  31. #include "internal/params.h"
  32. #define HKDF_MAXBUF 2048
  33. #define HKDF_MAXINFO (32*1024)
  34. static OSSL_FUNC_kdf_newctx_fn kdf_hkdf_new;
  35. static OSSL_FUNC_kdf_dupctx_fn kdf_hkdf_dup;
  36. static OSSL_FUNC_kdf_freectx_fn kdf_hkdf_free;
  37. static OSSL_FUNC_kdf_reset_fn kdf_hkdf_reset;
  38. static OSSL_FUNC_kdf_derive_fn kdf_hkdf_derive;
  39. static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_hkdf_settable_ctx_params;
  40. static OSSL_FUNC_kdf_set_ctx_params_fn kdf_hkdf_set_ctx_params;
  41. static OSSL_FUNC_kdf_gettable_ctx_params_fn kdf_hkdf_gettable_ctx_params;
  42. static OSSL_FUNC_kdf_get_ctx_params_fn kdf_hkdf_get_ctx_params;
  43. static OSSL_FUNC_kdf_derive_fn kdf_tls1_3_derive;
  44. static OSSL_FUNC_kdf_settable_ctx_params_fn kdf_tls1_3_settable_ctx_params;
  45. static OSSL_FUNC_kdf_set_ctx_params_fn kdf_tls1_3_set_ctx_params;
  46. static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  47. const unsigned char *salt, size_t salt_len,
  48. const unsigned char *key, size_t key_len,
  49. const unsigned char *info, size_t info_len,
  50. unsigned char *okm, size_t okm_len);
  51. static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  52. const unsigned char *salt, size_t salt_len,
  53. const unsigned char *ikm, size_t ikm_len,
  54. unsigned char *prk, size_t prk_len);
  55. static int HKDF_Expand(const EVP_MD *evp_md,
  56. const unsigned char *prk, size_t prk_len,
  57. const unsigned char *info, size_t info_len,
  58. unsigned char *okm, size_t okm_len);
  59. /* Settable context parameters that are common across HKDF and the TLS KDF */
  60. #define HKDF_COMMON_SETTABLES \
  61. OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_MODE, NULL, 0), \
  62. OSSL_PARAM_int(OSSL_KDF_PARAM_MODE, NULL), \
  63. OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_PROPERTIES, NULL, 0), \
  64. OSSL_PARAM_utf8_string(OSSL_KDF_PARAM_DIGEST, NULL, 0), \
  65. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_KEY, NULL, 0), \
  66. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_SALT, NULL, 0)
  67. typedef struct {
  68. void *provctx;
  69. int mode;
  70. PROV_DIGEST digest;
  71. unsigned char *salt;
  72. size_t salt_len;
  73. unsigned char *key;
  74. size_t key_len;
  75. unsigned char *prefix;
  76. size_t prefix_len;
  77. unsigned char *label;
  78. size_t label_len;
  79. unsigned char *data;
  80. size_t data_len;
  81. unsigned char *info;
  82. size_t info_len;
  83. } KDF_HKDF;
  84. static void *kdf_hkdf_new(void *provctx)
  85. {
  86. KDF_HKDF *ctx;
  87. if (!ossl_prov_is_running())
  88. return NULL;
  89. if ((ctx = OPENSSL_zalloc(sizeof(*ctx))) != NULL)
  90. ctx->provctx = provctx;
  91. return ctx;
  92. }
  93. static void kdf_hkdf_free(void *vctx)
  94. {
  95. KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  96. if (ctx != NULL) {
  97. kdf_hkdf_reset(ctx);
  98. OPENSSL_free(ctx);
  99. }
  100. }
  101. static void kdf_hkdf_reset(void *vctx)
  102. {
  103. KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  104. void *provctx = ctx->provctx;
  105. ossl_prov_digest_reset(&ctx->digest);
  106. OPENSSL_free(ctx->salt);
  107. OPENSSL_free(ctx->prefix);
  108. OPENSSL_free(ctx->label);
  109. OPENSSL_clear_free(ctx->data, ctx->data_len);
  110. OPENSSL_clear_free(ctx->key, ctx->key_len);
  111. OPENSSL_clear_free(ctx->info, ctx->info_len);
  112. memset(ctx, 0, sizeof(*ctx));
  113. ctx->provctx = provctx;
  114. }
  115. static void *kdf_hkdf_dup(void *vctx)
  116. {
  117. const KDF_HKDF *src = (const KDF_HKDF *)vctx;
  118. KDF_HKDF *dest;
  119. dest = kdf_hkdf_new(src->provctx);
  120. if (dest != NULL) {
  121. if (!ossl_prov_memdup(src->salt, src->salt_len, &dest->salt,
  122. &dest->salt_len)
  123. || !ossl_prov_memdup(src->key, src->key_len,
  124. &dest->key , &dest->key_len)
  125. || !ossl_prov_memdup(src->prefix, src->prefix_len,
  126. &dest->prefix, &dest->prefix_len)
  127. || !ossl_prov_memdup(src->label, src->label_len,
  128. &dest->label, &dest->label_len)
  129. || !ossl_prov_memdup(src->data, src->data_len,
  130. &dest->data, &dest->data_len)
  131. || !ossl_prov_memdup(src->info, src->info_len,
  132. &dest->info, &dest->info_len)
  133. || !ossl_prov_digest_copy(&dest->digest, &src->digest))
  134. goto err;
  135. dest->mode = src->mode;
  136. }
  137. return dest;
  138. err:
  139. kdf_hkdf_free(dest);
  140. return NULL;
  141. }
  142. static size_t kdf_hkdf_size(KDF_HKDF *ctx)
  143. {
  144. int sz;
  145. const EVP_MD *md = ossl_prov_digest_md(&ctx->digest);
  146. if (ctx->mode != EVP_KDF_HKDF_MODE_EXTRACT_ONLY)
  147. return SIZE_MAX;
  148. if (md == NULL) {
  149. ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
  150. return 0;
  151. }
  152. sz = EVP_MD_get_size(md);
  153. if (sz < 0)
  154. return 0;
  155. return sz;
  156. }
  157. static int kdf_hkdf_derive(void *vctx, unsigned char *key, size_t keylen,
  158. const OSSL_PARAM params[])
  159. {
  160. KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  161. OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
  162. const EVP_MD *md;
  163. if (!ossl_prov_is_running() || !kdf_hkdf_set_ctx_params(ctx, params))
  164. return 0;
  165. md = ossl_prov_digest_md(&ctx->digest);
  166. if (md == NULL) {
  167. ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
  168. return 0;
  169. }
  170. if (ctx->key == NULL) {
  171. ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_KEY);
  172. return 0;
  173. }
  174. if (keylen == 0) {
  175. ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
  176. return 0;
  177. }
  178. switch (ctx->mode) {
  179. case EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND:
  180. default:
  181. return HKDF(libctx, md, ctx->salt, ctx->salt_len,
  182. ctx->key, ctx->key_len, ctx->info, ctx->info_len, key, keylen);
  183. case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
  184. return HKDF_Extract(libctx, md, ctx->salt, ctx->salt_len,
  185. ctx->key, ctx->key_len, key, keylen);
  186. case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
  187. return HKDF_Expand(md, ctx->key, ctx->key_len, ctx->info,
  188. ctx->info_len, key, keylen);
  189. }
  190. }
  191. static int hkdf_common_set_ctx_params(KDF_HKDF *ctx, const OSSL_PARAM params[])
  192. {
  193. OSSL_LIB_CTX *libctx = PROV_LIBCTX_OF(ctx->provctx);
  194. const OSSL_PARAM *p;
  195. int n;
  196. if (params == NULL)
  197. return 1;
  198. if (!ossl_prov_digest_load_from_params(&ctx->digest, params, libctx))
  199. return 0;
  200. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_MODE)) != NULL) {
  201. if (p->data_type == OSSL_PARAM_UTF8_STRING) {
  202. if (OPENSSL_strcasecmp(p->data, "EXTRACT_AND_EXPAND") == 0) {
  203. ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND;
  204. } else if (OPENSSL_strcasecmp(p->data, "EXTRACT_ONLY") == 0) {
  205. ctx->mode = EVP_KDF_HKDF_MODE_EXTRACT_ONLY;
  206. } else if (OPENSSL_strcasecmp(p->data, "EXPAND_ONLY") == 0) {
  207. ctx->mode = EVP_KDF_HKDF_MODE_EXPAND_ONLY;
  208. } else {
  209. ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
  210. return 0;
  211. }
  212. } else if (OSSL_PARAM_get_int(p, &n)) {
  213. if (n != EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND
  214. && n != EVP_KDF_HKDF_MODE_EXTRACT_ONLY
  215. && n != EVP_KDF_HKDF_MODE_EXPAND_ONLY) {
  216. ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
  217. return 0;
  218. }
  219. ctx->mode = n;
  220. } else {
  221. ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
  222. return 0;
  223. }
  224. }
  225. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_KEY)) != NULL) {
  226. OPENSSL_clear_free(ctx->key, ctx->key_len);
  227. ctx->key = NULL;
  228. if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->key, 0,
  229. &ctx->key_len))
  230. return 0;
  231. }
  232. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_SALT)) != NULL) {
  233. if (p->data_size != 0 && p->data != NULL) {
  234. OPENSSL_free(ctx->salt);
  235. ctx->salt = NULL;
  236. if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->salt, 0,
  237. &ctx->salt_len))
  238. return 0;
  239. }
  240. }
  241. return 1;
  242. }
  243. static int kdf_hkdf_set_ctx_params(void *vctx, const OSSL_PARAM params[])
  244. {
  245. KDF_HKDF *ctx = vctx;
  246. if (params == NULL)
  247. return 1;
  248. if (!hkdf_common_set_ctx_params(ctx, params))
  249. return 0;
  250. if (ossl_param_get1_concat_octet_string(params, OSSL_KDF_PARAM_INFO,
  251. &ctx->info, &ctx->info_len,
  252. HKDF_MAXINFO) == 0)
  253. return 0;
  254. return 1;
  255. }
  256. static const OSSL_PARAM *kdf_hkdf_settable_ctx_params(ossl_unused void *ctx,
  257. ossl_unused void *provctx)
  258. {
  259. static const OSSL_PARAM known_settable_ctx_params[] = {
  260. HKDF_COMMON_SETTABLES,
  261. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
  262. OSSL_PARAM_END
  263. };
  264. return known_settable_ctx_params;
  265. }
  266. static int kdf_hkdf_get_ctx_params(void *vctx, OSSL_PARAM params[])
  267. {
  268. KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  269. OSSL_PARAM *p;
  270. if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_SIZE)) != NULL) {
  271. size_t sz = kdf_hkdf_size(ctx);
  272. if (sz == 0)
  273. return 0;
  274. return OSSL_PARAM_set_size_t(p, sz);
  275. }
  276. return -2;
  277. }
  278. static const OSSL_PARAM *kdf_hkdf_gettable_ctx_params(ossl_unused void *ctx,
  279. ossl_unused void *provctx)
  280. {
  281. static const OSSL_PARAM known_gettable_ctx_params[] = {
  282. OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
  283. OSSL_PARAM_END
  284. };
  285. return known_gettable_ctx_params;
  286. }
  287. const OSSL_DISPATCH ossl_kdf_hkdf_functions[] = {
  288. { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
  289. { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_hkdf_dup },
  290. { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
  291. { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
  292. { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_hkdf_derive },
  293. { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
  294. (void(*)(void))kdf_hkdf_settable_ctx_params },
  295. { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_hkdf_set_ctx_params },
  296. { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
  297. (void(*)(void))kdf_hkdf_gettable_ctx_params },
  298. { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
  299. OSSL_DISPATCH_END
  300. };
  301. /*
  302. * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
  303. * Section 2 (https://tools.ietf.org/html/rfc5869#section-2) and
  304. * "Cryptographic Extraction and Key Derivation: The HKDF Scheme"
  305. * Section 4.2 (https://eprint.iacr.org/2010/264.pdf).
  306. *
  307. * From the paper:
  308. * The scheme HKDF is specified as:
  309. * HKDF(XTS, SKM, CTXinfo, L) = K(1) | K(2) | ... | K(t)
  310. *
  311. * where:
  312. * SKM is source key material
  313. * XTS is extractor salt (which may be null or constant)
  314. * CTXinfo is context information (may be null)
  315. * L is the number of key bits to be produced by KDF
  316. * k is the output length in bits of the hash function used with HMAC
  317. * t = ceil(L/k)
  318. * the value K(t) is truncated to its first d = L mod k bits.
  319. *
  320. * From RFC 5869:
  321. * 2.2. Step 1: Extract
  322. * HKDF-Extract(salt, IKM) -> PRK
  323. * 2.3. Step 2: Expand
  324. * HKDF-Expand(PRK, info, L) -> OKM
  325. */
  326. static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  327. const unsigned char *salt, size_t salt_len,
  328. const unsigned char *ikm, size_t ikm_len,
  329. const unsigned char *info, size_t info_len,
  330. unsigned char *okm, size_t okm_len)
  331. {
  332. unsigned char prk[EVP_MAX_MD_SIZE];
  333. int ret, sz;
  334. size_t prk_len;
  335. sz = EVP_MD_get_size(evp_md);
  336. if (sz < 0)
  337. return 0;
  338. prk_len = (size_t)sz;
  339. /* Step 1: HKDF-Extract(salt, IKM) -> PRK */
  340. if (!HKDF_Extract(libctx, evp_md,
  341. salt, salt_len, ikm, ikm_len, prk, prk_len))
  342. return 0;
  343. /* Step 2: HKDF-Expand(PRK, info, L) -> OKM */
  344. ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
  345. OPENSSL_cleanse(prk, sizeof(prk));
  346. return ret;
  347. }
  348. /*
  349. * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
  350. * Section 2.2 (https://tools.ietf.org/html/rfc5869#section-2.2).
  351. *
  352. * 2.2. Step 1: Extract
  353. *
  354. * HKDF-Extract(salt, IKM) -> PRK
  355. *
  356. * Options:
  357. * Hash a hash function; HashLen denotes the length of the
  358. * hash function output in octets
  359. *
  360. * Inputs:
  361. * salt optional salt value (a non-secret random value);
  362. * if not provided, it is set to a string of HashLen zeros.
  363. * IKM input keying material
  364. *
  365. * Output:
  366. * PRK a pseudorandom key (of HashLen octets)
  367. *
  368. * The output PRK is calculated as follows:
  369. *
  370. * PRK = HMAC-Hash(salt, IKM)
  371. */
  372. static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  373. const unsigned char *salt, size_t salt_len,
  374. const unsigned char *ikm, size_t ikm_len,
  375. unsigned char *prk, size_t prk_len)
  376. {
  377. int sz = EVP_MD_get_size(evp_md);
  378. if (sz < 0)
  379. return 0;
  380. if (prk_len != (size_t)sz) {
  381. ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
  382. return 0;
  383. }
  384. /* calc: PRK = HMAC-Hash(salt, IKM) */
  385. return
  386. EVP_Q_mac(libctx, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL, salt,
  387. salt_len, ikm, ikm_len, prk, EVP_MD_get_size(evp_md), NULL)
  388. != NULL;
  389. }
  390. /*
  391. * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
  392. * Section 2.3 (https://tools.ietf.org/html/rfc5869#section-2.3).
  393. *
  394. * 2.3. Step 2: Expand
  395. *
  396. * HKDF-Expand(PRK, info, L) -> OKM
  397. *
  398. * Options:
  399. * Hash a hash function; HashLen denotes the length of the
  400. * hash function output in octets
  401. *
  402. * Inputs:
  403. * PRK a pseudorandom key of at least HashLen octets
  404. * (usually, the output from the extract step)
  405. * info optional context and application specific information
  406. * (can be a zero-length string)
  407. * L length of output keying material in octets
  408. * (<= 255*HashLen)
  409. *
  410. * Output:
  411. * OKM output keying material (of L octets)
  412. *
  413. * The output OKM is calculated as follows:
  414. *
  415. * N = ceil(L/HashLen)
  416. * T = T(1) | T(2) | T(3) | ... | T(N)
  417. * OKM = first L octets of T
  418. *
  419. * where:
  420. * T(0) = empty string (zero length)
  421. * T(1) = HMAC-Hash(PRK, T(0) | info | 0x01)
  422. * T(2) = HMAC-Hash(PRK, T(1) | info | 0x02)
  423. * T(3) = HMAC-Hash(PRK, T(2) | info | 0x03)
  424. * ...
  425. *
  426. * (where the constant concatenated to the end of each T(n) is a
  427. * single octet.)
  428. */
  429. static int HKDF_Expand(const EVP_MD *evp_md,
  430. const unsigned char *prk, size_t prk_len,
  431. const unsigned char *info, size_t info_len,
  432. unsigned char *okm, size_t okm_len)
  433. {
  434. HMAC_CTX *hmac;
  435. int ret = 0, sz;
  436. unsigned int i;
  437. unsigned char prev[EVP_MAX_MD_SIZE];
  438. size_t done_len = 0, dig_len, n;
  439. sz = EVP_MD_get_size(evp_md);
  440. if (sz <= 0)
  441. return 0;
  442. dig_len = (size_t)sz;
  443. /* calc: N = ceil(L/HashLen) */
  444. n = okm_len / dig_len;
  445. if (okm_len % dig_len)
  446. n++;
  447. if (n > 255 || okm == NULL)
  448. return 0;
  449. if ((hmac = HMAC_CTX_new()) == NULL)
  450. return 0;
  451. if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
  452. goto err;
  453. for (i = 1; i <= n; i++) {
  454. size_t copy_len;
  455. const unsigned char ctr = i;
  456. /* calc: T(i) = HMAC-Hash(PRK, T(i - 1) | info | i) */
  457. if (i > 1) {
  458. if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
  459. goto err;
  460. if (!HMAC_Update(hmac, prev, dig_len))
  461. goto err;
  462. }
  463. if (!HMAC_Update(hmac, info, info_len))
  464. goto err;
  465. if (!HMAC_Update(hmac, &ctr, 1))
  466. goto err;
  467. if (!HMAC_Final(hmac, prev, NULL))
  468. goto err;
  469. copy_len = (dig_len > okm_len - done_len) ?
  470. okm_len - done_len :
  471. dig_len;
  472. memcpy(okm + done_len, prev, copy_len);
  473. done_len += copy_len;
  474. }
  475. ret = 1;
  476. err:
  477. OPENSSL_cleanse(prev, sizeof(prev));
  478. HMAC_CTX_free(hmac);
  479. return ret;
  480. }
  481. /*
  482. * TLS uses slight variations of the above and for FIPS validation purposes,
  483. * they need to be present here.
  484. * Refer to RFC 8446 section 7 for specific details.
  485. */
  486. /*
  487. * Given a |secret|; a |label| of length |labellen|; and |data| of length
  488. * |datalen| (e.g. typically a hash of the handshake messages), derive a new
  489. * secret |outlen| bytes long and store it in the location pointed to be |out|.
  490. * The |data| value may be zero length. Returns 1 on success and 0 on failure.
  491. */
  492. static int prov_tls13_hkdf_expand(const EVP_MD *md,
  493. const unsigned char *key, size_t keylen,
  494. const unsigned char *prefix, size_t prefixlen,
  495. const unsigned char *label, size_t labellen,
  496. const unsigned char *data, size_t datalen,
  497. unsigned char *out, size_t outlen)
  498. {
  499. size_t hkdflabellen;
  500. unsigned char hkdflabel[HKDF_MAXBUF];
  501. WPACKET pkt;
  502. /*
  503. * 2 bytes for length of derived secret + 1 byte for length of combined
  504. * prefix and label + bytes for the label itself + 1 byte length of hash
  505. * + bytes for the hash itself. We've got the maximum the KDF can handle
  506. * which should always be sufficient.
  507. */
  508. if (!WPACKET_init_static_len(&pkt, hkdflabel, sizeof(hkdflabel), 0)
  509. || !WPACKET_put_bytes_u16(&pkt, outlen)
  510. || !WPACKET_start_sub_packet_u8(&pkt)
  511. || !WPACKET_memcpy(&pkt, prefix, prefixlen)
  512. || !WPACKET_memcpy(&pkt, label, labellen)
  513. || !WPACKET_close(&pkt)
  514. || !WPACKET_sub_memcpy_u8(&pkt, data, (data == NULL) ? 0 : datalen)
  515. || !WPACKET_get_total_written(&pkt, &hkdflabellen)
  516. || !WPACKET_finish(&pkt)) {
  517. WPACKET_cleanup(&pkt);
  518. return 0;
  519. }
  520. return HKDF_Expand(md, key, keylen, hkdflabel, hkdflabellen,
  521. out, outlen);
  522. }
  523. static int prov_tls13_hkdf_generate_secret(OSSL_LIB_CTX *libctx,
  524. const EVP_MD *md,
  525. const unsigned char *prevsecret,
  526. size_t prevsecretlen,
  527. const unsigned char *insecret,
  528. size_t insecretlen,
  529. const unsigned char *prefix,
  530. size_t prefixlen,
  531. const unsigned char *label,
  532. size_t labellen,
  533. unsigned char *out, size_t outlen)
  534. {
  535. size_t mdlen;
  536. int ret;
  537. unsigned char preextractsec[EVP_MAX_MD_SIZE];
  538. /* Always filled with zeros */
  539. static const unsigned char default_zeros[EVP_MAX_MD_SIZE];
  540. ret = EVP_MD_get_size(md);
  541. /* Ensure cast to size_t is safe */
  542. if (ret <= 0)
  543. return 0;
  544. mdlen = (size_t)ret;
  545. if (insecret == NULL) {
  546. insecret = default_zeros;
  547. insecretlen = mdlen;
  548. }
  549. if (prevsecret == NULL) {
  550. prevsecret = default_zeros;
  551. prevsecretlen = 0;
  552. } else {
  553. EVP_MD_CTX *mctx = EVP_MD_CTX_new();
  554. unsigned char hash[EVP_MAX_MD_SIZE];
  555. /* The pre-extract derive step uses a hash of no messages */
  556. if (mctx == NULL
  557. || EVP_DigestInit_ex(mctx, md, NULL) <= 0
  558. || EVP_DigestFinal_ex(mctx, hash, NULL) <= 0) {
  559. EVP_MD_CTX_free(mctx);
  560. return 0;
  561. }
  562. EVP_MD_CTX_free(mctx);
  563. /* Generate the pre-extract secret */
  564. if (!prov_tls13_hkdf_expand(md, prevsecret, mdlen,
  565. prefix, prefixlen, label, labellen,
  566. hash, mdlen, preextractsec, mdlen))
  567. return 0;
  568. prevsecret = preextractsec;
  569. prevsecretlen = mdlen;
  570. }
  571. ret = HKDF_Extract(libctx, md, prevsecret, prevsecretlen,
  572. insecret, insecretlen, out, outlen);
  573. if (prevsecret == preextractsec)
  574. OPENSSL_cleanse(preextractsec, mdlen);
  575. return ret;
  576. }
  577. static int kdf_tls1_3_derive(void *vctx, unsigned char *key, size_t keylen,
  578. const OSSL_PARAM params[])
  579. {
  580. KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  581. const EVP_MD *md;
  582. if (!ossl_prov_is_running() || !kdf_tls1_3_set_ctx_params(ctx, params))
  583. return 0;
  584. md = ossl_prov_digest_md(&ctx->digest);
  585. if (md == NULL) {
  586. ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
  587. return 0;
  588. }
  589. switch (ctx->mode) {
  590. default:
  591. return 0;
  592. case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
  593. return prov_tls13_hkdf_generate_secret(PROV_LIBCTX_OF(ctx->provctx),
  594. md,
  595. ctx->salt, ctx->salt_len,
  596. ctx->key, ctx->key_len,
  597. ctx->prefix, ctx->prefix_len,
  598. ctx->label, ctx->label_len,
  599. key, keylen);
  600. case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
  601. return prov_tls13_hkdf_expand(md, ctx->key, ctx->key_len,
  602. ctx->prefix, ctx->prefix_len,
  603. ctx->label, ctx->label_len,
  604. ctx->data, ctx->data_len,
  605. key, keylen);
  606. }
  607. }
  608. static int kdf_tls1_3_set_ctx_params(void *vctx, const OSSL_PARAM params[])
  609. {
  610. const OSSL_PARAM *p;
  611. KDF_HKDF *ctx = vctx;
  612. if (params == NULL)
  613. return 1;
  614. if (!hkdf_common_set_ctx_params(ctx, params))
  615. return 0;
  616. if (ctx->mode == EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND) {
  617. ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
  618. return 0;
  619. }
  620. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PREFIX)) != NULL) {
  621. OPENSSL_free(ctx->prefix);
  622. ctx->prefix = NULL;
  623. if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->prefix, 0,
  624. &ctx->prefix_len))
  625. return 0;
  626. }
  627. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_LABEL)) != NULL) {
  628. OPENSSL_free(ctx->label);
  629. ctx->label = NULL;
  630. if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->label, 0,
  631. &ctx->label_len))
  632. return 0;
  633. }
  634. OPENSSL_clear_free(ctx->data, ctx->data_len);
  635. ctx->data = NULL;
  636. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_DATA)) != NULL
  637. && !OSSL_PARAM_get_octet_string(p, (void **)&ctx->data, 0,
  638. &ctx->data_len))
  639. return 0;
  640. return 1;
  641. }
  642. static const OSSL_PARAM *kdf_tls1_3_settable_ctx_params(ossl_unused void *ctx,
  643. ossl_unused void *provctx)
  644. {
  645. static const OSSL_PARAM known_settable_ctx_params[] = {
  646. HKDF_COMMON_SETTABLES,
  647. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PREFIX, NULL, 0),
  648. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_LABEL, NULL, 0),
  649. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_DATA, NULL, 0),
  650. OSSL_PARAM_END
  651. };
  652. return known_settable_ctx_params;
  653. }
  654. const OSSL_DISPATCH ossl_kdf_tls1_3_kdf_functions[] = {
  655. { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
  656. { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_hkdf_dup },
  657. { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
  658. { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
  659. { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_tls1_3_derive },
  660. { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
  661. (void(*)(void))kdf_tls1_3_settable_ctx_params },
  662. { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_tls1_3_set_ctx_params },
  663. { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
  664. (void(*)(void))kdf_hkdf_gettable_ctx_params },
  665. { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
  666. OSSL_DISPATCH_END
  667. };