hkdf.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769
  1. /*
  2. * Copyright 2016-2024 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. if ((p = OSSL_PARAM_locate(params, OSSL_KDF_PARAM_INFO)) != NULL) {
  277. if (ctx->info == NULL || ctx->info_len == 0) {
  278. p->return_size = 0;
  279. return 1;
  280. }
  281. return OSSL_PARAM_set_octet_string(p, ctx->info, ctx->info_len);
  282. }
  283. return -2;
  284. }
  285. static const OSSL_PARAM *kdf_hkdf_gettable_ctx_params(ossl_unused void *ctx,
  286. ossl_unused void *provctx)
  287. {
  288. static const OSSL_PARAM known_gettable_ctx_params[] = {
  289. OSSL_PARAM_size_t(OSSL_KDF_PARAM_SIZE, NULL),
  290. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_INFO, NULL, 0),
  291. OSSL_PARAM_END
  292. };
  293. return known_gettable_ctx_params;
  294. }
  295. const OSSL_DISPATCH ossl_kdf_hkdf_functions[] = {
  296. { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
  297. { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_hkdf_dup },
  298. { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
  299. { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
  300. { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_hkdf_derive },
  301. { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
  302. (void(*)(void))kdf_hkdf_settable_ctx_params },
  303. { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_hkdf_set_ctx_params },
  304. { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
  305. (void(*)(void))kdf_hkdf_gettable_ctx_params },
  306. { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
  307. OSSL_DISPATCH_END
  308. };
  309. /*
  310. * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
  311. * Section 2 (https://tools.ietf.org/html/rfc5869#section-2) and
  312. * "Cryptographic Extraction and Key Derivation: The HKDF Scheme"
  313. * Section 4.2 (https://eprint.iacr.org/2010/264.pdf).
  314. *
  315. * From the paper:
  316. * The scheme HKDF is specified as:
  317. * HKDF(XTS, SKM, CTXinfo, L) = K(1) | K(2) | ... | K(t)
  318. *
  319. * where:
  320. * SKM is source key material
  321. * XTS is extractor salt (which may be null or constant)
  322. * CTXinfo is context information (may be null)
  323. * L is the number of key bits to be produced by KDF
  324. * k is the output length in bits of the hash function used with HMAC
  325. * t = ceil(L/k)
  326. * the value K(t) is truncated to its first d = L mod k bits.
  327. *
  328. * From RFC 5869:
  329. * 2.2. Step 1: Extract
  330. * HKDF-Extract(salt, IKM) -> PRK
  331. * 2.3. Step 2: Expand
  332. * HKDF-Expand(PRK, info, L) -> OKM
  333. */
  334. static int HKDF(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  335. const unsigned char *salt, size_t salt_len,
  336. const unsigned char *ikm, size_t ikm_len,
  337. const unsigned char *info, size_t info_len,
  338. unsigned char *okm, size_t okm_len)
  339. {
  340. unsigned char prk[EVP_MAX_MD_SIZE];
  341. int ret, sz;
  342. size_t prk_len;
  343. sz = EVP_MD_get_size(evp_md);
  344. if (sz < 0)
  345. return 0;
  346. prk_len = (size_t)sz;
  347. /* Step 1: HKDF-Extract(salt, IKM) -> PRK */
  348. if (!HKDF_Extract(libctx, evp_md,
  349. salt, salt_len, ikm, ikm_len, prk, prk_len))
  350. return 0;
  351. /* Step 2: HKDF-Expand(PRK, info, L) -> OKM */
  352. ret = HKDF_Expand(evp_md, prk, prk_len, info, info_len, okm, okm_len);
  353. OPENSSL_cleanse(prk, sizeof(prk));
  354. return ret;
  355. }
  356. /*
  357. * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
  358. * Section 2.2 (https://tools.ietf.org/html/rfc5869#section-2.2).
  359. *
  360. * 2.2. Step 1: Extract
  361. *
  362. * HKDF-Extract(salt, IKM) -> PRK
  363. *
  364. * Options:
  365. * Hash a hash function; HashLen denotes the length of the
  366. * hash function output in octets
  367. *
  368. * Inputs:
  369. * salt optional salt value (a non-secret random value);
  370. * if not provided, it is set to a string of HashLen zeros.
  371. * IKM input keying material
  372. *
  373. * Output:
  374. * PRK a pseudorandom key (of HashLen octets)
  375. *
  376. * The output PRK is calculated as follows:
  377. *
  378. * PRK = HMAC-Hash(salt, IKM)
  379. */
  380. static int HKDF_Extract(OSSL_LIB_CTX *libctx, const EVP_MD *evp_md,
  381. const unsigned char *salt, size_t salt_len,
  382. const unsigned char *ikm, size_t ikm_len,
  383. unsigned char *prk, size_t prk_len)
  384. {
  385. int sz = EVP_MD_get_size(evp_md);
  386. if (sz < 0)
  387. return 0;
  388. if (prk_len != (size_t)sz) {
  389. ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_OUTPUT_BUFFER_SIZE);
  390. return 0;
  391. }
  392. /* calc: PRK = HMAC-Hash(salt, IKM) */
  393. return
  394. EVP_Q_mac(libctx, "HMAC", NULL, EVP_MD_get0_name(evp_md), NULL, salt,
  395. salt_len, ikm, ikm_len, prk, EVP_MD_get_size(evp_md), NULL)
  396. != NULL;
  397. }
  398. /*
  399. * Refer to "HMAC-based Extract-and-Expand Key Derivation Function (HKDF)"
  400. * Section 2.3 (https://tools.ietf.org/html/rfc5869#section-2.3).
  401. *
  402. * 2.3. Step 2: Expand
  403. *
  404. * HKDF-Expand(PRK, info, L) -> OKM
  405. *
  406. * Options:
  407. * Hash a hash function; HashLen denotes the length of the
  408. * hash function output in octets
  409. *
  410. * Inputs:
  411. * PRK a pseudorandom key of at least HashLen octets
  412. * (usually, the output from the extract step)
  413. * info optional context and application specific information
  414. * (can be a zero-length string)
  415. * L length of output keying material in octets
  416. * (<= 255*HashLen)
  417. *
  418. * Output:
  419. * OKM output keying material (of L octets)
  420. *
  421. * The output OKM is calculated as follows:
  422. *
  423. * N = ceil(L/HashLen)
  424. * T = T(1) | T(2) | T(3) | ... | T(N)
  425. * OKM = first L octets of T
  426. *
  427. * where:
  428. * T(0) = empty string (zero length)
  429. * T(1) = HMAC-Hash(PRK, T(0) | info | 0x01)
  430. * T(2) = HMAC-Hash(PRK, T(1) | info | 0x02)
  431. * T(3) = HMAC-Hash(PRK, T(2) | info | 0x03)
  432. * ...
  433. *
  434. * (where the constant concatenated to the end of each T(n) is a
  435. * single octet.)
  436. */
  437. static int HKDF_Expand(const EVP_MD *evp_md,
  438. const unsigned char *prk, size_t prk_len,
  439. const unsigned char *info, size_t info_len,
  440. unsigned char *okm, size_t okm_len)
  441. {
  442. HMAC_CTX *hmac;
  443. int ret = 0, sz;
  444. unsigned int i;
  445. unsigned char prev[EVP_MAX_MD_SIZE];
  446. size_t done_len = 0, dig_len, n;
  447. sz = EVP_MD_get_size(evp_md);
  448. if (sz <= 0)
  449. return 0;
  450. dig_len = (size_t)sz;
  451. /* calc: N = ceil(L/HashLen) */
  452. n = okm_len / dig_len;
  453. if (okm_len % dig_len)
  454. n++;
  455. if (n > 255 || okm == NULL)
  456. return 0;
  457. if ((hmac = HMAC_CTX_new()) == NULL)
  458. return 0;
  459. if (!HMAC_Init_ex(hmac, prk, prk_len, evp_md, NULL))
  460. goto err;
  461. for (i = 1; i <= n; i++) {
  462. size_t copy_len;
  463. const unsigned char ctr = i;
  464. /* calc: T(i) = HMAC-Hash(PRK, T(i - 1) | info | i) */
  465. if (i > 1) {
  466. if (!HMAC_Init_ex(hmac, NULL, 0, NULL, NULL))
  467. goto err;
  468. if (!HMAC_Update(hmac, prev, dig_len))
  469. goto err;
  470. }
  471. if (!HMAC_Update(hmac, info, info_len))
  472. goto err;
  473. if (!HMAC_Update(hmac, &ctr, 1))
  474. goto err;
  475. if (!HMAC_Final(hmac, prev, NULL))
  476. goto err;
  477. copy_len = (dig_len > okm_len - done_len) ?
  478. okm_len - done_len :
  479. dig_len;
  480. memcpy(okm + done_len, prev, copy_len);
  481. done_len += copy_len;
  482. }
  483. ret = 1;
  484. err:
  485. OPENSSL_cleanse(prev, sizeof(prev));
  486. HMAC_CTX_free(hmac);
  487. return ret;
  488. }
  489. /*
  490. * TLS uses slight variations of the above and for FIPS validation purposes,
  491. * they need to be present here.
  492. * Refer to RFC 8446 section 7 for specific details.
  493. */
  494. /*
  495. * Given a |secret|; a |label| of length |labellen|; and |data| of length
  496. * |datalen| (e.g. typically a hash of the handshake messages), derive a new
  497. * secret |outlen| bytes long and store it in the location pointed to be |out|.
  498. * The |data| value may be zero length. Returns 1 on success and 0 on failure.
  499. */
  500. static int prov_tls13_hkdf_expand(const EVP_MD *md,
  501. const unsigned char *key, size_t keylen,
  502. const unsigned char *prefix, size_t prefixlen,
  503. const unsigned char *label, size_t labellen,
  504. const unsigned char *data, size_t datalen,
  505. unsigned char *out, size_t outlen)
  506. {
  507. size_t hkdflabellen;
  508. unsigned char hkdflabel[HKDF_MAXBUF];
  509. WPACKET pkt;
  510. /*
  511. * 2 bytes for length of derived secret + 1 byte for length of combined
  512. * prefix and label + bytes for the label itself + 1 byte length of hash
  513. * + bytes for the hash itself. We've got the maximum the KDF can handle
  514. * which should always be sufficient.
  515. */
  516. if (!WPACKET_init_static_len(&pkt, hkdflabel, sizeof(hkdflabel), 0)
  517. || !WPACKET_put_bytes_u16(&pkt, outlen)
  518. || !WPACKET_start_sub_packet_u8(&pkt)
  519. || !WPACKET_memcpy(&pkt, prefix, prefixlen)
  520. || !WPACKET_memcpy(&pkt, label, labellen)
  521. || !WPACKET_close(&pkt)
  522. || !WPACKET_sub_memcpy_u8(&pkt, data, (data == NULL) ? 0 : datalen)
  523. || !WPACKET_get_total_written(&pkt, &hkdflabellen)
  524. || !WPACKET_finish(&pkt)) {
  525. WPACKET_cleanup(&pkt);
  526. return 0;
  527. }
  528. return HKDF_Expand(md, key, keylen, hkdflabel, hkdflabellen,
  529. out, outlen);
  530. }
  531. static int prov_tls13_hkdf_generate_secret(OSSL_LIB_CTX *libctx,
  532. const EVP_MD *md,
  533. const unsigned char *prevsecret,
  534. size_t prevsecretlen,
  535. const unsigned char *insecret,
  536. size_t insecretlen,
  537. const unsigned char *prefix,
  538. size_t prefixlen,
  539. const unsigned char *label,
  540. size_t labellen,
  541. unsigned char *out, size_t outlen)
  542. {
  543. size_t mdlen;
  544. int ret;
  545. unsigned char preextractsec[EVP_MAX_MD_SIZE];
  546. /* Always filled with zeros */
  547. static const unsigned char default_zeros[EVP_MAX_MD_SIZE];
  548. ret = EVP_MD_get_size(md);
  549. /* Ensure cast to size_t is safe */
  550. if (ret <= 0)
  551. return 0;
  552. mdlen = (size_t)ret;
  553. if (insecret == NULL) {
  554. insecret = default_zeros;
  555. insecretlen = mdlen;
  556. }
  557. if (prevsecret == NULL) {
  558. prevsecret = default_zeros;
  559. prevsecretlen = 0;
  560. } else {
  561. EVP_MD_CTX *mctx = EVP_MD_CTX_new();
  562. unsigned char hash[EVP_MAX_MD_SIZE];
  563. /* The pre-extract derive step uses a hash of no messages */
  564. if (mctx == NULL
  565. || EVP_DigestInit_ex(mctx, md, NULL) <= 0
  566. || EVP_DigestFinal_ex(mctx, hash, NULL) <= 0) {
  567. EVP_MD_CTX_free(mctx);
  568. return 0;
  569. }
  570. EVP_MD_CTX_free(mctx);
  571. /* Generate the pre-extract secret */
  572. if (!prov_tls13_hkdf_expand(md, prevsecret, mdlen,
  573. prefix, prefixlen, label, labellen,
  574. hash, mdlen, preextractsec, mdlen))
  575. return 0;
  576. prevsecret = preextractsec;
  577. prevsecretlen = mdlen;
  578. }
  579. ret = HKDF_Extract(libctx, md, prevsecret, prevsecretlen,
  580. insecret, insecretlen, out, outlen);
  581. if (prevsecret == preextractsec)
  582. OPENSSL_cleanse(preextractsec, mdlen);
  583. return ret;
  584. }
  585. static int kdf_tls1_3_derive(void *vctx, unsigned char *key, size_t keylen,
  586. const OSSL_PARAM params[])
  587. {
  588. KDF_HKDF *ctx = (KDF_HKDF *)vctx;
  589. const EVP_MD *md;
  590. if (!ossl_prov_is_running() || !kdf_tls1_3_set_ctx_params(ctx, params))
  591. return 0;
  592. md = ossl_prov_digest_md(&ctx->digest);
  593. if (md == NULL) {
  594. ERR_raise(ERR_LIB_PROV, PROV_R_MISSING_MESSAGE_DIGEST);
  595. return 0;
  596. }
  597. switch (ctx->mode) {
  598. default:
  599. return 0;
  600. case EVP_KDF_HKDF_MODE_EXTRACT_ONLY:
  601. return prov_tls13_hkdf_generate_secret(PROV_LIBCTX_OF(ctx->provctx),
  602. md,
  603. ctx->salt, ctx->salt_len,
  604. ctx->key, ctx->key_len,
  605. ctx->prefix, ctx->prefix_len,
  606. ctx->label, ctx->label_len,
  607. key, keylen);
  608. case EVP_KDF_HKDF_MODE_EXPAND_ONLY:
  609. return prov_tls13_hkdf_expand(md, ctx->key, ctx->key_len,
  610. ctx->prefix, ctx->prefix_len,
  611. ctx->label, ctx->label_len,
  612. ctx->data, ctx->data_len,
  613. key, keylen);
  614. }
  615. }
  616. static int kdf_tls1_3_set_ctx_params(void *vctx, const OSSL_PARAM params[])
  617. {
  618. const OSSL_PARAM *p;
  619. KDF_HKDF *ctx = vctx;
  620. if (params == NULL)
  621. return 1;
  622. if (!hkdf_common_set_ctx_params(ctx, params))
  623. return 0;
  624. if (ctx->mode == EVP_KDF_HKDF_MODE_EXTRACT_AND_EXPAND) {
  625. ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_MODE);
  626. return 0;
  627. }
  628. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_PREFIX)) != NULL) {
  629. OPENSSL_free(ctx->prefix);
  630. ctx->prefix = NULL;
  631. if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->prefix, 0,
  632. &ctx->prefix_len))
  633. return 0;
  634. }
  635. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_LABEL)) != NULL) {
  636. OPENSSL_free(ctx->label);
  637. ctx->label = NULL;
  638. if (!OSSL_PARAM_get_octet_string(p, (void **)&ctx->label, 0,
  639. &ctx->label_len))
  640. return 0;
  641. }
  642. OPENSSL_clear_free(ctx->data, ctx->data_len);
  643. ctx->data = NULL;
  644. if ((p = OSSL_PARAM_locate_const(params, OSSL_KDF_PARAM_DATA)) != NULL
  645. && !OSSL_PARAM_get_octet_string(p, (void **)&ctx->data, 0,
  646. &ctx->data_len))
  647. return 0;
  648. return 1;
  649. }
  650. static const OSSL_PARAM *kdf_tls1_3_settable_ctx_params(ossl_unused void *ctx,
  651. ossl_unused void *provctx)
  652. {
  653. static const OSSL_PARAM known_settable_ctx_params[] = {
  654. HKDF_COMMON_SETTABLES,
  655. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_PREFIX, NULL, 0),
  656. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_LABEL, NULL, 0),
  657. OSSL_PARAM_octet_string(OSSL_KDF_PARAM_DATA, NULL, 0),
  658. OSSL_PARAM_END
  659. };
  660. return known_settable_ctx_params;
  661. }
  662. const OSSL_DISPATCH ossl_kdf_tls1_3_kdf_functions[] = {
  663. { OSSL_FUNC_KDF_NEWCTX, (void(*)(void))kdf_hkdf_new },
  664. { OSSL_FUNC_KDF_DUPCTX, (void(*)(void))kdf_hkdf_dup },
  665. { OSSL_FUNC_KDF_FREECTX, (void(*)(void))kdf_hkdf_free },
  666. { OSSL_FUNC_KDF_RESET, (void(*)(void))kdf_hkdf_reset },
  667. { OSSL_FUNC_KDF_DERIVE, (void(*)(void))kdf_tls1_3_derive },
  668. { OSSL_FUNC_KDF_SETTABLE_CTX_PARAMS,
  669. (void(*)(void))kdf_tls1_3_settable_ctx_params },
  670. { OSSL_FUNC_KDF_SET_CTX_PARAMS, (void(*)(void))kdf_tls1_3_set_ctx_params },
  671. { OSSL_FUNC_KDF_GETTABLE_CTX_PARAMS,
  672. (void(*)(void))kdf_hkdf_gettable_ctx_params },
  673. { OSSL_FUNC_KDF_GET_CTX_PARAMS, (void(*)(void))kdf_hkdf_get_ctx_params },
  674. OSSL_DISPATCH_END
  675. };