samples: Add a section on encryption in mcuboot_config.template.h

Signed-off-by: Raphael Dupont <raphael7dup@gmail.com>
mcu-tools · Jun 5, 2023 · 411db0b · 411db0b
1 parent d1e34a6
commit 411db0b
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/boot/bootutil/src/encrypted_priv.h b/boot/bootutil/src/encrypted_priv.h
@@ -1,3 +1,9 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * Copyright (c) 2018-2019 JUUL Labs
+ * Copyright (c) 2019-2021 Arm Limited
+ */
 
 #ifndef H_ENCRYPTED_PRIV_
 #define H_ENCRYPTED_PRIV_

diff --git a/samples/mcuboot_config/mcuboot_config.template.h b/samples/mcuboot_config/mcuboot_config.template.h
@@ -34,6 +34,33 @@
 /* #define MCUBOOT_SIGN_EC256 */
 
 
+/*
+ * Encryption types 
+ *
+ * You must choose one key encryption type and provide a private key
+ * when image encryption is enable (MCUBOOT_ENC_IMAGES).
+ * 
+ * For examples, see :
+ * 
+ * boot/espressif/keys.c
+ * boot/zephyr/keys.c
+ */
+
+/* Uncomment to enable image encryption. */
+/* #define MCUBOOT_ENC_IMAGES */
+
+/* Uncomment for RSA encryption support. */
+/* #define MCUBOOT_ENCRYPT_RSA */
+
+/* Uncomment for ECIES-P256 encryption support. */
+/* #define MCUBOOT_ENCRYPT_EC256 */
+
+/* Uncomment for ECIES-X25519 encryption support. */
+/* #define MCUBOOT_ENCRYPT_X25519 */
+
+/* Uncomment for AES-128 Keywrap encryption support. */
+/* #define MCUBOOT_ENCRYPT_KW */
+
 /*
  * Upgrade mode
  *