blob: 631ac24e53049bd21beea3147eabc72c4b0e7bab [file] [log] [blame]
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001/*
2 * HKDF implementation -- RFC 5869
3 *
Jerome Forissier79013242021-07-28 10:24:04 +02004 * Copyright The Mbed TLS Contributors
Tom Van Eyckc1633172024-04-09 18:44:13 +02005 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jens Wiklander3d3b0592019-03-20 15:30:29 +01006 */
Jerome Forissier79013242021-07-28 10:24:04 +02007#include "common.h"
Jens Wiklander3d3b0592019-03-20 15:30:29 +01008
9#if defined(MBEDTLS_HKDF_C)
10
11#include <string.h>
12#include "mbedtls/hkdf.h"
13#include "mbedtls/platform_util.h"
Jerome Forissier11fa71b2020-04-20 17:17:56 +020014#include "mbedtls/error.h"
Jens Wiklander3d3b0592019-03-20 15:30:29 +010015
Jens Wiklander32b31802023-10-06 16:59:46 +020016int mbedtls_hkdf(const mbedtls_md_info_t *md, const unsigned char *salt,
17 size_t salt_len, const unsigned char *ikm, size_t ikm_len,
18 const unsigned char *info, size_t info_len,
19 unsigned char *okm, size_t okm_len)
Jens Wiklander3d3b0592019-03-20 15:30:29 +010020{
Jerome Forissier11fa71b2020-04-20 17:17:56 +020021 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +010022 unsigned char prk[MBEDTLS_MD_MAX_SIZE];
23
Jens Wiklander32b31802023-10-06 16:59:46 +020024 ret = mbedtls_hkdf_extract(md, salt, salt_len, ikm, ikm_len, prk);
Jens Wiklander3d3b0592019-03-20 15:30:29 +010025
Jens Wiklander32b31802023-10-06 16:59:46 +020026 if (ret == 0) {
27 ret = mbedtls_hkdf_expand(md, prk, mbedtls_md_get_size(md),
28 info, info_len, okm, okm_len);
Jens Wiklander3d3b0592019-03-20 15:30:29 +010029 }
30
Jens Wiklander32b31802023-10-06 16:59:46 +020031 mbedtls_platform_zeroize(prk, sizeof(prk));
Jens Wiklander3d3b0592019-03-20 15:30:29 +010032
Jens Wiklander32b31802023-10-06 16:59:46 +020033 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +010034}
35
Jens Wiklander32b31802023-10-06 16:59:46 +020036int mbedtls_hkdf_extract(const mbedtls_md_info_t *md,
37 const unsigned char *salt, size_t salt_len,
38 const unsigned char *ikm, size_t ikm_len,
39 unsigned char *prk)
Jens Wiklander3d3b0592019-03-20 15:30:29 +010040{
41 unsigned char null_salt[MBEDTLS_MD_MAX_SIZE] = { '\0' };
42
Jens Wiklander32b31802023-10-06 16:59:46 +020043 if (salt == NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +010044 size_t hash_len;
45
Jens Wiklander32b31802023-10-06 16:59:46 +020046 if (salt_len != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +010047 return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
48 }
49
Jens Wiklander32b31802023-10-06 16:59:46 +020050 hash_len = mbedtls_md_get_size(md);
Jens Wiklander3d3b0592019-03-20 15:30:29 +010051
Jens Wiklander32b31802023-10-06 16:59:46 +020052 if (hash_len == 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +010053 return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
54 }
55
56 salt = null_salt;
57 salt_len = hash_len;
58 }
59
Jens Wiklander32b31802023-10-06 16:59:46 +020060 return mbedtls_md_hmac(md, salt, salt_len, ikm, ikm_len, prk);
Jens Wiklander3d3b0592019-03-20 15:30:29 +010061}
62
Jens Wiklander32b31802023-10-06 16:59:46 +020063int mbedtls_hkdf_expand(const mbedtls_md_info_t *md, const unsigned char *prk,
64 size_t prk_len, const unsigned char *info,
65 size_t info_len, unsigned char *okm, size_t okm_len)
Jens Wiklander3d3b0592019-03-20 15:30:29 +010066{
67 size_t hash_len;
68 size_t where = 0;
69 size_t n;
70 size_t t_len = 0;
71 size_t i;
72 int ret = 0;
73 mbedtls_md_context_t ctx;
74 unsigned char t[MBEDTLS_MD_MAX_SIZE];
75
Jens Wiklander32b31802023-10-06 16:59:46 +020076 if (okm == NULL) {
77 return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +010078 }
79
Jens Wiklander32b31802023-10-06 16:59:46 +020080 hash_len = mbedtls_md_get_size(md);
Jens Wiklander3d3b0592019-03-20 15:30:29 +010081
Jens Wiklander32b31802023-10-06 16:59:46 +020082 if (prk_len < hash_len || hash_len == 0) {
83 return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +010084 }
85
Jens Wiklander32b31802023-10-06 16:59:46 +020086 if (info == NULL) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +010087 info = (const unsigned char *) "";
88 info_len = 0;
89 }
90
91 n = okm_len / hash_len;
92
Jens Wiklander32b31802023-10-06 16:59:46 +020093 if (okm_len % hash_len != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +010094 n++;
95 }
96
97 /*
98 * Per RFC 5869 Section 2.3, okm_len must not exceed
99 * 255 times the hash length
100 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200101 if (n > 255) {
102 return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100103 }
104
Jens Wiklander32b31802023-10-06 16:59:46 +0200105 mbedtls_md_init(&ctx);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100106
Jens Wiklander32b31802023-10-06 16:59:46 +0200107 if ((ret = mbedtls_md_setup(&ctx, md, 1)) != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100108 goto exit;
109 }
110
Jens Wiklander32b31802023-10-06 16:59:46 +0200111 memset(t, 0, hash_len);
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200112
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100113 /*
114 * Compute T = T(1) | T(2) | T(3) | ... | T(N)
115 * Where T(N) is defined in RFC 5869 Section 2.3
116 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200117 for (i = 1; i <= n; i++) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100118 size_t num_to_copy;
119 unsigned char c = i & 0xff;
120
Jens Wiklander32b31802023-10-06 16:59:46 +0200121 ret = mbedtls_md_hmac_starts(&ctx, prk, prk_len);
122 if (ret != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100123 goto exit;
124 }
125
Jens Wiklander32b31802023-10-06 16:59:46 +0200126 ret = mbedtls_md_hmac_update(&ctx, t, t_len);
127 if (ret != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100128 goto exit;
129 }
130
Jens Wiklander32b31802023-10-06 16:59:46 +0200131 ret = mbedtls_md_hmac_update(&ctx, info, info_len);
132 if (ret != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100133 goto exit;
134 }
135
136 /* The constant concatenated to the end of each T(n) is a single octet.
137 * */
Jens Wiklander32b31802023-10-06 16:59:46 +0200138 ret = mbedtls_md_hmac_update(&ctx, &c, 1);
139 if (ret != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100140 goto exit;
141 }
142
Jens Wiklander32b31802023-10-06 16:59:46 +0200143 ret = mbedtls_md_hmac_finish(&ctx, t);
144 if (ret != 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100145 goto exit;
146 }
147
148 num_to_copy = i != n ? hash_len : okm_len - where;
Jens Wiklander32b31802023-10-06 16:59:46 +0200149 memcpy(okm + where, t, num_to_copy);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100150 where += hash_len;
151 t_len = hash_len;
152 }
153
154exit:
Jens Wiklander32b31802023-10-06 16:59:46 +0200155 mbedtls_md_free(&ctx);
156 mbedtls_platform_zeroize(t, sizeof(t));
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100157
Jens Wiklander32b31802023-10-06 16:59:46 +0200158 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100159}
160
161#endif /* MBEDTLS_HKDF_C */