xref: /aosp_15_r20/external/mbedtls/library/hkdf.c (revision 62c56f9862f102b96d72393aff6076c951fb8148)
1*62c56f98SSadaf Ebrahimi /*
2*62c56f98SSadaf Ebrahimi  *  HKDF implementation -- RFC 5869
3*62c56f98SSadaf Ebrahimi  *
4*62c56f98SSadaf Ebrahimi  *  Copyright The Mbed TLS Contributors
5*62c56f98SSadaf Ebrahimi  *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
6*62c56f98SSadaf Ebrahimi  */
7*62c56f98SSadaf Ebrahimi #include "common.h"
8*62c56f98SSadaf Ebrahimi 
9*62c56f98SSadaf Ebrahimi #if defined(MBEDTLS_HKDF_C)
10*62c56f98SSadaf Ebrahimi 
11*62c56f98SSadaf Ebrahimi #include <string.h>
12*62c56f98SSadaf Ebrahimi #include "mbedtls/hkdf.h"
13*62c56f98SSadaf Ebrahimi #include "mbedtls/platform_util.h"
14*62c56f98SSadaf Ebrahimi #include "mbedtls/error.h"
15*62c56f98SSadaf Ebrahimi 
mbedtls_hkdf(const mbedtls_md_info_t * md,const unsigned char * salt,size_t salt_len,const unsigned char * ikm,size_t ikm_len,const unsigned char * info,size_t info_len,unsigned char * okm,size_t okm_len)16*62c56f98SSadaf Ebrahimi int mbedtls_hkdf(const mbedtls_md_info_t *md, const unsigned char *salt,
17*62c56f98SSadaf Ebrahimi                  size_t salt_len, const unsigned char *ikm, size_t ikm_len,
18*62c56f98SSadaf Ebrahimi                  const unsigned char *info, size_t info_len,
19*62c56f98SSadaf Ebrahimi                  unsigned char *okm, size_t okm_len)
20*62c56f98SSadaf Ebrahimi {
21*62c56f98SSadaf Ebrahimi     int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
22*62c56f98SSadaf Ebrahimi     unsigned char prk[MBEDTLS_MD_MAX_SIZE];
23*62c56f98SSadaf Ebrahimi 
24*62c56f98SSadaf Ebrahimi     ret = mbedtls_hkdf_extract(md, salt, salt_len, ikm, ikm_len, prk);
25*62c56f98SSadaf Ebrahimi 
26*62c56f98SSadaf Ebrahimi     if (ret == 0) {
27*62c56f98SSadaf Ebrahimi         ret = mbedtls_hkdf_expand(md, prk, mbedtls_md_get_size(md),
28*62c56f98SSadaf Ebrahimi                                   info, info_len, okm, okm_len);
29*62c56f98SSadaf Ebrahimi     }
30*62c56f98SSadaf Ebrahimi 
31*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(prk, sizeof(prk));
32*62c56f98SSadaf Ebrahimi 
33*62c56f98SSadaf Ebrahimi     return ret;
34*62c56f98SSadaf Ebrahimi }
35*62c56f98SSadaf Ebrahimi 
mbedtls_hkdf_extract(const mbedtls_md_info_t * md,const unsigned char * salt,size_t salt_len,const unsigned char * ikm,size_t ikm_len,unsigned char * prk)36*62c56f98SSadaf Ebrahimi int mbedtls_hkdf_extract(const mbedtls_md_info_t *md,
37*62c56f98SSadaf Ebrahimi                          const unsigned char *salt, size_t salt_len,
38*62c56f98SSadaf Ebrahimi                          const unsigned char *ikm, size_t ikm_len,
39*62c56f98SSadaf Ebrahimi                          unsigned char *prk)
40*62c56f98SSadaf Ebrahimi {
41*62c56f98SSadaf Ebrahimi     unsigned char null_salt[MBEDTLS_MD_MAX_SIZE] = { '\0' };
42*62c56f98SSadaf Ebrahimi 
43*62c56f98SSadaf Ebrahimi     if (salt == NULL) {
44*62c56f98SSadaf Ebrahimi         size_t hash_len;
45*62c56f98SSadaf Ebrahimi 
46*62c56f98SSadaf Ebrahimi         if (salt_len != 0) {
47*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
48*62c56f98SSadaf Ebrahimi         }
49*62c56f98SSadaf Ebrahimi 
50*62c56f98SSadaf Ebrahimi         hash_len = mbedtls_md_get_size(md);
51*62c56f98SSadaf Ebrahimi 
52*62c56f98SSadaf Ebrahimi         if (hash_len == 0) {
53*62c56f98SSadaf Ebrahimi             return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
54*62c56f98SSadaf Ebrahimi         }
55*62c56f98SSadaf Ebrahimi 
56*62c56f98SSadaf Ebrahimi         salt = null_salt;
57*62c56f98SSadaf Ebrahimi         salt_len = hash_len;
58*62c56f98SSadaf Ebrahimi     }
59*62c56f98SSadaf Ebrahimi 
60*62c56f98SSadaf Ebrahimi     return mbedtls_md_hmac(md, salt, salt_len, ikm, ikm_len, prk);
61*62c56f98SSadaf Ebrahimi }
62*62c56f98SSadaf Ebrahimi 
mbedtls_hkdf_expand(const mbedtls_md_info_t * md,const unsigned char * prk,size_t prk_len,const unsigned char * info,size_t info_len,unsigned char * okm,size_t okm_len)63*62c56f98SSadaf Ebrahimi int mbedtls_hkdf_expand(const mbedtls_md_info_t *md, const unsigned char *prk,
64*62c56f98SSadaf Ebrahimi                         size_t prk_len, const unsigned char *info,
65*62c56f98SSadaf Ebrahimi                         size_t info_len, unsigned char *okm, size_t okm_len)
66*62c56f98SSadaf Ebrahimi {
67*62c56f98SSadaf Ebrahimi     size_t hash_len;
68*62c56f98SSadaf Ebrahimi     size_t where = 0;
69*62c56f98SSadaf Ebrahimi     size_t n;
70*62c56f98SSadaf Ebrahimi     size_t t_len = 0;
71*62c56f98SSadaf Ebrahimi     size_t i;
72*62c56f98SSadaf Ebrahimi     int ret = 0;
73*62c56f98SSadaf Ebrahimi     mbedtls_md_context_t ctx;
74*62c56f98SSadaf Ebrahimi     unsigned char t[MBEDTLS_MD_MAX_SIZE];
75*62c56f98SSadaf Ebrahimi 
76*62c56f98SSadaf Ebrahimi     if (okm == NULL) {
77*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
78*62c56f98SSadaf Ebrahimi     }
79*62c56f98SSadaf Ebrahimi 
80*62c56f98SSadaf Ebrahimi     hash_len = mbedtls_md_get_size(md);
81*62c56f98SSadaf Ebrahimi 
82*62c56f98SSadaf Ebrahimi     if (prk_len < hash_len || hash_len == 0) {
83*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
84*62c56f98SSadaf Ebrahimi     }
85*62c56f98SSadaf Ebrahimi 
86*62c56f98SSadaf Ebrahimi     if (info == NULL) {
87*62c56f98SSadaf Ebrahimi         info = (const unsigned char *) "";
88*62c56f98SSadaf Ebrahimi         info_len = 0;
89*62c56f98SSadaf Ebrahimi     }
90*62c56f98SSadaf Ebrahimi 
91*62c56f98SSadaf Ebrahimi     n = okm_len / hash_len;
92*62c56f98SSadaf Ebrahimi 
93*62c56f98SSadaf Ebrahimi     if (okm_len % hash_len != 0) {
94*62c56f98SSadaf Ebrahimi         n++;
95*62c56f98SSadaf Ebrahimi     }
96*62c56f98SSadaf Ebrahimi 
97*62c56f98SSadaf Ebrahimi     /*
98*62c56f98SSadaf Ebrahimi      * Per RFC 5869 Section 2.3, okm_len must not exceed
99*62c56f98SSadaf Ebrahimi      * 255 times the hash length
100*62c56f98SSadaf Ebrahimi      */
101*62c56f98SSadaf Ebrahimi     if (n > 255) {
102*62c56f98SSadaf Ebrahimi         return MBEDTLS_ERR_HKDF_BAD_INPUT_DATA;
103*62c56f98SSadaf Ebrahimi     }
104*62c56f98SSadaf Ebrahimi 
105*62c56f98SSadaf Ebrahimi     mbedtls_md_init(&ctx);
106*62c56f98SSadaf Ebrahimi 
107*62c56f98SSadaf Ebrahimi     if ((ret = mbedtls_md_setup(&ctx, md, 1)) != 0) {
108*62c56f98SSadaf Ebrahimi         goto exit;
109*62c56f98SSadaf Ebrahimi     }
110*62c56f98SSadaf Ebrahimi 
111*62c56f98SSadaf Ebrahimi     memset(t, 0, hash_len);
112*62c56f98SSadaf Ebrahimi 
113*62c56f98SSadaf Ebrahimi     /*
114*62c56f98SSadaf Ebrahimi      * Compute T = T(1) | T(2) | T(3) | ... | T(N)
115*62c56f98SSadaf Ebrahimi      * Where T(N) is defined in RFC 5869 Section 2.3
116*62c56f98SSadaf Ebrahimi      */
117*62c56f98SSadaf Ebrahimi     for (i = 1; i <= n; i++) {
118*62c56f98SSadaf Ebrahimi         size_t num_to_copy;
119*62c56f98SSadaf Ebrahimi         unsigned char c = i & 0xff;
120*62c56f98SSadaf Ebrahimi 
121*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_starts(&ctx, prk, prk_len);
122*62c56f98SSadaf Ebrahimi         if (ret != 0) {
123*62c56f98SSadaf Ebrahimi             goto exit;
124*62c56f98SSadaf Ebrahimi         }
125*62c56f98SSadaf Ebrahimi 
126*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_update(&ctx, t, t_len);
127*62c56f98SSadaf Ebrahimi         if (ret != 0) {
128*62c56f98SSadaf Ebrahimi             goto exit;
129*62c56f98SSadaf Ebrahimi         }
130*62c56f98SSadaf Ebrahimi 
131*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_update(&ctx, info, info_len);
132*62c56f98SSadaf Ebrahimi         if (ret != 0) {
133*62c56f98SSadaf Ebrahimi             goto exit;
134*62c56f98SSadaf Ebrahimi         }
135*62c56f98SSadaf Ebrahimi 
136*62c56f98SSadaf Ebrahimi         /* The constant concatenated to the end of each T(n) is a single octet.
137*62c56f98SSadaf Ebrahimi          * */
138*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_update(&ctx, &c, 1);
139*62c56f98SSadaf Ebrahimi         if (ret != 0) {
140*62c56f98SSadaf Ebrahimi             goto exit;
141*62c56f98SSadaf Ebrahimi         }
142*62c56f98SSadaf Ebrahimi 
143*62c56f98SSadaf Ebrahimi         ret = mbedtls_md_hmac_finish(&ctx, t);
144*62c56f98SSadaf Ebrahimi         if (ret != 0) {
145*62c56f98SSadaf Ebrahimi             goto exit;
146*62c56f98SSadaf Ebrahimi         }
147*62c56f98SSadaf Ebrahimi 
148*62c56f98SSadaf Ebrahimi         num_to_copy = i != n ? hash_len : okm_len - where;
149*62c56f98SSadaf Ebrahimi         memcpy(okm + where, t, num_to_copy);
150*62c56f98SSadaf Ebrahimi         where += hash_len;
151*62c56f98SSadaf Ebrahimi         t_len = hash_len;
152*62c56f98SSadaf Ebrahimi     }
153*62c56f98SSadaf Ebrahimi 
154*62c56f98SSadaf Ebrahimi exit:
155*62c56f98SSadaf Ebrahimi     mbedtls_md_free(&ctx);
156*62c56f98SSadaf Ebrahimi     mbedtls_platform_zeroize(t, sizeof(t));
157*62c56f98SSadaf Ebrahimi 
158*62c56f98SSadaf Ebrahimi     return ret;
159*62c56f98SSadaf Ebrahimi }
160*62c56f98SSadaf Ebrahimi 
161*62c56f98SSadaf Ebrahimi #endif /* MBEDTLS_HKDF_C */
162