blob: d094ea77b69b9ed411fe2c510fe8835a3b87ef3c [file] [log] [blame]
Fabio Utzigba829042018-09-18 08:29:34 -03001/*
David Brownaac71112020-02-03 16:13:42 -07002 * SPDX-License-Identifier: Apache-2.0
Fabio Utzigba829042018-09-18 08:29:34 -03003 *
David Brownaac71112020-02-03 16:13:42 -07004 * Copyright (c) 2018-2019 JUUL Labs
David Vincze2a7565b2024-07-25 17:14:28 +02005 * Copyright (c) 2019-2024 Arm Limited
Fabio Utzigba829042018-09-18 08:29:34 -03006 */
7
8#include "mcuboot_config/mcuboot_config.h"
9
10#if defined(MCUBOOT_ENC_IMAGES)
Fabio Utzigba829042018-09-18 08:29:34 -030011#include <stddef.h>
12#include <inttypes.h>
13#include <string.h>
14
Fabio Utzigba829042018-09-18 08:29:34 -030015#if defined(MCUBOOT_ENCRYPT_RSA)
Antonio de Angelis02bf0722022-11-22 15:35:43 +000016#define BOOTUTIL_CRYPTO_RSA_CRYPT_ENABLED
17#include "bootutil/crypto/rsa.h"
Fabio Utzigba829042018-09-18 08:29:34 -030018#endif
19
20#if defined(MCUBOOT_ENCRYPT_KW)
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090021#include "bootutil/crypto/aes_kw.h"
Fabio Utzigba829042018-09-18 08:29:34 -030022#endif
23
Fabio Utzig5fde8322019-10-23 12:23:08 -030024#if defined(MCUBOOT_ENCRYPT_EC256)
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090025#include "bootutil/crypto/ecdh_p256.h"
26#endif
27
28#if defined(MCUBOOT_ENCRYPT_X25519)
29#include "bootutil/crypto/ecdh_x25519.h"
Fabio Utzig6aec6ae2020-04-02 11:06:07 -030030#endif
31
32#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
Roland Mikhel03c9ad02023-03-08 15:56:43 +010033#include "bootutil/crypto/sha.h"
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090034#include "bootutil/crypto/hmac_sha256.h"
Fabio Utzig5fde8322019-10-23 12:23:08 -030035#include "mbedtls/oid.h"
36#include "mbedtls/asn1.h"
37#endif
38
Fabio Utzigba829042018-09-18 08:29:34 -030039#include "bootutil/image.h"
40#include "bootutil/enc_key.h"
41#include "bootutil/sign_key.h"
Sherry Zhangb111f982021-07-13 17:11:47 +080042#include "bootutil/crypto/common.h"
Fabio Utzigba829042018-09-18 08:29:34 -030043
44#include "bootutil_priv.h"
45
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090046#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
47#if defined(_compare)
48static inline int bootutil_constant_time_compare(const uint8_t *a, const uint8_t *b, size_t size)
49{
50 return _compare(a, b, size);
51}
52#else
53static int bootutil_constant_time_compare(const uint8_t *a, const uint8_t *b, size_t size)
54{
55 const uint8_t *tempa = a;
56 const uint8_t *tempb = b;
57 uint8_t result = 0;
58 unsigned int i;
59
60 for (i = 0; i < size; i++) {
61 result |= tempa[i] ^ tempb[i];
62 }
63 return result;
64}
65#endif
66#endif
67
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020068#if defined(MCUBOOT_ENCRYPT_KW)
Fabio Utzig6ace9ee2019-08-19 11:11:07 -030069static int
David Vincze0e5e1a92024-07-26 11:04:47 +020070key_unwrap(const uint8_t *wrapped, uint8_t *enckey, struct bootutil_key *bootutil_enc_key)
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020071{
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090072 bootutil_aes_kw_context aes_kw;
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020073 int rc;
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020074
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090075 bootutil_aes_kw_init(&aes_kw);
David Vincze0e5e1a92024-07-26 11:04:47 +020076 rc = bootutil_aes_kw_set_unwrap_key(&aes_kw, bootutil_enc_key->key, *bootutil_enc_key->len);
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090077 if (rc != 0) {
78 goto done;
79 }
80 rc = bootutil_aes_kw_unwrap(&aes_kw, wrapped, TLV_ENC_KW_SZ, enckey, BOOT_ENC_KEY_SIZE);
81 if (rc != 0) {
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020082 goto done;
83 }
84
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020085done:
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090086 bootutil_aes_kw_drop(&aes_kw);
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020087 return rc;
88}
Fabio Utzig38f5ffe2018-12-27 16:12:58 -020089#endif /* MCUBOOT_ENCRYPT_KW */
90
Fabio Utzig5fde8322019-10-23 12:23:08 -030091#if defined(MCUBOOT_ENCRYPT_EC256)
92static const uint8_t ec_pubkey_oid[] = MBEDTLS_OID_EC_ALG_UNRESTRICTED;
93static const uint8_t ec_secp256r1_oid[] = MBEDTLS_OID_EC_GRP_SECP256R1;
94
Fabio Utzig6aec6ae2020-04-02 11:06:07 -030095#define SHARED_KEY_LEN NUM_ECC_BYTES
96#define PRIV_KEY_LEN NUM_ECC_BYTES
97
Fabio Utzig5fde8322019-10-23 12:23:08 -030098/*
99 * Parses the output of `imgtool keygen`, which produces a PKCS#8 elliptic
100 * curve keypair. See RFC5208 and RFC5915.
101 */
102static int
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900103parse_ec256_enckey(uint8_t **p, uint8_t *end, uint8_t *private_key)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300104{
105 int rc;
106 size_t len;
107 int version;
108 mbedtls_asn1_buf alg;
109 mbedtls_asn1_buf param;
110
111 if ((rc = mbedtls_asn1_get_tag(p, end, &len,
112 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
113 return -1;
114 }
115
116 if (*p + len != end) {
117 return -2;
118 }
119
120 version = 0;
121 if (mbedtls_asn1_get_int(p, end, &version) || version != 0) {
122 return -3;
123 }
124
125 if ((rc = mbedtls_asn1_get_alg(p, end, &alg, &param)) != 0) {
126 return -5;
127 }
128
David Brown1d79ef32024-06-27 11:13:01 -0600129 if (alg.ASN1_CONTEXT_MEMBER(len) != sizeof(ec_pubkey_oid) - 1 ||
130 memcmp(alg.ASN1_CONTEXT_MEMBER(p), ec_pubkey_oid, sizeof(ec_pubkey_oid) - 1)) {
Fabio Utzig5fde8322019-10-23 12:23:08 -0300131 return -6;
132 }
David Brown1d79ef32024-06-27 11:13:01 -0600133 if (param.ASN1_CONTEXT_MEMBER(len) != sizeof(ec_secp256r1_oid) - 1 ||
134 memcmp(param.ASN1_CONTEXT_MEMBER(p), ec_secp256r1_oid, sizeof(ec_secp256r1_oid) - 1)) {
Fabio Utzig5fde8322019-10-23 12:23:08 -0300135 return -7;
136 }
137
138 if ((rc = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
139 return -8;
140 }
141
142 /* RFC5915 - ECPrivateKey */
143
144 if ((rc = mbedtls_asn1_get_tag(p, end, &len,
145 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
146 return -9;
147 }
148
149 version = 0;
150 if (mbedtls_asn1_get_int(p, end, &version) || version != 1) {
151 return -10;
152 }
153
154 /* privateKey */
155
156 if ((rc = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
157 return -11;
158 }
159
160 if (len != NUM_ECC_BYTES) {
161 return -12;
162 }
163
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900164 memcpy(private_key, *p, len);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300165
166 /* publicKey usually follows but is not parsed here */
167
168 return 0;
169}
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300170#endif /* defined(MCUBOOT_ENCRYPT_EC256) */
Fabio Utzig5fde8322019-10-23 12:23:08 -0300171
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300172#if defined(MCUBOOT_ENCRYPT_X25519)
173#define X25519_OID "\x6e"
174static const uint8_t ec_pubkey_oid[] = MBEDTLS_OID_ISO_IDENTIFIED_ORG \
175 MBEDTLS_OID_ORG_GOV X25519_OID;
176
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300177#define SHARED_KEY_LEN 32
178#define PRIV_KEY_LEN 32
179
180static int
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900181parse_x25519_enckey(uint8_t **p, uint8_t *end, uint8_t *private_key)
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300182{
183 size_t len;
184 int version;
185 mbedtls_asn1_buf alg;
186 mbedtls_asn1_buf param;
187
188 if (mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_CONSTRUCTED |
189 MBEDTLS_ASN1_SEQUENCE) != 0) {
190 return -1;
191 }
192
193 if (*p + len != end) {
194 return -2;
195 }
196
197 version = 0;
198 if (mbedtls_asn1_get_int(p, end, &version) || version != 0) {
199 return -3;
200 }
201
202 if (mbedtls_asn1_get_alg(p, end, &alg, &param) != 0) {
203 return -4;
204 }
205
David Brown1d79ef32024-06-27 11:13:01 -0600206 if (alg.ASN1_CONTEXT_MEMBER(len) != sizeof(ec_pubkey_oid) - 1 ||
207 memcmp(alg.ASN1_CONTEXT_MEMBER(p), ec_pubkey_oid, sizeof(ec_pubkey_oid) - 1)) {
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300208 return -5;
209 }
210
211 if (mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING) != 0) {
212 return -6;
213 }
214
215 if (mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING) != 0) {
216 return -7;
217 }
218
219 if (len != PRIV_KEY_LEN) {
220 return -8;
221 }
222
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900223 memcpy(private_key, *p, PRIV_KEY_LEN);
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300224 return 0;
225}
226#endif /* defined(MCUBOOT_ENCRYPT_X25519) */
227
228#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300229/*
230 * HKDF as described by RFC5869.
231 *
232 * @param ikm The input data to be derived.
233 * @param ikm_len Length of the input data.
234 * @param info An information tag.
235 * @param info_len Length of the information tag.
236 * @param okm Output of the KDF computation.
237 * @param okm_len On input the requested length; on output the generated length
238 */
239static int
240hkdf(uint8_t *ikm, uint16_t ikm_len, uint8_t *info, uint16_t info_len,
241 uint8_t *okm, uint16_t *okm_len)
242{
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900243 bootutil_hmac_sha256_context hmac;
244 uint8_t salt[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
245 uint8_t prk[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
246 uint8_t T[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
Fabio Utzig5fde8322019-10-23 12:23:08 -0300247 uint16_t off;
248 uint16_t len;
249 uint8_t counter;
250 bool first;
251 int rc;
252
253 /*
254 * Extract
255 */
256
257 if (ikm == NULL || okm == NULL || ikm_len == 0) {
258 return -1;
259 }
260
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900261 bootutil_hmac_sha256_init(&hmac);
262
263 memset(salt, 0, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
264 rc = bootutil_hmac_sha256_set_key(&hmac, salt, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
265 if (rc != 0) {
266 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300267 }
268
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900269 rc = bootutil_hmac_sha256_update(&hmac, ikm, ikm_len);
270 if (rc != 0) {
271 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300272 }
273
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900274 rc = bootutil_hmac_sha256_finish(&hmac, prk, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
275 if (rc != 0) {
276 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300277 }
278
Thomas Altenbach73315f72024-04-04 13:46:38 +0200279 bootutil_hmac_sha256_drop(&hmac);
280
Fabio Utzig5fde8322019-10-23 12:23:08 -0300281 /*
282 * Expand
283 */
284
285 len = *okm_len;
286 counter = 1;
287 first = true;
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900288 for (off = 0; len > 0; off += BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE, ++counter) {
289 bootutil_hmac_sha256_init(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300290
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900291 rc = bootutil_hmac_sha256_set_key(&hmac, prk, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
292 if (rc != 0) {
293 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300294 }
295
296 if (first) {
297 first = false;
298 } else {
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900299 rc = bootutil_hmac_sha256_update(&hmac, T, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
300 if (rc != 0) {
301 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300302 }
303 }
304
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900305 rc = bootutil_hmac_sha256_update(&hmac, info, info_len);
306 if (rc != 0) {
307 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300308 }
309
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900310 rc = bootutil_hmac_sha256_update(&hmac, &counter, 1);
311 if (rc != 0) {
312 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300313 }
314
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900315 rc = bootutil_hmac_sha256_finish(&hmac, T, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
316 if (rc != 0) {
317 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300318 }
319
Thomas Altenbach73315f72024-04-04 13:46:38 +0200320 bootutil_hmac_sha256_drop(&hmac);
321
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900322 if (len > BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE) {
323 memcpy(&okm[off], T, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
324 len -= BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300325 } else {
326 memcpy(&okm[off], T, len);
327 len = 0;
328 }
329 }
330
331 return 0;
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900332
333error:
334 bootutil_hmac_sha256_drop(&hmac);
335 return -1;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300336}
David Vincze2a7565b2024-07-25 17:14:28 +0200337#endif /* MCUBOOT_ENCRYPT_EC256 || MCUBOOT_ENCRYPT_X25519 */
338
David Vincze6071ceb2024-08-15 16:41:08 +0200339#if !defined(MCUBOOT_ENC_BUILTIN_KEY)
David Vincze2a7565b2024-07-25 17:14:28 +0200340extern const struct bootutil_key bootutil_enc_key;
341
342/*
343 * Default implementation to retrieve the private encryption key which is
David Vincze6071ceb2024-08-15 16:41:08 +0200344 * embedded in the bootloader code (when MCUBOOT_ENC_BUILTIN_KEY is not defined).
David Vincze2a7565b2024-07-25 17:14:28 +0200345 */
346int boot_enc_retrieve_private_key(struct bootutil_key **private_key)
347{
348 *private_key = (struct bootutil_key *)&bootutil_enc_key;
349
350 return 0;
351}
David Vincze6071ceb2024-08-15 16:41:08 +0200352#endif /* !MCUBOOT_ENC_BUILTIN_KEY */
Fabio Utzig5fde8322019-10-23 12:23:08 -0300353
Fabio Utzigba829042018-09-18 08:29:34 -0300354int
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900355boot_enc_init(struct enc_key_data *enc_state, uint8_t slot)
356{
357 bootutil_aes_ctr_init(&enc_state[slot].aes_ctr);
358 return 0;
359}
360
361int
362boot_enc_drop(struct enc_key_data *enc_state, uint8_t slot)
363{
364 bootutil_aes_ctr_drop(&enc_state[slot].aes_ctr);
Dominik Ermel33557352024-07-17 12:11:55 +0000365 enc_state[slot].valid = 0;
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900366 return 0;
367}
368
369int
Fabio Utzig4741c452019-12-19 15:32:41 -0300370boot_enc_set_key(struct enc_key_data *enc_state, uint8_t slot,
371 const struct boot_status *bs)
Fabio Utzigba829042018-09-18 08:29:34 -0300372{
373 int rc;
374
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900375 rc = bootutil_aes_ctr_set_key(&enc_state[slot].aes_ctr, bs->enckey[slot]);
376 if (rc != 0) {
377 boot_enc_drop(enc_state, slot);
Fabio Utzigba829042018-09-18 08:29:34 -0300378 return -1;
379 }
380
381 enc_state[slot].valid = 1;
382
383 return 0;
384}
385
Fabio Utzig4741c452019-12-19 15:32:41 -0300386#define EXPECTED_ENC_LEN BOOT_ENC_TLV_SIZE
387
Fabio Utzigba829042018-09-18 08:29:34 -0300388#if defined(MCUBOOT_ENCRYPT_RSA)
389# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_RSA2048
Fabio Utzigba829042018-09-18 08:29:34 -0300390#elif defined(MCUBOOT_ENCRYPT_KW)
Salome Thirot0f641972021-05-14 11:19:55 +0100391# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_KW
Fabio Utzig5fde8322019-10-23 12:23:08 -0300392#elif defined(MCUBOOT_ENCRYPT_EC256)
393# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_EC256
Bohdan Kovalchuk25c7a0f2020-11-30 21:32:14 +0200394# define EC_PUBK_INDEX (0)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300395# define EC_TAG_INDEX (65)
396# define EC_CIPHERKEY_INDEX (65 + 32)
Salome Thirot0f641972021-05-14 11:19:55 +0100397_Static_assert(EC_CIPHERKEY_INDEX + BOOT_ENC_KEY_SIZE == EXPECTED_ENC_LEN,
Fabio Utzig4741c452019-12-19 15:32:41 -0300398 "Please fix ECIES-P256 component indexes");
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300399#elif defined(MCUBOOT_ENCRYPT_X25519)
400# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_X25519
401# define EC_PUBK_INDEX (0)
402# define EC_TAG_INDEX (32)
403# define EC_CIPHERKEY_INDEX (32 + 32)
Salome Thirot0f641972021-05-14 11:19:55 +0100404_Static_assert(EC_CIPHERKEY_INDEX + BOOT_ENC_KEY_SIZE == EXPECTED_ENC_LEN,
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300405 "Please fix ECIES-X25519 component indexes");
Fabio Utzigba829042018-09-18 08:29:34 -0300406#endif
407
Antonio de Angelis02bf0722022-11-22 15:35:43 +0000408#if ( (defined(MCUBOOT_ENCRYPT_RSA) && defined(MCUBOOT_USE_MBED_TLS) && !defined(MCUBOOT_USE_PSA_CRYPTO)) || \
409 (defined(MCUBOOT_ENCRYPT_EC256) && defined(MCUBOOT_USE_MBED_TLS)) )
Sherry Zhangb111f982021-07-13 17:11:47 +0800410#if MBEDTLS_VERSION_NUMBER >= 0x03000000
411static int fake_rng(void *p_rng, unsigned char *output, size_t len)
412{
413 size_t i;
414
415 (void)p_rng;
416 for (i = 0; i < len; i++) {
417 output[i] = (char)i;
418 }
419
420 return 0;
421}
Antonio de Angelis02bf0722022-11-22 15:35:43 +0000422#endif /* MBEDTLS_VERSION_NUMBER */
423#endif /* (MCUBOOT_ENCRYPT_RSA && MCUBOOT_USE_MBED_TLS && !MCUBOOT_USE_PSA_CRYPTO) ||
424 (MCUBOOT_ENCRYPT_EC256 && MCUBOOT_USE_MBED_TLS) */
Sherry Zhangb111f982021-07-13 17:11:47 +0800425
Fabio Utzigba829042018-09-18 08:29:34 -0300426/*
Fabio Utzig4741c452019-12-19 15:32:41 -0300427 * Decrypt an encryption key TLV.
428 *
429 * @param buf An encryption TLV read from flash (build time fixed length)
Salome Thirot0f641972021-05-14 11:19:55 +0100430 * @param enckey An AES-128 or AES-256 key sized buffer to store to plain key.
Fabio Utzigba829042018-09-18 08:29:34 -0300431 */
432int
Dominik Ermel2371c0a2024-07-12 17:43:13 +0000433boot_decrypt_key(const uint8_t *buf, uint8_t *enckey)
Fabio Utzigba829042018-09-18 08:29:34 -0300434{
435#if defined(MCUBOOT_ENCRYPT_RSA)
Antonio de Angelis02bf0722022-11-22 15:35:43 +0000436 bootutil_rsa_context rsa;
Fabio Utzigba829042018-09-18 08:29:34 -0300437 uint8_t *cp;
438 uint8_t *cpend;
Fabio Utzigba829042018-09-18 08:29:34 -0300439 size_t olen;
Fabio Utzig38f5ffe2018-12-27 16:12:58 -0200440#endif
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900441#if defined(MCUBOOT_ENCRYPT_EC256)
442 bootutil_ecdh_p256_context ecdh_p256;
443#endif
444#if defined(MCUBOOT_ENCRYPT_X25519)
445 bootutil_ecdh_x25519_context ecdh_x25519;
446#endif
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300447#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900448 bootutil_hmac_sha256_context hmac;
449 bootutil_aes_ctr_context aes_ctr;
450 uint8_t tag[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300451 uint8_t shared[SHARED_KEY_LEN];
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900452 uint8_t derived_key[BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE + BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
Fabio Utzig5fde8322019-10-23 12:23:08 -0300453 uint8_t *cp;
454 uint8_t *cpend;
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900455 uint8_t private_key[PRIV_KEY_LEN];
456 uint8_t counter[BOOTUTIL_CRYPTO_AES_CTR_BLOCK_SIZE];
Fabio Utzig61fd8882019-09-14 20:00:20 -0300457 uint16_t len;
Fabio Utzig4741c452019-12-19 15:32:41 -0300458#endif
David Vincze0e5e1a92024-07-26 11:04:47 +0200459 struct bootutil_key *bootutil_enc_key = NULL;
Fabio Utzig4741c452019-12-19 15:32:41 -0300460 int rc = -1;
Fabio Utzigba829042018-09-18 08:29:34 -0300461
David Vincze0e5e1a92024-07-26 11:04:47 +0200462 rc = boot_enc_retrieve_private_key(&bootutil_enc_key);
463 if (rc) {
464 return rc;
465 }
466
467 if (bootutil_enc_key == NULL) {
468 return rc;
469 }
470
Fabio Utzigba829042018-09-18 08:29:34 -0300471#if defined(MCUBOOT_ENCRYPT_RSA)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300472
Antonio de Angelis02bf0722022-11-22 15:35:43 +0000473 bootutil_rsa_init(&rsa);
David Vincze0e5e1a92024-07-26 11:04:47 +0200474 cp = (uint8_t *)bootutil_enc_key->key;
475 cpend = cp + *bootutil_enc_key->len;
Fabio Utzigba829042018-09-18 08:29:34 -0300476
Antonio de Angelis02bf0722022-11-22 15:35:43 +0000477 /* The enckey is encrypted through RSA so for decryption we need the private key */
478 rc = bootutil_rsa_parse_private_key(&rsa, &cp, cpend);
Fabio Utzig233af7d2019-08-26 12:06:16 -0300479 if (rc) {
Antonio de Angelis02bf0722022-11-22 15:35:43 +0000480 bootutil_rsa_drop(&rsa);
Fabio Utzig233af7d2019-08-26 12:06:16 -0300481 return rc;
482 }
Antonio de Angelis02bf0722022-11-22 15:35:43 +0000483
484 rc = bootutil_rsa_oaep_decrypt(&rsa, &olen, buf, enckey, BOOT_ENC_KEY_SIZE);
485 bootutil_rsa_drop(&rsa);
486 if (rc) {
487 return rc;
488 }
Fabio Utzigba829042018-09-18 08:29:34 -0300489
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300490#endif /* defined(MCUBOOT_ENCRYPT_RSA) */
491
492#if defined(MCUBOOT_ENCRYPT_KW)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300493
David Vincze0e5e1a92024-07-26 11:04:47 +0200494 assert(*bootutil_enc_key->len == BOOT_ENC_KEY_SIZE);
495 rc = key_unwrap(buf, enckey, bootutil_enc_key);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300496
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300497#endif /* defined(MCUBOOT_ENCRYPT_KW) */
498
499#if defined(MCUBOOT_ENCRYPT_EC256)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300500
David Vincze0e5e1a92024-07-26 11:04:47 +0200501 cp = (uint8_t *)bootutil_enc_key->key;
502 cpend = cp + *bootutil_enc_key->len;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300503
504 /*
505 * Load the stored EC256 decryption private key
506 */
507
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900508 rc = parse_ec256_enckey(&cp, cpend, private_key);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300509 if (rc) {
510 return rc;
511 }
512
Fabio Utzig5fde8322019-10-23 12:23:08 -0300513 /*
514 * First "element" in the TLV is the curve point (public key)
515 */
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900516 bootutil_ecdh_p256_init(&ecdh_p256);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300517
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900518 rc = bootutil_ecdh_p256_shared_secret(&ecdh_p256, &buf[EC_PUBK_INDEX], private_key, shared);
519 bootutil_ecdh_p256_drop(&ecdh_p256);
520 if (rc != 0) {
Fabio Utzig5fde8322019-10-23 12:23:08 -0300521 return -1;
522 }
523
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300524#endif /* defined(MCUBOOT_ENCRYPT_EC256) */
525
526#if defined(MCUBOOT_ENCRYPT_X25519)
527
David Vincze0e5e1a92024-07-26 11:04:47 +0200528 cp = (uint8_t *)bootutil_enc_key->key;
529 cpend = cp + *bootutil_enc_key->len;
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300530
531 /*
532 * Load the stored X25519 decryption private key
533 */
534
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900535 rc = parse_x25519_enckey(&cp, cpend, private_key);
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300536 if (rc) {
537 return rc;
538 }
539
540 /*
541 * First "element" in the TLV is the curve point (public key)
542 */
543
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900544 bootutil_ecdh_x25519_init(&ecdh_x25519);
545
546 rc = bootutil_ecdh_x25519_shared_secret(&ecdh_x25519, &buf[EC_PUBK_INDEX], private_key, shared);
547 bootutil_ecdh_x25519_drop(&ecdh_x25519);
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300548 if (!rc) {
549 return -1;
550 }
551
552#endif /* defined(MCUBOOT_ENCRYPT_X25519) */
553
554#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
555
Fabio Utzig5fde8322019-10-23 12:23:08 -0300556 /*
557 * Expand shared secret to create keys for AES-128-CTR + HMAC-SHA256
558 */
559
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900560 len = BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE + BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE;
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300561 rc = hkdf(shared, SHARED_KEY_LEN, (uint8_t *)"MCUBoot_ECIES_v1", 16,
Fabio Utzig5fde8322019-10-23 12:23:08 -0300562 derived_key, &len);
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900563 if (rc != 0 || len != (BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE + BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE)) {
Fabio Utzig5fde8322019-10-23 12:23:08 -0300564 return -1;
565 }
566
567 /*
568 * HMAC the key and check that our received MAC matches the generated tag
569 */
570
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900571 bootutil_hmac_sha256_init(&hmac);
572
Salome Thirot0f641972021-05-14 11:19:55 +0100573 rc = bootutil_hmac_sha256_set_key(&hmac, &derived_key[BOOT_ENC_KEY_SIZE], 32);
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900574 if (rc != 0) {
575 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300576 return -1;
577 }
578
Salome Thirot0f641972021-05-14 11:19:55 +0100579 rc = bootutil_hmac_sha256_update(&hmac, &buf[EC_CIPHERKEY_INDEX], BOOT_ENC_KEY_SIZE);
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900580 if (rc != 0) {
581 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300582 return -1;
583 }
584
Bohdan Kovalchuk25c7a0f2020-11-30 21:32:14 +0200585 /* Assumes the tag buffer is at least sizeof(hmac_tag_size(state)) bytes */
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900586 rc = bootutil_hmac_sha256_finish(&hmac, tag, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
587 if (rc != 0) {
588 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300589 return -1;
590 }
591
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900592 if (bootutil_constant_time_compare(tag, &buf[EC_TAG_INDEX], 32) != 0) {
593 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300594 return -1;
595 }
596
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900597 bootutil_hmac_sha256_drop(&hmac);
598
Fabio Utzig5fde8322019-10-23 12:23:08 -0300599 /*
600 * Finally decrypt the received ciphered key
601 */
602
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900603 bootutil_aes_ctr_init(&aes_ctr);
604 if (rc != 0) {
605 bootutil_aes_ctr_drop(&aes_ctr);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300606 return -1;
607 }
608
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900609 rc = bootutil_aes_ctr_set_key(&aes_ctr, derived_key);
610 if (rc != 0) {
611 bootutil_aes_ctr_drop(&aes_ctr);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300612 return -1;
613 }
614
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900615 memset(counter, 0, BOOTUTIL_CRYPTO_AES_CTR_BLOCK_SIZE);
616 rc = bootutil_aes_ctr_decrypt(&aes_ctr, counter, &buf[EC_CIPHERKEY_INDEX], BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE, 0, enckey);
617 if (rc != 0) {
618 bootutil_aes_ctr_drop(&aes_ctr);
619 return -1;
620 }
621
622 bootutil_aes_ctr_drop(&aes_ctr);
623
Fabio Utzig5fde8322019-10-23 12:23:08 -0300624 rc = 0;
625
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300626#endif /* defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519) */
Fabio Utzigba829042018-09-18 08:29:34 -0300627
Fabio Utzigba829042018-09-18 08:29:34 -0300628 return rc;
629}
630
Fabio Utzig4741c452019-12-19 15:32:41 -0300631/*
632 * Load encryption key.
633 */
634int
Dominik Ermel7f9ac972024-07-12 19:21:40 +0000635boot_enc_load(struct enc_key_data *enc_state, int slot,
Fabio Utzig4741c452019-12-19 15:32:41 -0300636 const struct image_header *hdr, const struct flash_area *fap,
637 struct boot_status *bs)
638{
639 uint32_t off;
640 uint16_t len;
641 struct image_tlv_iter it;
642#if MCUBOOT_SWAP_SAVE_ENCTLV
643 uint8_t *buf;
644#else
645 uint8_t buf[EXPECTED_ENC_LEN];
646#endif
Fabio Utzig4741c452019-12-19 15:32:41 -0300647 int rc;
648
Fabio Utzig4741c452019-12-19 15:32:41 -0300649 /* Already loaded... */
650 if (enc_state[slot].valid) {
651 return 1;
652 }
653
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900654 /* Initialize the AES context */
655 boot_enc_init(enc_state, slot);
656
Fabio Utzig4741c452019-12-19 15:32:41 -0300657 rc = bootutil_tlv_iter_begin(&it, hdr, fap, EXPECTED_ENC_TLV, false);
658 if (rc) {
659 return -1;
660 }
661
662 rc = bootutil_tlv_iter_next(&it, &off, &len, NULL);
663 if (rc != 0) {
664 return rc;
665 }
666
667 if (len != EXPECTED_ENC_LEN) {
668 return -1;
669 }
670
671#if MCUBOOT_SWAP_SAVE_ENCTLV
672 buf = bs->enctlv[slot];
673 memset(buf, 0xff, BOOT_ENC_TLV_ALIGN_SIZE);
674#endif
675
676 rc = flash_area_read(fap, off, buf, EXPECTED_ENC_LEN);
677 if (rc) {
678 return -1;
679 }
680
Dominik Ermel2371c0a2024-07-12 17:43:13 +0000681 return boot_decrypt_key(buf, bs->enckey[slot]);
Fabio Utzig4741c452019-12-19 15:32:41 -0300682}
683
Andrzej Puzdrowskicf97dd02019-03-14 15:10:10 +0100684bool
Dominik Ermel956311d2024-07-12 19:53:24 +0000685boot_enc_valid(struct enc_key_data *enc_state, int slot)
Fabio Utzigba829042018-09-18 08:29:34 -0300686{
Dominik Ermel956311d2024-07-12 19:53:24 +0000687 return enc_state[slot].valid;
Fabio Utzigba829042018-09-18 08:29:34 -0300688}
689
690void
Dominik Ermel3f112862024-07-17 14:43:05 +0000691boot_encrypt(struct enc_key_data *enc_state, int slot, uint32_t off,
692 uint32_t sz, uint32_t blk_off, uint8_t *buf)
Fabio Utzigba829042018-09-18 08:29:34 -0300693{
694 struct enc_key_data *enc;
Fabio Utzigba829042018-09-18 08:29:34 -0300695 uint8_t nonce[16];
Fabio Utzigba829042018-09-18 08:29:34 -0300696
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900697 /* boot_copy_region will call boot_encrypt with sz = 0 when skipping over
698 the TLVs. */
699 if (sz == 0) {
700 return;
701 }
702
Fabio Utzigba829042018-09-18 08:29:34 -0300703 memset(nonce, 0, 12);
704 off >>= 4;
705 nonce[12] = (uint8_t)(off >> 24);
706 nonce[13] = (uint8_t)(off >> 16);
707 nonce[14] = (uint8_t)(off >> 8);
708 nonce[15] = (uint8_t)off;
709
Dominik Ermel3f112862024-07-17 14:43:05 +0000710 enc = &enc_state[slot];
Fabio Utzigba829042018-09-18 08:29:34 -0300711 assert(enc->valid == 1);
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900712 bootutil_aes_ctr_encrypt(&enc->aes_ctr, nonce, buf, sz, blk_off, buf);
Fabio Utzigba829042018-09-18 08:29:34 -0300713}
714
Fabio Utzig10ee6482019-08-01 12:04:52 -0300715/**
716 * Clears encrypted state after use.
717 */
Fabio Utzigb63d9952019-08-19 14:20:52 -0300718void
719boot_enc_zeroize(struct enc_key_data *enc_state)
Fabio Utzigba829042018-09-18 08:29:34 -0300720{
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900721 uint8_t slot;
722 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
723 (void)boot_enc_drop(enc_state, slot);
724 }
Fabio Utzig10ee6482019-08-01 12:04:52 -0300725 memset(enc_state, 0, sizeof(struct enc_key_data) * BOOT_NUM_SLOTS);
Fabio Utzigba829042018-09-18 08:29:34 -0300726}
727
728#endif /* MCUBOOT_ENC_IMAGES */