blob: aff2d4584ffc5597ce470e74db8bf501a7716258 [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
5 * Copyright (c) 2019 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)
16#include "mbedtls/rsa.h"
Fabio Utzig6f4d8f82019-12-12 18:46:06 -030017#include "mbedtls/rsa_internal.h"
Fabio Utzigba829042018-09-18 08:29:34 -030018#include "mbedtls/asn1.h"
19#endif
20
21#if defined(MCUBOOT_ENCRYPT_KW)
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090022#include "bootutil/crypto/aes_kw.h"
Fabio Utzigba829042018-09-18 08:29:34 -030023#endif
24
Fabio Utzig5fde8322019-10-23 12:23:08 -030025#if defined(MCUBOOT_ENCRYPT_EC256)
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090026#include "bootutil/crypto/ecdh_p256.h"
27#endif
28
29#if defined(MCUBOOT_ENCRYPT_X25519)
30#include "bootutil/crypto/ecdh_x25519.h"
Fabio Utzig6aec6ae2020-04-02 11:06:07 -030031#endif
32
33#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +090034#include "bootutil/crypto/sha256.h"
35#include "bootutil/crypto/hmac_sha256.h"
Fabio Utzig5fde8322019-10-23 12:23:08 -030036#include "mbedtls/oid.h"
37#include "mbedtls/asn1.h"
38#endif
39
Fabio Utzigba829042018-09-18 08:29:34 -030040#include "bootutil/image.h"
41#include "bootutil/enc_key.h"
42#include "bootutil/sign_key.h"
43
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
Fabio Utzig4741c452019-12-19 15:32:41 -030070key_unwrap(const uint8_t *wrapped, uint8_t *enckey)
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);
76 rc = bootutil_aes_kw_set_unwrap_key(&aes_kw, bootutil_enc_key.key, *bootutil_enc_key.len);
77 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 Utzigba829042018-09-18 08:29:34 -030091#if defined(MCUBOOT_ENCRYPT_RSA)
92static int
Fabio Utzig5fde8322019-10-23 12:23:08 -030093parse_rsa_enckey(mbedtls_rsa_context *ctx, uint8_t **p, uint8_t *end)
Fabio Utzigba829042018-09-18 08:29:34 -030094{
Fabio Utzigba829042018-09-18 08:29:34 -030095 size_t len;
96
Fabio Utzig6f4d8f82019-12-12 18:46:06 -030097 if (mbedtls_asn1_get_tag(p, end, &len,
98 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE) != 0) {
Fabio Utzigba829042018-09-18 08:29:34 -030099 return -1;
100 }
101
102 if (*p + len != end) {
103 return -2;
104 }
105
Fabio Utzig6f4d8f82019-12-12 18:46:06 -0300106 /* Non-optional fields. */
Fabio Utzigba829042018-09-18 08:29:34 -0300107 if ( /* version */
108 mbedtls_asn1_get_int(p, end, &ctx->ver) != 0 ||
109 /* public modulus */
110 mbedtls_asn1_get_mpi(p, end, &ctx->N) != 0 ||
111 /* public exponent */
112 mbedtls_asn1_get_mpi(p, end, &ctx->E) != 0 ||
113 /* private exponent */
114 mbedtls_asn1_get_mpi(p, end, &ctx->D) != 0 ||
115 /* primes */
116 mbedtls_asn1_get_mpi(p, end, &ctx->P) != 0 ||
Fabio Utzig6f4d8f82019-12-12 18:46:06 -0300117 mbedtls_asn1_get_mpi(p, end, &ctx->Q) != 0) {
118
Fabio Utzigba829042018-09-18 08:29:34 -0300119 return -3;
120 }
121
Fabio Utzig6f4d8f82019-12-12 18:46:06 -0300122#if !defined(MBEDTLS_RSA_NO_CRT)
123 /*
124 * DP/DQ/QP are only used inside mbedTLS if it was built with the
125 * Chinese Remainder Theorem enabled (default). In case it is disabled
126 * we parse, or if not available, we calculate those values.
127 */
128 if (*p < end) {
129 if ( /* d mod (p-1) and d mod (q-1) */
130 mbedtls_asn1_get_mpi(p, end, &ctx->DP) != 0 ||
131 mbedtls_asn1_get_mpi(p, end, &ctx->DQ) != 0 ||
132 /* q ^ (-1) mod p */
133 mbedtls_asn1_get_mpi(p, end, &ctx->QP) != 0) {
134
135 return -4;
136 }
137 } else {
138 if (mbedtls_rsa_deduce_crt(&ctx->P, &ctx->Q, &ctx->D,
139 &ctx->DP, &ctx->DQ, &ctx->QP) != 0) {
140 return -5;
141 }
142 }
143#endif
144
Fabio Utzigba829042018-09-18 08:29:34 -0300145 ctx->len = mbedtls_mpi_size(&ctx->N);
146
Fabio Utzig6f4d8f82019-12-12 18:46:06 -0300147 if (mbedtls_rsa_check_privkey(ctx) != 0) {
148 return -6;
Fabio Utzigba829042018-09-18 08:29:34 -0300149 }
150
151 return 0;
152}
153#endif
154
Fabio Utzig5fde8322019-10-23 12:23:08 -0300155#if defined(MCUBOOT_ENCRYPT_EC256)
156static const uint8_t ec_pubkey_oid[] = MBEDTLS_OID_EC_ALG_UNRESTRICTED;
157static const uint8_t ec_secp256r1_oid[] = MBEDTLS_OID_EC_GRP_SECP256R1;
158
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300159#define SHARED_KEY_LEN NUM_ECC_BYTES
160#define PRIV_KEY_LEN NUM_ECC_BYTES
161
Fabio Utzig5fde8322019-10-23 12:23:08 -0300162/*
163 * Parses the output of `imgtool keygen`, which produces a PKCS#8 elliptic
164 * curve keypair. See RFC5208 and RFC5915.
165 */
166static int
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900167parse_ec256_enckey(uint8_t **p, uint8_t *end, uint8_t *private_key)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300168{
169 int rc;
170 size_t len;
171 int version;
172 mbedtls_asn1_buf alg;
173 mbedtls_asn1_buf param;
174
175 if ((rc = mbedtls_asn1_get_tag(p, end, &len,
176 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
177 return -1;
178 }
179
180 if (*p + len != end) {
181 return -2;
182 }
183
184 version = 0;
185 if (mbedtls_asn1_get_int(p, end, &version) || version != 0) {
186 return -3;
187 }
188
189 if ((rc = mbedtls_asn1_get_alg(p, end, &alg, &param)) != 0) {
190 return -5;
191 }
192
193 if (alg.len != sizeof(ec_pubkey_oid) - 1 ||
194 memcmp(alg.p, ec_pubkey_oid, sizeof(ec_pubkey_oid) - 1)) {
195 return -6;
196 }
197 if (param.len != sizeof(ec_secp256r1_oid) - 1 ||
198 memcmp(param.p, ec_secp256r1_oid, sizeof(ec_secp256r1_oid) - 1)) {
199 return -7;
200 }
201
202 if ((rc = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
203 return -8;
204 }
205
206 /* RFC5915 - ECPrivateKey */
207
208 if ((rc = mbedtls_asn1_get_tag(p, end, &len,
209 MBEDTLS_ASN1_CONSTRUCTED | MBEDTLS_ASN1_SEQUENCE)) != 0) {
210 return -9;
211 }
212
213 version = 0;
214 if (mbedtls_asn1_get_int(p, end, &version) || version != 1) {
215 return -10;
216 }
217
218 /* privateKey */
219
220 if ((rc = mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING)) != 0) {
221 return -11;
222 }
223
224 if (len != NUM_ECC_BYTES) {
225 return -12;
226 }
227
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900228 memcpy(private_key, *p, len);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300229
230 /* publicKey usually follows but is not parsed here */
231
232 return 0;
233}
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300234#endif /* defined(MCUBOOT_ENCRYPT_EC256) */
Fabio Utzig5fde8322019-10-23 12:23:08 -0300235
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300236#if defined(MCUBOOT_ENCRYPT_X25519)
237#define X25519_OID "\x6e"
238static const uint8_t ec_pubkey_oid[] = MBEDTLS_OID_ISO_IDENTIFIED_ORG \
239 MBEDTLS_OID_ORG_GOV X25519_OID;
240
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300241#define SHARED_KEY_LEN 32
242#define PRIV_KEY_LEN 32
243
244static int
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900245parse_x25519_enckey(uint8_t **p, uint8_t *end, uint8_t *private_key)
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300246{
247 size_t len;
248 int version;
249 mbedtls_asn1_buf alg;
250 mbedtls_asn1_buf param;
251
252 if (mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_CONSTRUCTED |
253 MBEDTLS_ASN1_SEQUENCE) != 0) {
254 return -1;
255 }
256
257 if (*p + len != end) {
258 return -2;
259 }
260
261 version = 0;
262 if (mbedtls_asn1_get_int(p, end, &version) || version != 0) {
263 return -3;
264 }
265
266 if (mbedtls_asn1_get_alg(p, end, &alg, &param) != 0) {
267 return -4;
268 }
269
270 if (alg.len != sizeof(ec_pubkey_oid) - 1 ||
271 memcmp(alg.p, ec_pubkey_oid, sizeof(ec_pubkey_oid) - 1)) {
272 return -5;
273 }
274
275 if (mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING) != 0) {
276 return -6;
277 }
278
279 if (mbedtls_asn1_get_tag(p, end, &len, MBEDTLS_ASN1_OCTET_STRING) != 0) {
280 return -7;
281 }
282
283 if (len != PRIV_KEY_LEN) {
284 return -8;
285 }
286
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900287 memcpy(private_key, *p, PRIV_KEY_LEN);
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300288 return 0;
289}
290#endif /* defined(MCUBOOT_ENCRYPT_X25519) */
291
292#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300293/*
294 * HKDF as described by RFC5869.
295 *
296 * @param ikm The input data to be derived.
297 * @param ikm_len Length of the input data.
298 * @param info An information tag.
299 * @param info_len Length of the information tag.
300 * @param okm Output of the KDF computation.
301 * @param okm_len On input the requested length; on output the generated length
302 */
303static int
304hkdf(uint8_t *ikm, uint16_t ikm_len, uint8_t *info, uint16_t info_len,
305 uint8_t *okm, uint16_t *okm_len)
306{
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900307 bootutil_hmac_sha256_context hmac;
308 uint8_t salt[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
309 uint8_t prk[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
310 uint8_t T[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
Fabio Utzig5fde8322019-10-23 12:23:08 -0300311 uint16_t off;
312 uint16_t len;
313 uint8_t counter;
314 bool first;
315 int rc;
316
317 /*
318 * Extract
319 */
320
321 if (ikm == NULL || okm == NULL || ikm_len == 0) {
322 return -1;
323 }
324
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900325 bootutil_hmac_sha256_init(&hmac);
326
327 memset(salt, 0, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
328 rc = bootutil_hmac_sha256_set_key(&hmac, salt, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
329 if (rc != 0) {
330 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300331 }
332
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900333 rc = bootutil_hmac_sha256_update(&hmac, ikm, ikm_len);
334 if (rc != 0) {
335 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300336 }
337
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900338 rc = bootutil_hmac_sha256_finish(&hmac, prk, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
339 if (rc != 0) {
340 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300341 }
342
343 /*
344 * Expand
345 */
346
347 len = *okm_len;
348 counter = 1;
349 first = true;
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900350 for (off = 0; len > 0; off += BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE, ++counter) {
351 bootutil_hmac_sha256_init(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300352
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900353 rc = bootutil_hmac_sha256_set_key(&hmac, prk, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
354 if (rc != 0) {
355 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300356 }
357
358 if (first) {
359 first = false;
360 } else {
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900361 rc = bootutil_hmac_sha256_update(&hmac, T, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
362 if (rc != 0) {
363 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300364 }
365 }
366
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900367 rc = bootutil_hmac_sha256_update(&hmac, info, info_len);
368 if (rc != 0) {
369 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300370 }
371
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900372 rc = bootutil_hmac_sha256_update(&hmac, &counter, 1);
373 if (rc != 0) {
374 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300375 }
376
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900377 rc = bootutil_hmac_sha256_finish(&hmac, T, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
378 if (rc != 0) {
379 goto error;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300380 }
381
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900382 if (len > BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE) {
383 memcpy(&okm[off], T, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
384 len -= BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300385 } else {
386 memcpy(&okm[off], T, len);
387 len = 0;
388 }
389 }
390
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900391 bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300392 return 0;
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900393
394error:
395 bootutil_hmac_sha256_drop(&hmac);
396 return -1;
Fabio Utzig5fde8322019-10-23 12:23:08 -0300397}
398#endif
399
Fabio Utzigba829042018-09-18 08:29:34 -0300400int
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900401boot_enc_init(struct enc_key_data *enc_state, uint8_t slot)
402{
403 bootutil_aes_ctr_init(&enc_state[slot].aes_ctr);
404 return 0;
405}
406
407int
408boot_enc_drop(struct enc_key_data *enc_state, uint8_t slot)
409{
410 bootutil_aes_ctr_drop(&enc_state[slot].aes_ctr);
411 return 0;
412}
413
414int
Fabio Utzig4741c452019-12-19 15:32:41 -0300415boot_enc_set_key(struct enc_key_data *enc_state, uint8_t slot,
416 const struct boot_status *bs)
Fabio Utzigba829042018-09-18 08:29:34 -0300417{
418 int rc;
419
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900420 rc = bootutil_aes_ctr_set_key(&enc_state[slot].aes_ctr, bs->enckey[slot]);
421 if (rc != 0) {
422 boot_enc_drop(enc_state, slot);
423 enc_state[slot].valid = 0;
Fabio Utzigba829042018-09-18 08:29:34 -0300424 return -1;
425 }
426
427 enc_state[slot].valid = 1;
428
429 return 0;
430}
431
Fabio Utzig4741c452019-12-19 15:32:41 -0300432#define EXPECTED_ENC_LEN BOOT_ENC_TLV_SIZE
433
Fabio Utzigba829042018-09-18 08:29:34 -0300434#if defined(MCUBOOT_ENCRYPT_RSA)
435# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_RSA2048
Fabio Utzigba829042018-09-18 08:29:34 -0300436#elif defined(MCUBOOT_ENCRYPT_KW)
437# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_KW128
Fabio Utzig5fde8322019-10-23 12:23:08 -0300438#elif defined(MCUBOOT_ENCRYPT_EC256)
439# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_EC256
Fabio Utzig5fde8322019-10-23 12:23:08 -0300440# define EC_PUBK_INDEX (1)
441# define EC_TAG_INDEX (65)
442# define EC_CIPHERKEY_INDEX (65 + 32)
Fabio Utzig4741c452019-12-19 15:32:41 -0300443_Static_assert(EC_CIPHERKEY_INDEX + 16 == EXPECTED_ENC_LEN,
444 "Please fix ECIES-P256 component indexes");
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300445#elif defined(MCUBOOT_ENCRYPT_X25519)
446# define EXPECTED_ENC_TLV IMAGE_TLV_ENC_X25519
447# define EC_PUBK_INDEX (0)
448# define EC_TAG_INDEX (32)
449# define EC_CIPHERKEY_INDEX (32 + 32)
450_Static_assert(EC_CIPHERKEY_INDEX + 16 == EXPECTED_ENC_LEN,
451 "Please fix ECIES-X25519 component indexes");
Fabio Utzigba829042018-09-18 08:29:34 -0300452#endif
453
454/*
Fabio Utzig4741c452019-12-19 15:32:41 -0300455 * Decrypt an encryption key TLV.
456 *
457 * @param buf An encryption TLV read from flash (build time fixed length)
458 * @param enckey An AES-128 key sized buffer to store to plain key.
Fabio Utzigba829042018-09-18 08:29:34 -0300459 */
460int
Fabio Utzig4741c452019-12-19 15:32:41 -0300461boot_enc_decrypt(const uint8_t *buf, uint8_t *enckey)
Fabio Utzigba829042018-09-18 08:29:34 -0300462{
463#if defined(MCUBOOT_ENCRYPT_RSA)
464 mbedtls_rsa_context rsa;
465 uint8_t *cp;
466 uint8_t *cpend;
Fabio Utzigba829042018-09-18 08:29:34 -0300467 size_t olen;
Fabio Utzig38f5ffe2018-12-27 16:12:58 -0200468#endif
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900469#if defined(MCUBOOT_ENCRYPT_EC256)
470 bootutil_ecdh_p256_context ecdh_p256;
471#endif
472#if defined(MCUBOOT_ENCRYPT_X25519)
473 bootutil_ecdh_x25519_context ecdh_x25519;
474#endif
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300475#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900476 bootutil_hmac_sha256_context hmac;
477 bootutil_aes_ctr_context aes_ctr;
478 uint8_t tag[BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300479 uint8_t shared[SHARED_KEY_LEN];
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900480 uint8_t derived_key[BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE + BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE];
Fabio Utzig5fde8322019-10-23 12:23:08 -0300481 uint8_t *cp;
482 uint8_t *cpend;
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900483 uint8_t private_key[PRIV_KEY_LEN];
484 uint8_t counter[BOOTUTIL_CRYPTO_AES_CTR_BLOCK_SIZE];
Fabio Utzig61fd8882019-09-14 20:00:20 -0300485 uint16_t len;
Fabio Utzig4741c452019-12-19 15:32:41 -0300486#endif
487 int rc = -1;
Fabio Utzigba829042018-09-18 08:29:34 -0300488
Fabio Utzigba829042018-09-18 08:29:34 -0300489#if defined(MCUBOOT_ENCRYPT_RSA)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300490
Fabio Utzig233af7d2019-08-26 12:06:16 -0300491 mbedtls_rsa_init(&rsa, MBEDTLS_RSA_PKCS_V21, MBEDTLS_MD_SHA256);
Fabio Utzigba829042018-09-18 08:29:34 -0300492
Fabio Utzig233af7d2019-08-26 12:06:16 -0300493 cp = (uint8_t *)bootutil_enc_key.key;
494 cpend = cp + *bootutil_enc_key.len;
Fabio Utzigba829042018-09-18 08:29:34 -0300495
Fabio Utzig5fde8322019-10-23 12:23:08 -0300496 rc = parse_rsa_enckey(&rsa, &cp, cpend);
Fabio Utzig233af7d2019-08-26 12:06:16 -0300497 if (rc) {
Fabio Utzigba829042018-09-18 08:29:34 -0300498 mbedtls_rsa_free(&rsa);
Fabio Utzig233af7d2019-08-26 12:06:16 -0300499 return rc;
500 }
501
502 rc = mbedtls_rsa_rsaes_oaep_decrypt(&rsa, NULL, NULL, MBEDTLS_RSA_PRIVATE,
503 NULL, 0, &olen, buf, enckey, BOOT_ENC_KEY_SIZE);
504 mbedtls_rsa_free(&rsa);
Fabio Utzigba829042018-09-18 08:29:34 -0300505
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300506#endif /* defined(MCUBOOT_ENCRYPT_RSA) */
507
508#if defined(MCUBOOT_ENCRYPT_KW)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300509
Fabio Utzig233af7d2019-08-26 12:06:16 -0300510 assert(*bootutil_enc_key.len == 16);
511 rc = key_unwrap(buf, enckey);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300512
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300513#endif /* defined(MCUBOOT_ENCRYPT_KW) */
514
515#if defined(MCUBOOT_ENCRYPT_EC256)
Fabio Utzig5fde8322019-10-23 12:23:08 -0300516
517 cp = (uint8_t *)bootutil_enc_key.key;
518 cpend = cp + *bootutil_enc_key.len;
519
520 /*
521 * Load the stored EC256 decryption private key
522 */
523
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900524 rc = parse_ec256_enckey(&cp, cpend, private_key);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300525 if (rc) {
526 return rc;
527 }
528
529 /* is EC point uncompressed? */
530 if (buf[0] != 0x04) {
531 return -1;
532 }
533
534 /*
535 * First "element" in the TLV is the curve point (public key)
536 */
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900537 bootutil_ecdh_p256_init(&ecdh_p256);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300538
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900539 rc = bootutil_ecdh_p256_shared_secret(&ecdh_p256, &buf[EC_PUBK_INDEX], private_key, shared);
540 bootutil_ecdh_p256_drop(&ecdh_p256);
541 if (rc != 0) {
Fabio Utzig5fde8322019-10-23 12:23:08 -0300542 return -1;
543 }
544
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300545#endif /* defined(MCUBOOT_ENCRYPT_EC256) */
546
547#if defined(MCUBOOT_ENCRYPT_X25519)
548
549 cp = (uint8_t *)bootutil_enc_key.key;
550 cpend = cp + *bootutil_enc_key.len;
551
552 /*
553 * Load the stored X25519 decryption private key
554 */
555
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900556 rc = parse_x25519_enckey(&cp, cpend, private_key);
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300557 if (rc) {
558 return rc;
559 }
560
561 /*
562 * First "element" in the TLV is the curve point (public key)
563 */
564
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900565 bootutil_ecdh_x25519_init(&ecdh_x25519);
566
567 rc = bootutil_ecdh_x25519_shared_secret(&ecdh_x25519, &buf[EC_PUBK_INDEX], private_key, shared);
568 bootutil_ecdh_x25519_drop(&ecdh_x25519);
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300569 if (!rc) {
570 return -1;
571 }
572
573#endif /* defined(MCUBOOT_ENCRYPT_X25519) */
574
575#if defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519)
576
Fabio Utzig5fde8322019-10-23 12:23:08 -0300577 /*
578 * Expand shared secret to create keys for AES-128-CTR + HMAC-SHA256
579 */
580
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900581 len = BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE + BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE;
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300582 rc = hkdf(shared, SHARED_KEY_LEN, (uint8_t *)"MCUBoot_ECIES_v1", 16,
Fabio Utzig5fde8322019-10-23 12:23:08 -0300583 derived_key, &len);
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900584 if (rc != 0 || len != (BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE + BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE)) {
Fabio Utzig5fde8322019-10-23 12:23:08 -0300585 return -1;
586 }
587
588 /*
589 * HMAC the key and check that our received MAC matches the generated tag
590 */
591
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900592 bootutil_hmac_sha256_init(&hmac);
593
594 rc = bootutil_hmac_sha256_set_key(&hmac, &derived_key[16], 32);
595 if (rc != 0) {
596 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300597 return -1;
598 }
599
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900600 rc = bootutil_hmac_sha256_update(&hmac, &buf[EC_CIPHERKEY_INDEX], 16);
601 if (rc != 0) {
602 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300603 return -1;
604 }
605
606 /* Assumes the tag bufer is at least sizeof(hmac_tag_size(state)) bytes */
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900607 rc = bootutil_hmac_sha256_finish(&hmac, tag, BOOTUTIL_CRYPTO_SHA256_DIGEST_SIZE);
608 if (rc != 0) {
609 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300610 return -1;
611 }
612
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900613 if (bootutil_constant_time_compare(tag, &buf[EC_TAG_INDEX], 32) != 0) {
614 (void)bootutil_hmac_sha256_drop(&hmac);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300615 return -1;
616 }
617
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900618 bootutil_hmac_sha256_drop(&hmac);
619
Fabio Utzig5fde8322019-10-23 12:23:08 -0300620 /*
621 * Finally decrypt the received ciphered key
622 */
623
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900624 bootutil_aes_ctr_init(&aes_ctr);
625 if (rc != 0) {
626 bootutil_aes_ctr_drop(&aes_ctr);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300627 return -1;
628 }
629
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900630 rc = bootutil_aes_ctr_set_key(&aes_ctr, derived_key);
631 if (rc != 0) {
632 bootutil_aes_ctr_drop(&aes_ctr);
Fabio Utzig5fde8322019-10-23 12:23:08 -0300633 return -1;
634 }
635
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900636 memset(counter, 0, BOOTUTIL_CRYPTO_AES_CTR_BLOCK_SIZE);
637 rc = bootutil_aes_ctr_decrypt(&aes_ctr, counter, &buf[EC_CIPHERKEY_INDEX], BOOTUTIL_CRYPTO_AES_CTR_KEY_SIZE, 0, enckey);
638 if (rc != 0) {
639 bootutil_aes_ctr_drop(&aes_ctr);
640 return -1;
641 }
642
643 bootutil_aes_ctr_drop(&aes_ctr);
644
Fabio Utzig5fde8322019-10-23 12:23:08 -0300645 rc = 0;
646
Fabio Utzig6aec6ae2020-04-02 11:06:07 -0300647#endif /* defined(MCUBOOT_ENCRYPT_EC256) || defined(MCUBOOT_ENCRYPT_X25519) */
Fabio Utzigba829042018-09-18 08:29:34 -0300648
Fabio Utzigba829042018-09-18 08:29:34 -0300649 return rc;
650}
651
Fabio Utzig4741c452019-12-19 15:32:41 -0300652/*
653 * Load encryption key.
654 */
655int
656boot_enc_load(struct enc_key_data *enc_state, int image_index,
657 const struct image_header *hdr, const struct flash_area *fap,
658 struct boot_status *bs)
659{
660 uint32_t off;
661 uint16_t len;
662 struct image_tlv_iter it;
663#if MCUBOOT_SWAP_SAVE_ENCTLV
664 uint8_t *buf;
665#else
666 uint8_t buf[EXPECTED_ENC_LEN];
667#endif
668 uint8_t slot;
669 int rc;
670
671 rc = flash_area_id_to_multi_image_slot(image_index, fap->fa_id);
672 if (rc < 0) {
673 return rc;
674 }
675 slot = rc;
676
677 /* Already loaded... */
678 if (enc_state[slot].valid) {
679 return 1;
680 }
681
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900682 /* Initialize the AES context */
683 boot_enc_init(enc_state, slot);
684
Fabio Utzig4741c452019-12-19 15:32:41 -0300685 rc = bootutil_tlv_iter_begin(&it, hdr, fap, EXPECTED_ENC_TLV, false);
686 if (rc) {
687 return -1;
688 }
689
690 rc = bootutil_tlv_iter_next(&it, &off, &len, NULL);
691 if (rc != 0) {
692 return rc;
693 }
694
695 if (len != EXPECTED_ENC_LEN) {
696 return -1;
697 }
698
699#if MCUBOOT_SWAP_SAVE_ENCTLV
700 buf = bs->enctlv[slot];
701 memset(buf, 0xff, BOOT_ENC_TLV_ALIGN_SIZE);
702#endif
703
704 rc = flash_area_read(fap, off, buf, EXPECTED_ENC_LEN);
705 if (rc) {
706 return -1;
707 }
708
709 return boot_enc_decrypt(buf, bs->enckey[slot]);
710}
711
Andrzej Puzdrowskicf97dd02019-03-14 15:10:10 +0100712bool
Fabio Utzig10ee6482019-08-01 12:04:52 -0300713boot_enc_valid(struct enc_key_data *enc_state, int image_index,
714 const struct flash_area *fap)
Fabio Utzigba829042018-09-18 08:29:34 -0300715{
Andrzej Puzdrowskie575fe92019-03-14 12:20:19 +0100716 int rc;
717
Fabio Utzigb0f04732019-07-31 09:49:19 -0300718 rc = flash_area_id_to_multi_image_slot(image_index, fap->fa_id);
Andrzej Puzdrowskie575fe92019-03-14 12:20:19 +0100719 if (rc < 0) {
720 /* can't get proper slot number - skip encryption, */
Fabio Utzigb0f04732019-07-31 09:49:19 -0300721 /* postpone the error for a upper layer */
Andrzej Puzdrowskicf97dd02019-03-14 15:10:10 +0100722 return false;
Andrzej Puzdrowskie575fe92019-03-14 12:20:19 +0100723 }
724
725 return enc_state[rc].valid;
Fabio Utzigba829042018-09-18 08:29:34 -0300726}
727
728void
Fabio Utzig10ee6482019-08-01 12:04:52 -0300729boot_encrypt(struct enc_key_data *enc_state, int image_index,
730 const struct flash_area *fap, uint32_t off, uint32_t sz,
731 uint32_t blk_off, uint8_t *buf)
Fabio Utzigba829042018-09-18 08:29:34 -0300732{
733 struct enc_key_data *enc;
Fabio Utzigba829042018-09-18 08:29:34 -0300734 uint8_t nonce[16];
Andrzej Puzdrowskie575fe92019-03-14 12:20:19 +0100735 int rc;
Fabio Utzigba829042018-09-18 08:29:34 -0300736
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900737 /* boot_copy_region will call boot_encrypt with sz = 0 when skipping over
738 the TLVs. */
739 if (sz == 0) {
740 return;
741 }
742
Fabio Utzigba829042018-09-18 08:29:34 -0300743 memset(nonce, 0, 12);
744 off >>= 4;
745 nonce[12] = (uint8_t)(off >> 24);
746 nonce[13] = (uint8_t)(off >> 16);
747 nonce[14] = (uint8_t)(off >> 8);
748 nonce[15] = (uint8_t)off;
749
Fabio Utzigb0f04732019-07-31 09:49:19 -0300750 rc = flash_area_id_to_multi_image_slot(image_index, fap->fa_id);
Andrzej Puzdrowskie575fe92019-03-14 12:20:19 +0100751 if (rc < 0) {
752 assert(0);
753 return;
754 }
755
756 enc = &enc_state[rc];
Fabio Utzigba829042018-09-18 08:29:34 -0300757 assert(enc->valid == 1);
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900758 bootutil_aes_ctr_encrypt(&enc->aes_ctr, nonce, buf, sz, blk_off, buf);
Fabio Utzigba829042018-09-18 08:29:34 -0300759}
760
Fabio Utzig10ee6482019-08-01 12:04:52 -0300761/**
762 * Clears encrypted state after use.
763 */
Fabio Utzigb63d9952019-08-19 14:20:52 -0300764void
765boot_enc_zeroize(struct enc_key_data *enc_state)
Fabio Utzigba829042018-09-18 08:29:34 -0300766{
Blaž Hrastnik4f4833d2020-09-14 13:53:31 +0900767 uint8_t slot;
768 for (slot = 0; slot < BOOT_NUM_SLOTS; slot++) {
769 (void)boot_enc_drop(enc_state, slot);
770 }
Fabio Utzig10ee6482019-08-01 12:04:52 -0300771 memset(enc_state, 0, sizeof(struct enc_key_data) * BOOT_NUM_SLOTS);
Fabio Utzigba829042018-09-18 08:29:34 -0300772}
773
774#endif /* MCUBOOT_ENC_IMAGES */