Kconfig.projbuild 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105
  1. menu "Bootloader config"
  2. orsource "../esp_bootloader_format/Kconfig.bootloader"
  3. config BOOTLOADER_OFFSET_IN_FLASH
  4. hex
  5. default 0x1000 if IDF_TARGET_ESP32 || IDF_TARGET_ESP32S2
  6. default 0x0
  7. help
  8. Offset address that 2nd bootloader will be flashed to.
  9. The value is determined by the ROM bootloader.
  10. It's not configurable in ESP-IDF.
  11. choice BOOTLOADER_COMPILER_OPTIMIZATION
  12. prompt "Bootloader optimization Level"
  13. default BOOTLOADER_COMPILER_OPTIMIZATION_SIZE
  14. help
  15. This option sets compiler optimization level (gcc -O argument)
  16. for the bootloader.
  17. - The default "Size" setting will add the -0s flag to CFLAGS.
  18. - The "Debug" setting will add the -Og flag to CFLAGS.
  19. - The "Performance" setting will add the -O2 flag to CFLAGS.
  20. - The "None" setting will add the -O0 flag to CFLAGS.
  21. Note that custom optimization levels may be unsupported.
  22. config BOOTLOADER_COMPILER_OPTIMIZATION_SIZE
  23. bool "Size (-Os)"
  24. config BOOTLOADER_COMPILER_OPTIMIZATION_DEBUG
  25. bool "Debug (-Og)"
  26. config BOOTLOADER_COMPILER_OPTIMIZATION_PERF
  27. bool "Optimize for performance (-O2)"
  28. config BOOTLOADER_COMPILER_OPTIMIZATION_NONE
  29. bool "Debug without optimization (-O0)"
  30. endchoice
  31. choice BOOTLOADER_LOG_LEVEL
  32. bool "Bootloader log verbosity"
  33. default BOOTLOADER_LOG_LEVEL_INFO
  34. help
  35. Specify how much output to see in bootloader logs.
  36. config BOOTLOADER_LOG_LEVEL_NONE
  37. bool "No output"
  38. config BOOTLOADER_LOG_LEVEL_ERROR
  39. bool "Error"
  40. config BOOTLOADER_LOG_LEVEL_WARN
  41. bool "Warning"
  42. config BOOTLOADER_LOG_LEVEL_INFO
  43. bool "Info"
  44. config BOOTLOADER_LOG_LEVEL_DEBUG
  45. bool "Debug"
  46. config BOOTLOADER_LOG_LEVEL_VERBOSE
  47. bool "Verbose"
  48. endchoice
  49. config BOOTLOADER_LOG_LEVEL
  50. int
  51. default 0 if BOOTLOADER_LOG_LEVEL_NONE
  52. default 1 if BOOTLOADER_LOG_LEVEL_ERROR
  53. default 2 if BOOTLOADER_LOG_LEVEL_WARN
  54. default 3 if BOOTLOADER_LOG_LEVEL_INFO
  55. default 4 if BOOTLOADER_LOG_LEVEL_DEBUG
  56. default 5 if BOOTLOADER_LOG_LEVEL_VERBOSE
  57. config BOOTLOADER_SPI_CUSTOM_WP_PIN
  58. bool "Use custom SPI Flash WP Pin when flash pins set in eFuse (read help)"
  59. depends on IDF_TARGET_ESP32 && (ESPTOOLPY_FLASHMODE_QIO || ESPTOOLPY_FLASHMODE_QOUT)
  60. default y if BOOTLOADER_SPI_WP_PIN != 7 # backwards compatibility, can remove in IDF 5
  61. default n
  62. help
  63. This setting is only used if the SPI flash pins have been overridden by setting the eFuses
  64. SPI_PAD_CONFIG_xxx, and the SPI flash mode is QIO or QOUT.
  65. When this is the case, the eFuse config only defines 3 of the 4 Quad I/O data pins. The WP pin (aka
  66. ESP32 pin "SD_DATA_3" or SPI flash pin "IO2") is not specified in eFuse. The same pin is also used
  67. for external SPIRAM if it is enabled.
  68. If this config item is set to N (default), the correct WP pin will be automatically used for any
  69. Espressif chip or module with integrated flash. If a custom setting is needed, set this config item to
  70. Y and specify the GPIO number connected to the WP.
  71. config BOOTLOADER_SPI_WP_PIN
  72. int "Custom SPI Flash WP Pin"
  73. range 0 33
  74. default 7
  75. depends on IDF_TARGET_ESP32 && (ESPTOOLPY_FLASHMODE_QIO || ESPTOOLPY_FLASHMODE_QOUT)
  76. #depends on BOOTLOADER_SPI_CUSTOM_WP_PIN # backwards compatibility, can uncomment in IDF 5
  77. help
  78. The option "Use custom SPI Flash WP Pin" must be set or this value is ignored
  79. If burning a customized set of SPI flash pins in eFuse and using QIO or QOUT mode for flash, set this
  80. value to the GPIO number of the SPI flash WP pin.
  81. choice BOOTLOADER_VDDSDIO_BOOST
  82. bool "VDDSDIO LDO voltage"
  83. default BOOTLOADER_VDDSDIO_BOOST_1_9V
  84. depends on SOC_CONFIGURABLE_VDDSDIO_SUPPORTED
  85. help
  86. If this option is enabled, and VDDSDIO LDO is set to 1.8V (using eFuse
  87. or MTDI bootstrapping pin), bootloader will change LDO settings to
  88. output 1.9V instead. This helps prevent flash chip from browning out
  89. during flash programming operations.
  90. This option has no effect if VDDSDIO is set to 3.3V, or if the internal
  91. VDDSDIO regulator is disabled via eFuse.
  92. config BOOTLOADER_VDDSDIO_BOOST_1_8V
  93. bool "1.8V"
  94. depends on !ESPTOOLPY_FLASHFREQ_80M
  95. config BOOTLOADER_VDDSDIO_BOOST_1_9V
  96. bool "1.9V"
  97. endchoice
  98. config BOOTLOADER_FACTORY_RESET
  99. bool "GPIO triggers factory reset"
  100. default N
  101. select BOOTLOADER_RESERVE_RTC_MEM if SOC_RTC_FAST_MEM_SUPPORTED
  102. help
  103. Allows to reset the device to factory settings:
  104. - clear one or more data partitions;
  105. - boot from "factory" partition.
  106. The factory reset will occur if there is a GPIO input held at the configured level while
  107. device starts up. See settings below.
  108. config BOOTLOADER_NUM_PIN_FACTORY_RESET
  109. int "Number of the GPIO input for factory reset"
  110. depends on BOOTLOADER_FACTORY_RESET
  111. range 0 39 if IDF_TARGET_ESP32
  112. range 0 44 if IDF_TARGET_ESP32S2
  113. default 4
  114. help
  115. The selected GPIO will be configured as an input with internal pull-up enabled (note that on some SoCs.
  116. not all pins have an internal pull-up, consult the hardware datasheet for details.) To trigger a factory
  117. reset, this GPIO must be held high or low (as configured) on startup.
  118. choice BOOTLOADER_FACTORY_RESET_PIN_LEVEL
  119. bool "Factory reset GPIO level"
  120. depends on BOOTLOADER_FACTORY_RESET
  121. default BOOTLOADER_FACTORY_RESET_PIN_LOW
  122. help
  123. Pin level for factory reset, can be triggered on low or high.
  124. config BOOTLOADER_FACTORY_RESET_PIN_LOW
  125. bool "Reset on GPIO low"
  126. config BOOTLOADER_FACTORY_RESET_PIN_HIGH
  127. bool "Reset on GPIO high"
  128. endchoice
  129. config BOOTLOADER_OTA_DATA_ERASE
  130. bool "Clear OTA data on factory reset (select factory partition)"
  131. depends on BOOTLOADER_FACTORY_RESET
  132. help
  133. The device will boot from "factory" partition (or OTA slot 0 if no factory partition is present) after a
  134. factory reset.
  135. config BOOTLOADER_DATA_FACTORY_RESET
  136. string "Comma-separated names of partitions to clear on factory reset"
  137. depends on BOOTLOADER_FACTORY_RESET
  138. default "nvs"
  139. help
  140. Allows customers to select which data partitions will be erased while factory reset.
  141. Specify the names of partitions as a comma-delimited with optional spaces for readability. (Like this:
  142. "nvs, phy_init, ...")
  143. Make sure that the name specified in the partition table and here are the same.
  144. Partitions of type "app" cannot be specified here.
  145. config BOOTLOADER_APP_TEST
  146. bool "GPIO triggers boot from test app partition"
  147. default N
  148. depends on !BOOTLOADER_APP_ANTI_ROLLBACK
  149. help
  150. Allows to run the test app from "TEST" partition.
  151. A boot from "test" partition will occur if there is a GPIO input pulled low while device starts up.
  152. See settings below.
  153. config BOOTLOADER_NUM_PIN_APP_TEST
  154. int "Number of the GPIO input to boot TEST partition"
  155. depends on BOOTLOADER_APP_TEST
  156. range 0 39
  157. default 18
  158. help
  159. The selected GPIO will be configured as an input with internal pull-up enabled.
  160. To trigger a test app, this GPIO must be pulled low on reset.
  161. After the GPIO input is deactivated and the device reboots, the old application will boot.
  162. (factory or OTA[x]).
  163. Note that GPIO34-39 do not have an internal pullup and an external one must be provided.
  164. choice BOOTLOADER_APP_TEST_PIN_LEVEL
  165. bool "App test GPIO level"
  166. depends on BOOTLOADER_APP_TEST
  167. default BOOTLOADER_APP_TEST_PIN_LOW
  168. help
  169. Pin level for app test, can be triggered on low or high.
  170. config BOOTLOADER_APP_TEST_PIN_LOW
  171. bool "Enter test app on GPIO low"
  172. config BOOTLOADER_APP_TEST_PIN_HIGH
  173. bool "Enter test app on GPIO high"
  174. endchoice
  175. config BOOTLOADER_HOLD_TIME_GPIO
  176. int "Hold time of GPIO for reset/test mode (seconds)"
  177. depends on BOOTLOADER_FACTORY_RESET || BOOTLOADER_APP_TEST
  178. default 5
  179. help
  180. The GPIO must be held low continuously for this period of time after reset
  181. before a factory reset or test partition boot (as applicable) is performed.
  182. config BOOTLOADER_REGION_PROTECTION_ENABLE
  183. bool "Enable protection for unmapped memory regions"
  184. default y
  185. help
  186. Protects the unmapped memory regions of the entire address space from unintended accesses.
  187. This will ensure that an exception will be triggered whenever the CPU performs a memory
  188. operation on unmapped regions of the address space.
  189. config BOOTLOADER_WDT_ENABLE
  190. bool "Use RTC watchdog in start code"
  191. default y
  192. help
  193. Tracks the execution time of startup code.
  194. If the execution time is exceeded, the RTC_WDT will restart system.
  195. It is also useful to prevent a lock up in start code caused by an unstable power source.
  196. NOTE: Tracks the execution time starts from the bootloader code - re-set timeout, while selecting the
  197. source for slow_clk - and ends calling app_main.
  198. Re-set timeout is needed due to WDT uses a SLOW_CLK clock source. After changing a frequency slow_clk a
  199. time of WDT needs to re-set for new frequency.
  200. slow_clk depends on RTC_CLK_SRC (INTERNAL_RC or EXTERNAL_CRYSTAL).
  201. config BOOTLOADER_WDT_DISABLE_IN_USER_CODE
  202. bool "Allows RTC watchdog disable in user code"
  203. depends on BOOTLOADER_WDT_ENABLE
  204. default n
  205. help
  206. If this option is set, the ESP-IDF app must explicitly reset, feed, or disable the rtc_wdt in
  207. the app's own code.
  208. If this option is not set (default), then rtc_wdt will be disabled by ESP-IDF before calling
  209. the app_main() function.
  210. Use function rtc_wdt_feed() for resetting counter of rtc_wdt.
  211. Use function rtc_wdt_disable() for disabling rtc_wdt.
  212. config BOOTLOADER_WDT_TIME_MS
  213. int "Timeout for RTC watchdog (ms)"
  214. depends on BOOTLOADER_WDT_ENABLE
  215. default 9000
  216. range 0 120000
  217. help
  218. Verify that this parameter is correct and more then the execution time.
  219. Pay attention to options such as reset to factory, trigger test partition and encryption on boot
  220. - these options can increase the execution time.
  221. Note: RTC_WDT will reset while encryption operations will be performed.
  222. config BOOTLOADER_APP_ROLLBACK_ENABLE
  223. bool "Enable app rollback support"
  224. default n
  225. help
  226. After updating the app, the bootloader runs a new app with the "ESP_OTA_IMG_PENDING_VERIFY" state set.
  227. This state prevents the re-run of this app. After the first boot of the new app in the user code, the
  228. function should be called to confirm the operability of the app or vice versa about its non-operability.
  229. If the app is working, then it is marked as valid. Otherwise, it is marked as not valid and rolls back to
  230. the previous working app. A reboot is performed, and the app is booted before the software update.
  231. Note: If during the first boot a new app the power goes out or the WDT works, then roll back will happen.
  232. Rollback is possible only between the apps with the same security versions.
  233. config BOOTLOADER_APP_ANTI_ROLLBACK
  234. bool "Enable app anti-rollback support"
  235. depends on BOOTLOADER_APP_ROLLBACK_ENABLE
  236. default n
  237. help
  238. This option prevents rollback to previous firmware/application image with lower security version.
  239. config BOOTLOADER_APP_SECURE_VERSION
  240. int "eFuse secure version of app"
  241. depends on BOOTLOADER_APP_ANTI_ROLLBACK
  242. default 0
  243. help
  244. The secure version is the sequence number stored in the header of each firmware.
  245. The security version is set in the bootloader, version is recorded in the eFuse field
  246. as the number of set ones. The allocated number of bits in the efuse field
  247. for storing the security version is limited (see BOOTLOADER_APP_SEC_VER_SIZE_EFUSE_FIELD option).
  248. Bootloader: When bootloader selects an app to boot, an app is selected that has
  249. a security version greater or equal that recorded in eFuse field.
  250. The app is booted with a higher (or equal) secure version.
  251. The security version is worth increasing if in previous versions there is
  252. a significant vulnerability and their use is not acceptable.
  253. Your partition table should has a scheme with ota_0 + ota_1 (without factory).
  254. config BOOTLOADER_APP_SEC_VER_SIZE_EFUSE_FIELD
  255. int "Size of the efuse secure version field"
  256. depends on BOOTLOADER_APP_ANTI_ROLLBACK
  257. range 1 32 if IDF_TARGET_ESP32
  258. default 32 if IDF_TARGET_ESP32
  259. range 1 4 if IDF_TARGET_ESP32C2
  260. default 4 if IDF_TARGET_ESP32C2
  261. range 1 16
  262. default 16
  263. help
  264. The size of the efuse secure version field.
  265. Its length is limited to 32 bits for ESP32 and 16 bits for ESP32-S2.
  266. This determines how many times the security version can be increased.
  267. config BOOTLOADER_EFUSE_SECURE_VERSION_EMULATE
  268. bool "Emulate operations with efuse secure version(only test)"
  269. default n
  270. depends on BOOTLOADER_APP_ANTI_ROLLBACK
  271. select EFUSE_VIRTUAL
  272. select EFUSE_VIRTUAL_KEEP_IN_FLASH
  273. help
  274. This option allows to emulate read/write operations with all eFuses and efuse secure version.
  275. It allows to test anti-rollback implemention without permanent write eFuse bits.
  276. There should be an entry in partition table with following details: `emul_efuse, data, efuse, , 0x2000`.
  277. This option enables: EFUSE_VIRTUAL and EFUSE_VIRTUAL_KEEP_IN_FLASH.
  278. config BOOTLOADER_SKIP_VALIDATE_IN_DEEP_SLEEP
  279. bool "Skip image validation when exiting deep sleep"
  280. # note: dependencies for this config item are different to other "skip image validation"
  281. # options, allowing to turn on "allow insecure options" and have secure boot with
  282. # "skip validation when existing deep sleep". Keeping this to avoid a breaking change,
  283. # but - as noted in help - it invalidates the integrity of Secure Boot checks
  284. depends on SOC_RTC_FAST_MEM_SUPPORTED && ((SECURE_BOOT && SECURE_BOOT_INSECURE) || !SECURE_BOOT)
  285. default n
  286. select BOOTLOADER_RESERVE_RTC_MEM
  287. help
  288. This option disables the normal validation of an image coming out of
  289. deep sleep (checksums, SHA256, and signature). This is a trade-off
  290. between wakeup performance from deep sleep, and image integrity checks.
  291. Only enable this if you know what you are doing. It should not be used
  292. in conjunction with using deep_sleep() entry and changing the active OTA
  293. partition as this would skip the validation upon first load of the new
  294. OTA partition.
  295. It is possible to enable this option with Secure Boot if "allow insecure
  296. options" is enabled, however it's strongly recommended to NOT enable it as
  297. it may allow a Secure Boot bypass.
  298. config BOOTLOADER_SKIP_VALIDATE_ON_POWER_ON
  299. bool "Skip image validation from power on reset (READ HELP FIRST)"
  300. # only available if both Secure Boot and Check Signature on Boot are disabled
  301. depends on !SECURE_SIGNED_ON_BOOT
  302. default n
  303. help
  304. Some applications need to boot very quickly from power on. By default, the entire app binary
  305. is read from flash and verified which takes up a significant portion of the boot time.
  306. Enabling this option will skip validation of the app when the SoC boots from power on.
  307. Note that in this case it's not possible for the bootloader to detect if an app image is
  308. corrupted in the flash, therefore it's not possible to safely fall back to a different app
  309. partition. Flash corruption of this kind is unlikely but can happen if there is a serious
  310. firmware bug or physical damage.
  311. Following other reset types, the bootloader will still validate the app image. This increases
  312. the chances that flash corruption resulting in a crash can be detected following soft reset, and
  313. the bootloader will fall back to a valid app image. To increase the chances of successfully recovering
  314. from a flash corruption event, keep the option BOOTLOADER_WDT_ENABLE enabled and consider also enabling
  315. BOOTLOADER_WDT_DISABLE_IN_USER_CODE - then manually disable the RTC Watchdog once the app is running.
  316. In addition, enable both the Task and Interrupt watchdog timers with reset options set.
  317. config BOOTLOADER_SKIP_VALIDATE_ALWAYS
  318. bool "Skip image validation always (READ HELP FIRST)"
  319. # only available if both Secure Boot and Check Signature on Boot are disabled
  320. depends on !SECURE_SIGNED_ON_BOOT
  321. default n
  322. select BOOTLOADER_SKIP_VALIDATE_IN_DEEP_SLEEP if SOC_RTC_FAST_MEM_SUPPORTED
  323. select BOOTLOADER_SKIP_VALIDATE_ON_POWER_ON
  324. help
  325. Selecting this option prevents the bootloader from ever validating the app image before
  326. booting it. Any flash corruption of the selected app partition will make the entire SoC
  327. unbootable.
  328. Although flash corruption is a very rare case, it is not recommended to select this option.
  329. Consider selecting "Skip image validation from power on reset" instead. However, if boot time
  330. is the only important factor then it can be enabled.
  331. config BOOTLOADER_RESERVE_RTC_SIZE
  332. hex
  333. depends on SOC_RTC_FAST_MEM_SUPPORTED
  334. default 0x10 if BOOTLOADER_RESERVE_RTC_MEM
  335. default 0
  336. help
  337. Reserve RTC FAST memory for Skip image validation. This option in bytes.
  338. This option reserves an area in the RTC FAST memory (access only PRO_CPU).
  339. Used to save the addresses of the selected application.
  340. When a wakeup occurs (from Deep sleep), the bootloader retrieves it and
  341. loads the application without validation.
  342. config BOOTLOADER_CUSTOM_RESERVE_RTC
  343. bool "Reserve RTC FAST memory for custom purposes"
  344. depends on SOC_RTC_FAST_MEM_SUPPORTED
  345. select BOOTLOADER_RESERVE_RTC_MEM
  346. default n
  347. help
  348. This option allows the customer to place data in the RTC FAST memory,
  349. this area remains valid when rebooted, except for power loss.
  350. This memory is located at a fixed address and is available
  351. for both the bootloader and the application.
  352. (The application and bootoloader must be compiled with the same option).
  353. The RTC FAST memory has access only through PRO_CPU.
  354. config BOOTLOADER_CUSTOM_RESERVE_RTC_SIZE
  355. hex "Size in bytes for custom purposes"
  356. default 0
  357. depends on BOOTLOADER_CUSTOM_RESERVE_RTC
  358. help
  359. This option reserves in RTC FAST memory the area for custom purposes.
  360. If you want to create your own bootloader and save more information
  361. in this area of memory, you can increase it. It must be a multiple of 4 bytes.
  362. This area (rtc_retain_mem_t) is reserved and has access from the bootloader and an application.
  363. config BOOTLOADER_RESERVE_RTC_MEM
  364. bool
  365. depends on SOC_RTC_FAST_MEM_SUPPORTED
  366. help
  367. This option reserves an area in RTC FAST memory for the following features:
  368. - "Skip image validation when exiting deep sleep"
  369. - "Reserve RTC FAST memory for custom purposes"
  370. - "GPIO triggers factory reset"
  371. config BOOTLOADER_FLASH_XMC_SUPPORT
  372. bool "Enable the support for flash chips of XMC (READ HELP FIRST)"
  373. default y
  374. depends on !IDF_ENV_BRINGUP
  375. help
  376. Perform the startup flow recommended by XMC. Please consult XMC for the details of this flow.
  377. XMC chips will be forbidden to be used, when this option is disabled.
  378. DON'T DISABLE THIS UNLESS YOU KNOW WHAT YOU ARE DOING.
  379. endmenu # Bootloader
  380. menu "Security features"
  381. # These three are the actual options to check in code,
  382. # selected by the displayed options
  383. config SECURE_SIGNED_ON_BOOT
  384. bool
  385. default y
  386. depends on SECURE_BOOT || SECURE_SIGNED_ON_BOOT_NO_SECURE_BOOT
  387. config SECURE_SIGNED_ON_UPDATE
  388. bool
  389. default y
  390. depends on SECURE_BOOT || SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT
  391. config SECURE_SIGNED_APPS
  392. bool
  393. default y
  394. select MBEDTLS_ECP_DP_SECP256R1_ENABLED
  395. select MBEDTLS_ECP_C
  396. select MBEDTLS_ECDH_C
  397. select MBEDTLS_ECDSA_C
  398. depends on SECURE_SIGNED_ON_BOOT || SECURE_SIGNED_ON_UPDATE
  399. config SECURE_BOOT_V2_RSA_SUPPORTED
  400. bool
  401. default y
  402. # RSA secure boot is supported in ESP32 revision >= v3.0
  403. depends on (IDF_TARGET_ESP32 && ESP32_REV_MIN_FULL >= 300) || SOC_SECURE_BOOT_V2_RSA
  404. config SECURE_BOOT_V2_ECC_SUPPORTED
  405. bool
  406. default y
  407. depends on SOC_SECURE_BOOT_V2_ECC
  408. config SECURE_BOOT_V1_SUPPORTED
  409. bool
  410. default y
  411. depends on SOC_SECURE_BOOT_V1
  412. config SECURE_BOOT_V2_PREFERRED
  413. bool
  414. default y
  415. depends on ESP32_REV_MIN_FULL >= 300
  416. config SECURE_BOOT_V2_ECDSA_ENABLED
  417. bool
  418. default y if SECURE_BOOT_V2_ENABLED && SECURE_BOOT_V2_ECC_SUPPORTED
  419. config SECURE_BOOT_V2_RSA_ENABLED
  420. bool
  421. default y if SECURE_BOOT_V2_ENABLED && SECURE_BOOT_V2_RSA_SUPPORTED
  422. config SECURE_BOOT_FLASH_ENC_KEYS_BURN_TOGETHER
  423. bool
  424. default y if SOC_EFUSE_CONSISTS_OF_ONE_KEY_BLOCK && SECURE_BOOT && SECURE_FLASH_ENC_ENABLED
  425. # ESP32-C2 has one key block for SB and FE keys. These keys must be burned at the same time.
  426. config SECURE_SIGNED_APPS_NO_SECURE_BOOT
  427. bool "Require signed app images"
  428. depends on !SECURE_BOOT
  429. help
  430. Require apps to be signed to verify their integrity.
  431. This option uses the same app signature scheme as hardware secure boot, but unlike hardware secure boot it
  432. does not prevent the bootloader from being physically updated. This means that the device can be secured
  433. against remote network access, but not physical access. Compared to using hardware Secure Boot this option
  434. is much simpler to implement.
  435. choice SECURE_SIGNED_APPS_SCHEME
  436. bool "App Signing Scheme"
  437. depends on SECURE_BOOT || SECURE_SIGNED_APPS_NO_SECURE_BOOT
  438. default SECURE_SIGNED_APPS_ECDSA_SCHEME if SECURE_BOOT_V1_ENABLED
  439. default SECURE_SIGNED_APPS_RSA_SCHEME if SECURE_BOOT_V2_RSA_SUPPORTED
  440. default SECURE_SIGNED_APPS_ECDSA_V2_SCHEME if SECURE_BOOT_V2_ECC_SUPPORTED
  441. help
  442. Select the Secure App signing scheme. Depends on the Chip Revision.
  443. There are two secure boot versions:
  444. 1. Secure boot V1
  445. - Legacy custom secure boot scheme. Supported in ESP32 SoC.
  446. 2. Secure boot V2
  447. - RSA based secure boot scheme.
  448. Supported in ESP32-ECO3 (ESP32 Chip Revision 3 onwards), ESP32-S2, ESP32-C3, ESP32-S3 SoCs.
  449. - ECDSA based secure boot scheme. Supported in ESP32-C2 SoC.
  450. config SECURE_SIGNED_APPS_ECDSA_SCHEME
  451. bool "ECDSA"
  452. depends on SECURE_BOOT_V1_SUPPORTED && (SECURE_SIGNED_APPS_NO_SECURE_BOOT || SECURE_BOOT_V1_ENABLED)
  453. help
  454. Embeds the ECDSA public key in the bootloader and signs the application with an ECDSA key.
  455. Refer to the documentation before enabling.
  456. config SECURE_SIGNED_APPS_RSA_SCHEME
  457. bool "RSA"
  458. depends on SECURE_BOOT_V2_RSA_SUPPORTED && (SECURE_SIGNED_APPS_NO_SECURE_BOOT || SECURE_BOOT_V2_ENABLED)
  459. help
  460. Appends the RSA-3072 based Signature block to the application.
  461. Refer to <Secure Boot Version 2 documentation link> before enabling.
  462. config SECURE_SIGNED_APPS_ECDSA_V2_SCHEME
  463. bool "ECDSA (V2)"
  464. depends on SECURE_BOOT_V2_ECC_SUPPORTED && (SECURE_SIGNED_APPS_NO_SECURE_BOOT || SECURE_BOOT_V2_ENABLED)
  465. help
  466. For Secure boot V2 (e.g., ESP32-C2 SoC), appends ECDSA based signature block to the application.
  467. Refer to documentation before enabling.
  468. endchoice
  469. choice SECURE_BOOT_ECDSA_KEY_LEN_SIZE
  470. bool "ECDSA key size"
  471. depends on SECURE_SIGNED_APPS_ECDSA_V2_SCHEME
  472. default SECURE_BOOT_ECDSA_KEY_LEN_256_BITS
  473. help
  474. Select the ECDSA key size. Two key sizes are supported
  475. - 192 bit key using NISTP192 curve
  476. - 256 bit key using NISTP256 curve (Recommended)
  477. The advantage of using 256 bit key is the extra randomness which makes it difficult to be
  478. bruteforced compared to 192 bit key.
  479. At present, both key sizes are practically implausible to bruteforce.
  480. config SECURE_BOOT_ECDSA_KEY_LEN_192_BITS
  481. bool "Using ECC curve NISTP192"
  482. depends on SECURE_SIGNED_APPS_ECDSA_V2_SCHEME
  483. config SECURE_BOOT_ECDSA_KEY_LEN_256_BITS
  484. bool "Using ECC curve NISTP256 (Recommended)"
  485. depends on SECURE_SIGNED_APPS_ECDSA_V2_SCHEME
  486. endchoice
  487. config SECURE_SIGNED_ON_BOOT_NO_SECURE_BOOT
  488. bool "Bootloader verifies app signatures"
  489. default n
  490. depends on SECURE_SIGNED_APPS_NO_SECURE_BOOT && SECURE_SIGNED_APPS_ECDSA_SCHEME
  491. help
  492. If this option is set, the bootloader will be compiled with code to verify that an app is signed before
  493. booting it.
  494. If hardware secure boot is enabled, this option is always enabled and cannot be disabled.
  495. If hardware secure boot is not enabled, this option doesn't add significant security by itself so most
  496. users will want to leave it disabled.
  497. config SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT
  498. bool "Verify app signature on update"
  499. default y
  500. depends on SECURE_SIGNED_APPS_NO_SECURE_BOOT
  501. help
  502. If this option is set, any OTA updated apps will have the signature verified before being considered valid.
  503. When enabled, the signature is automatically checked whenever the esp_ota_ops.h APIs are used for OTA
  504. updates, or esp_image_format.h APIs are used to verify apps.
  505. If hardware secure boot is enabled, this option is always enabled and cannot be disabled.
  506. If hardware secure boot is not enabled, this option still adds significant security against network-based
  507. attackers by preventing spoofing of OTA updates.
  508. config SECURE_BOOT
  509. bool "Enable hardware Secure Boot in bootloader (READ DOCS FIRST)"
  510. default n
  511. # Secure boot is not supported for ESP32-C3 revision < v0.3
  512. depends on SOC_SECURE_BOOT_SUPPORTED && !(IDF_TARGET_ESP32C3 && ESP32C3_REV_MIN_FULL < 3)
  513. select ESPTOOLPY_NO_STUB if !IDF_TARGET_ESP32 && !IDF_TARGET_ESP32S2
  514. help
  515. Build a bootloader which enables Secure Boot on first boot.
  516. Once enabled, Secure Boot will not boot a modified bootloader. The bootloader will only load a partition
  517. table or boot an app if the data has a verified digital signature. There are implications for reflashing
  518. updated apps once secure boot is enabled.
  519. When enabling secure boot, JTAG and ROM BASIC Interpreter are permanently disabled by default.
  520. choice SECURE_BOOT_VERSION
  521. bool "Select secure boot version"
  522. default SECURE_BOOT_V2_ENABLED if SECURE_BOOT_V2_PREFERRED
  523. depends on SECURE_BOOT
  524. help
  525. Select the Secure Boot Version. Depends on the Chip Revision.
  526. Secure Boot V2 is the new RSA / ECDSA based secure boot scheme.
  527. - RSA based scheme is supported in ESP32 (Revision 3 onwards), ESP32-S2, ESP32-C3 (ECO3), ESP32-S3.
  528. - ECDSA based scheme is supported in ESP32-C2 SoC.
  529. Please note that, RSA or ECDSA secure boot is property of specific SoC based on its HW design, supported
  530. crypto accelerators, die-size, cost and similar parameters. Please note that RSA scheme has requirement
  531. for bigger key sizes but at the same time it is comparatively faster than ECDSA verification.
  532. Secure Boot V1 is the AES based (custom) secure boot scheme supported in ESP32 SoC.
  533. config SECURE_BOOT_V1_ENABLED
  534. bool "Enable Secure Boot version 1"
  535. depends on SECURE_BOOT_V1_SUPPORTED
  536. help
  537. Build a bootloader which enables secure boot version 1 on first boot.
  538. Refer to the Secure Boot section of the ESP-IDF Programmer's Guide for this version before enabling.
  539. config SECURE_BOOT_V2_ENABLED
  540. bool "Enable Secure Boot version 2"
  541. depends on SECURE_BOOT_V2_RSA_SUPPORTED || SECURE_BOOT_V2_ECC_SUPPORTED
  542. help
  543. Build a bootloader which enables Secure Boot version 2 on first boot.
  544. Refer to Secure Boot V2 section of the ESP-IDF Programmer's Guide for this version before enabling.
  545. endchoice
  546. choice SECURE_BOOTLOADER_MODE
  547. bool "Secure bootloader mode"
  548. depends on SECURE_BOOT_V1_ENABLED
  549. default SECURE_BOOTLOADER_ONE_TIME_FLASH
  550. config SECURE_BOOTLOADER_ONE_TIME_FLASH
  551. bool "One-time flash"
  552. help
  553. On first boot, the bootloader will generate a key which is not readable externally or by software. A
  554. digest is generated from the bootloader image itself. This digest will be verified on each subsequent
  555. boot.
  556. Enabling this option means that the bootloader cannot be changed after the first time it is booted.
  557. config SECURE_BOOTLOADER_REFLASHABLE
  558. bool "Reflashable"
  559. help
  560. Generate a reusable secure bootloader key, derived (via SHA-256) from the secure boot signing key.
  561. This allows the secure bootloader to be re-flashed by anyone with access to the secure boot signing
  562. key.
  563. This option is less secure than one-time flash, because a leak of the digest key from one device
  564. allows reflashing of any device that uses it.
  565. endchoice
  566. config SECURE_BOOT_BUILD_SIGNED_BINARIES
  567. bool "Sign binaries during build"
  568. depends on SECURE_SIGNED_APPS
  569. default y
  570. help
  571. Once secure boot or signed app requirement is enabled, app images are required to be signed.
  572. If enabled (default), these binary files are signed as part of the build process. The file named in
  573. "Secure boot private signing key" will be used to sign the image.
  574. If disabled, unsigned app/partition data will be built. They must be signed manually using espsecure.py.
  575. Version 1 to enable ECDSA Based Secure Boot and Version 2 to enable RSA based Secure Boot.
  576. (for example, on a remote signing server.)
  577. config SECURE_BOOT_SIGNING_KEY
  578. string "Secure boot private signing key"
  579. depends on SECURE_BOOT_BUILD_SIGNED_BINARIES
  580. default "secure_boot_signing_key.pem"
  581. help
  582. Path to the key file used to sign app images.
  583. Key file is an ECDSA private key (NIST256p curve) in PEM format for Secure Boot V1.
  584. Key file is an RSA private key in PEM format for Secure Boot V2.
  585. Path is evaluated relative to the project directory.
  586. You can generate a new signing key by running the following command:
  587. espsecure.py generate_signing_key secure_boot_signing_key.pem
  588. See the Secure Boot section of the ESP-IDF Programmer's Guide for this version for details.
  589. config SECURE_BOOT_VERIFICATION_KEY
  590. string "Secure boot public signature verification key"
  591. depends on SECURE_SIGNED_APPS && !SECURE_BOOT_BUILD_SIGNED_BINARIES && !SECURE_SIGNED_APPS_RSA_SCHEME
  592. default "signature_verification_key.bin"
  593. help
  594. Path to a public key file used to verify signed images.
  595. Secure Boot V1: This ECDSA public key is compiled into the bootloader and/or
  596. app, to verify app images.
  597. Secure Boot V2: This RSA public key is compiled into the signature block at
  598. the end of the bootloader/app.
  599. Key file is in raw binary format, and can be extracted from a
  600. PEM formatted private key using the espsecure.py
  601. extract_public_key command.
  602. Refer to the Secure Boot section of the ESP-IDF Programmer's Guide for this version before enabling.
  603. config SECURE_BOOT_ENABLE_AGGRESSIVE_KEY_REVOKE
  604. bool "Enable Aggressive key revoke strategy"
  605. depends on SECURE_BOOT && SOC_SUPPORT_SECURE_BOOT_REVOKE_KEY
  606. default N
  607. help
  608. If this option is set, ROM bootloader will revoke the public key digest burned in efuse block
  609. if it fails to verify the signature of software bootloader with it.
  610. Revocation of keys does not happen when enabling secure boot. Once secure boot is enabled,
  611. key revocation checks will be done on subsequent boot-up, while verifying the software bootloader
  612. This feature provides a strong resistance against physical attacks on the device.
  613. NOTE: Once a digest slot is revoked, it can never be used again to verify an image
  614. This can lead to permanent bricking of the device, in case all keys are revoked
  615. because of signature verification failure.
  616. config SECURE_BOOT_FLASH_BOOTLOADER_DEFAULT
  617. bool "Flash bootloader along with other artifacts when using the default flash command"
  618. depends on SECURE_BOOT_V2_ENABLED && SECURE_BOOT_BUILD_SIGNED_BINARIES
  619. default N
  620. help
  621. When Secure Boot V2 is enabled, by default the bootloader is not flashed along with other artifacts
  622. like the application and the partition table images, i.e. bootloader has to be seperately flashed
  623. using the command `idf.py bootloader flash`, whereas, the application and partition table can be flashed
  624. using the command `idf.py flash` itself.
  625. Enabling this option allows flashing the bootloader along with the other artifacts
  626. by invocation of the command `idf.py flash`.
  627. If this option is enabled make sure that even the bootloader is signed using the correct secure boot key,
  628. otherwise the bootloader signature verification would fail, as hash of the public key which is present in
  629. the bootloader signature would not match with the digest stored into the efuses
  630. and thus the device will not be able to boot up.
  631. choice SECURE_BOOTLOADER_KEY_ENCODING
  632. bool "Hardware Key Encoding"
  633. depends on SECURE_BOOTLOADER_REFLASHABLE
  634. default SECURE_BOOTLOADER_KEY_ENCODING_256BIT
  635. help
  636. In reflashable secure bootloader mode, a hardware key is derived from the signing key (with SHA-256) and
  637. can be written to eFuse with espefuse.py.
  638. Normally this is a 256-bit key, but if 3/4 Coding Scheme is used on the device then the eFuse key is
  639. truncated to 192 bits.
  640. This configuration item doesn't change any firmware code, it only changes the size of key binary which is
  641. generated at build time.
  642. config SECURE_BOOTLOADER_KEY_ENCODING_256BIT
  643. bool "No encoding (256 bit key)"
  644. config SECURE_BOOTLOADER_KEY_ENCODING_192BIT
  645. bool "3/4 encoding (192 bit key)"
  646. endchoice
  647. config SECURE_BOOT_INSECURE
  648. bool "Allow potentially insecure options"
  649. depends on SECURE_BOOT
  650. default N
  651. help
  652. You can disable some of the default protections offered by secure boot, in order to enable testing or a
  653. custom combination of security features.
  654. Only enable these options if you are very sure.
  655. Refer to the Secure Boot section of the ESP-IDF Programmer's Guide for this version before enabling.
  656. config SECURE_FLASH_ENC_ENABLED
  657. bool "Enable flash encryption on boot (READ DOCS FIRST)"
  658. default N
  659. select SPI_FLASH_ENABLE_ENCRYPTED_READ_WRITE
  660. select NVS_ENCRYPTION
  661. help
  662. If this option is set, flash contents will be encrypted by the bootloader on first boot.
  663. Note: After first boot, the system will be permanently encrypted. Re-flashing an encrypted
  664. system is complicated and not always possible.
  665. Read https://docs.espressif.com/projects/esp-idf/en/latest/security/flash-encryption.html
  666. before enabling.
  667. choice SECURE_FLASH_ENCRYPTION_KEYSIZE
  668. bool "Size of generated XTS-AES key"
  669. default SECURE_FLASH_ENCRYPTION_AES128
  670. depends on SOC_FLASH_ENCRYPTION_XTS_AES_OPTIONS && SECURE_FLASH_ENC_ENABLED
  671. help
  672. Size of generated XTS-AES key.
  673. - AES-128 uses a 256-bit key (32 bytes) derived from 128 bits (16 bytes) burned in half Efuse key block.
  674. Internally, it calculates SHA256(128 bits)
  675. - AES-128 uses a 256-bit key (32 bytes) which occupies one Efuse key block.
  676. - AES-256 uses a 512-bit key (64 bytes) which occupies two Efuse key blocks.
  677. This setting is ignored if either type of key is already burned to Efuse before the first boot.
  678. In this case, the pre-burned key is used and no new key is generated.
  679. config SECURE_FLASH_ENCRYPTION_AES128_DERIVED
  680. bool "AES-128 key derived from 128 bits (SHA256(128 bits))"
  681. depends on SOC_FLASH_ENCRYPTION_XTS_AES_128_DERIVED
  682. config SECURE_FLASH_ENCRYPTION_AES128
  683. bool "AES-128 (256-bit key)"
  684. depends on SOC_FLASH_ENCRYPTION_XTS_AES_128 && !(IDF_TARGET_ESP32C2 && SECURE_BOOT)
  685. config SECURE_FLASH_ENCRYPTION_AES256
  686. bool "AES-256 (512-bit key)"
  687. depends on SOC_FLASH_ENCRYPTION_XTS_AES_256
  688. endchoice
  689. choice SECURE_FLASH_ENCRYPTION_MODE
  690. bool "Enable usage mode"
  691. depends on SECURE_FLASH_ENC_ENABLED
  692. default SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
  693. help
  694. By default Development mode is enabled which allows ROM download mode to perform flash encryption
  695. operations (plaintext is sent to the device, and it encrypts it internally and writes ciphertext
  696. to flash.) This mode is not secure, it's possible for an attacker to write their own chosen plaintext
  697. to flash.
  698. Release mode should always be selected for production or manufacturing. Once enabled it's no longer
  699. possible for the device in ROM Download Mode to use the flash encryption hardware.
  700. When EFUSE_VIRTUAL is enabled, SECURE_FLASH_ENCRYPTION_MODE_RELEASE is not available.
  701. For CI tests we use IDF_CI_BUILD to bypass it ("export IDF_CI_BUILD=1").
  702. We do not recommend bypassing it for other purposes.
  703. Refer to the Flash Encryption section of the ESP-IDF Programmer's Guide for details.
  704. config SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
  705. bool "Development (NOT SECURE)"
  706. select SECURE_FLASH_UART_BOOTLOADER_ALLOW_ENC
  707. config SECURE_FLASH_ENCRYPTION_MODE_RELEASE
  708. bool "Release"
  709. select PARTITION_TABLE_MD5 if !APP_COMPATIBLE_PRE_V3_1_BOOTLOADERS
  710. depends on !EFUSE_VIRTUAL || IDF_CI_BUILD
  711. endchoice
  712. config SECURE_FLASH_HAS_WRITE_PROTECTION_CACHE
  713. bool
  714. default y if (SOC_EFUSE_DIS_ICACHE || IDF_TARGET_ESP32) && SECURE_FLASH_ENC_ENABLED
  715. menu "Potentially insecure options"
  716. visible if SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT || SECURE_BOOT_INSECURE || SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT # NOERROR
  717. # NOTE: Options in this menu NEED to have SECURE_BOOT_INSECURE
  718. # and/or SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT in "depends on", as the menu
  719. # itself doesn't enable/disable its children (if it's not set,
  720. # it's possible for the insecure menu to be disabled but the insecure option
  721. # to remain on which is very bad.)
  722. config SECURE_BOOT_ALLOW_ROM_BASIC
  723. bool "Leave ROM BASIC Interpreter available on reset"
  724. depends on (SECURE_BOOT_INSECURE || SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT) && IDF_TARGET_ESP32
  725. default N
  726. help
  727. By default, the BASIC ROM Console starts on reset if no valid bootloader is
  728. read from the flash.
  729. When either flash encryption or secure boot are enabled, the default is to
  730. disable this BASIC fallback mode permanently via eFuse.
  731. If this option is set, this eFuse is not burned and the BASIC ROM Console may
  732. remain accessible. Only set this option in testing environments.
  733. config SECURE_BOOT_ALLOW_JTAG
  734. bool "Allow JTAG Debugging"
  735. depends on SECURE_BOOT_INSECURE || SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
  736. select SECURE_FLASH_SKIP_WRITE_PROTECTION_CACHE if SECURE_FLASH_HAS_WRITE_PROTECTION_CACHE
  737. default N
  738. help
  739. If not set (default), the bootloader will permanently disable JTAG (across entire chip) on first boot
  740. when either secure boot or flash encryption is enabled.
  741. Setting this option leaves JTAG on for debugging, which negates all protections of flash encryption
  742. and some of the protections of secure boot.
  743. Only set this option in testing environments.
  744. config SECURE_BOOT_ALLOW_SHORT_APP_PARTITION
  745. bool "Allow app partition length not 64KB aligned"
  746. depends on SECURE_BOOT_INSECURE || SECURE_SIGNED_ON_UPDATE_NO_SECURE_BOOT
  747. help
  748. If not set (default), app partition size must be a multiple of 64KB. App images are padded to 64KB
  749. length, and the bootloader checks any trailing bytes after the signature (before the next 64KB
  750. boundary) have not been written. This is because flash cache maps entire 64KB pages into the address
  751. space. This prevents an attacker from appending unverified data after the app image in the flash,
  752. causing it to be mapped into the address space.
  753. Setting this option allows the app partition length to be unaligned, and disables padding of the app
  754. image to this length. It is generally not recommended to set this option, unless you have a legacy
  755. partitioning scheme which doesn't support 64KB aligned partition lengths.
  756. config SECURE_BOOT_V2_ALLOW_EFUSE_RD_DIS
  757. bool "Allow additional read protecting of efuses"
  758. depends on SECURE_BOOT_INSECURE && SECURE_BOOT_V2_ENABLED
  759. help
  760. If not set (default, recommended), on first boot the bootloader will burn the WR_DIS_RD_DIS
  761. efuse when Secure Boot is enabled. This prevents any more efuses from being read protected.
  762. If this option is set, it will remain possible to write the EFUSE_RD_DIS efuse field after Secure
  763. Boot is enabled. This may allow an attacker to read-protect the BLK2 efuse (for ESP32) and
  764. BLOCK4-BLOCK10 (i.e. BLOCK_KEY0-BLOCK_KEY5)(for other chips) holding the public key digest, causing an
  765. immediate denial of service and possibly allowing an additional fault injection attack to
  766. bypass the signature protection.
  767. NOTE: Once a BLOCK is read-protected, the application will read all zeros from that block
  768. NOTE: If "UART ROM download mode (Permanently disabled (recommended))" or
  769. "UART ROM download mode (Permanently switch to Secure mode (recommended))" is set,
  770. then it is __NOT__ possible to read/write efuses using espefuse.py utility.
  771. However, efuse can be read/written from the application
  772. config SECURE_BOOT_ALLOW_UNUSED_DIGEST_SLOTS
  773. bool "Leave unused digest slots available (not revoke)"
  774. depends on SECURE_BOOT_INSECURE && SOC_EFUSE_REVOKE_BOOT_KEY_DIGESTS
  775. default N
  776. help
  777. If not set (default), during startup in the app all unused digest slots will be revoked.
  778. To revoke unused slot will be called esp_efuse_set_digest_revoke(num_digest) for each digest.
  779. Revoking unused digest slots makes ensures that no trusted keys can be added later by an attacker.
  780. If set, it means that you have a plan to use unused digests slots later.
  781. config SECURE_FLASH_UART_BOOTLOADER_ALLOW_ENC
  782. bool "Leave UART bootloader encryption enabled"
  783. depends on SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
  784. select SECURE_FLASH_SKIP_WRITE_PROTECTION_CACHE if SECURE_FLASH_HAS_WRITE_PROTECTION_CACHE
  785. default N
  786. help
  787. If not set (default), the bootloader will permanently disable UART bootloader encryption access on
  788. first boot. If set, the UART bootloader will still be able to access hardware encryption.
  789. It is recommended to only set this option in testing environments.
  790. config SECURE_FLASH_UART_BOOTLOADER_ALLOW_DEC
  791. bool "Leave UART bootloader decryption enabled"
  792. depends on SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT && IDF_TARGET_ESP32
  793. default N
  794. help
  795. If not set (default), the bootloader will permanently disable UART bootloader decryption access on
  796. first boot. If set, the UART bootloader will still be able to access hardware decryption.
  797. Only set this option in testing environments. Setting this option allows complete bypass of flash
  798. encryption.
  799. config SECURE_FLASH_UART_BOOTLOADER_ALLOW_CACHE
  800. bool "Leave UART bootloader flash cache enabled"
  801. depends on SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT && (IDF_TARGET_ESP32 || SOC_EFUSE_DIS_DOWNLOAD_ICACHE || SOC_EFUSE_DIS_DOWNLOAD_DCACHE) # NOERROR
  802. default N
  803. select SECURE_FLASH_SKIP_WRITE_PROTECTION_CACHE if SECURE_FLASH_HAS_WRITE_PROTECTION_CACHE
  804. help
  805. If not set (default), the bootloader will permanently disable UART bootloader flash cache access on
  806. first boot. If set, the UART bootloader will still be able to access the flash cache.
  807. Only set this option in testing environments.
  808. config SECURE_FLASH_REQUIRE_ALREADY_ENABLED
  809. bool "Require flash encryption to be already enabled"
  810. depends on SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
  811. default N
  812. help
  813. If not set (default), and flash encryption is not yet enabled in eFuses, the 2nd stage bootloader
  814. will enable flash encryption: generate the flash encryption key and program eFuses.
  815. If this option is set, and flash encryption is not yet enabled, the bootloader will error out and
  816. reboot.
  817. If flash encryption is enabled in eFuses, this option does not change the bootloader behavior.
  818. Only use this option in testing environments, to avoid accidentally enabling flash encryption on
  819. the wrong device. The device needs to have flash encryption already enabled using espefuse.py.
  820. config SECURE_FLASH_SKIP_WRITE_PROTECTION_CACHE
  821. bool "Skip write-protection of DIS_CACHE (DIS_ICACHE, DIS_DCACHE)"
  822. default n
  823. depends on SECURE_FLASH_HAS_WRITE_PROTECTION_CACHE
  824. help
  825. If not set (default, recommended), on the first boot the bootloader will burn the write-protection of
  826. DIS_CACHE(for ESP32) or DIS_ICACHE/DIS_DCACHE(for other chips) eFuse when Flash Encryption is enabled.
  827. Write protection for cache disable efuse prevents the chip from being blocked if it is set by accident.
  828. App and bootloader use cache so disabling it makes the chip useless for IDF.
  829. Due to other eFuses are linked with the same write protection bit (see the list below) then
  830. write-protection will not be done if these SECURE_FLASH_UART_BOOTLOADER_ALLOW_ENC,
  831. SECURE_BOOT_ALLOW_JTAG or SECURE_FLASH_UART_BOOTLOADER_ALLOW_CACHE options are selected
  832. to give a chance to turn on the chip into the release mode later.
  833. List of eFuses with the same write protection bit:
  834. ESP32: MAC, MAC_CRC, DISABLE_APP_CPU, DISABLE_BT, DIS_CACHE, VOL_LEVEL_HP_INV.
  835. ESP32-C3: DIS_ICACHE, DIS_USB_JTAG, DIS_DOWNLOAD_ICACHE, DIS_USB_SERIAL_JTAG,
  836. DIS_FORCE_DOWNLOAD, DIS_TWAI, JTAG_SEL_ENABLE, DIS_PAD_JTAG, DIS_DOWNLOAD_MANUAL_ENCRYPT.
  837. ESP32-C6: SWAP_UART_SDIO_EN, DIS_ICACHE, DIS_USB_JTAG, DIS_DOWNLOAD_ICACHE,
  838. DIS_USB_SERIAL_JTAG, DIS_FORCE_DOWNLOAD, DIS_TWAI, JTAG_SEL_ENABLE,
  839. DIS_PAD_JTAG, DIS_DOWNLOAD_MANUAL_ENCRYPT.
  840. ESP32-H2: DIS_ICACHE, DIS_USB_JTAG, POWERGLITCH_EN, DIS_FORCE_DOWNLOAD, SPI_DOWNLOAD_MSPI_DIS,
  841. DIS_TWAI, JTAG_SEL_ENABLE, DIS_PAD_JTAG, DIS_DOWNLOAD_MANUAL_ENCRYPT.
  842. ESP32-S2: DIS_ICACHE, DIS_DCACHE, DIS_DOWNLOAD_ICACHE, DIS_DOWNLOAD_DCACHE,
  843. DIS_FORCE_DOWNLOAD, DIS_USB, DIS_TWAI, DIS_BOOT_REMAP, SOFT_DIS_JTAG,
  844. HARD_DIS_JTAG, DIS_DOWNLOAD_MANUAL_ENCRYPT.
  845. ESP32-S3: DIS_ICACHE, DIS_DCACHE, DIS_DOWNLOAD_ICACHE, DIS_DOWNLOAD_DCACHE,
  846. DIS_FORCE_DOWNLOAD, DIS_USB_OTG, DIS_TWAI, DIS_APP_CPU, DIS_PAD_JTAG,
  847. DIS_DOWNLOAD_MANUAL_ENCRYPT, DIS_USB_JTAG, DIS_USB_SERIAL_JTAG, STRAP_JTAG_SEL, USB_PHY_SEL.
  848. endmenu # Potentially Insecure
  849. config SECURE_FLASH_CHECK_ENC_EN_IN_APP
  850. bool "Check Flash Encryption enabled on app startup"
  851. depends on SECURE_FLASH_ENC_ENABLED
  852. default y
  853. help
  854. If set (default), in an app during startup code,
  855. there is a check of the flash encryption eFuse bit is on
  856. (as the bootloader should already have set it).
  857. The app requires this bit is on to continue work otherwise abort.
  858. If not set, the app does not care if the flash encryption eFuse bit is set or not.
  859. config SECURE_ROM_DL_MODE_ENABLED
  860. bool
  861. default y if SOC_SUPPORTS_SECURE_DL_MODE && !SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
  862. choice SECURE_UART_ROM_DL_MODE
  863. bool "UART ROM download mode"
  864. default SECURE_ENABLE_SECURE_ROM_DL_MODE if SECURE_ROM_DL_MODE_ENABLED # NOERROR
  865. default SECURE_INSECURE_ALLOW_DL_MODE
  866. depends on SECURE_BOOT_V2_ENABLED || SECURE_FLASH_ENC_ENABLED
  867. depends on !(IDF_TARGET_ESP32 && ESP32_REV_MIN_FULL < 300)
  868. config SECURE_DISABLE_ROM_DL_MODE
  869. bool "UART ROM download mode (Permanently disabled (recommended))"
  870. help
  871. If set, during startup the app will burn an eFuse bit to permanently disable the UART ROM
  872. Download Mode. This prevents any future use of esptool.py, espefuse.py and similar tools.
  873. Once disabled, if the SoC is booted with strapping pins set for ROM Download Mode
  874. then an error is printed instead.
  875. It is recommended to enable this option in any production application where Flash
  876. Encryption and/or Secure Boot is enabled and access to Download Mode is not required.
  877. It is also possible to permanently disable Download Mode by calling
  878. esp_efuse_disable_rom_download_mode() at runtime.
  879. config SECURE_ENABLE_SECURE_ROM_DL_MODE
  880. bool "UART ROM download mode (Permanently switch to Secure mode (recommended))"
  881. depends on SOC_SUPPORTS_SECURE_DL_MODE
  882. select ESPTOOLPY_NO_STUB
  883. help
  884. If set, during startup the app will burn an eFuse bit to permanently switch the UART ROM
  885. Download Mode into a separate Secure Download mode. This option can only work if
  886. Download Mode is not already disabled by eFuse.
  887. Secure Download mode limits the use of Download Mode functions to update SPI config,
  888. changing baud rate, basic flash write and a command to return a summary of currently
  889. enabled security features (`get_security_info`).
  890. Secure Download mode is not compatible with the esptool.py flasher stub feature,
  891. espefuse.py, read/writing memory or registers, encrypted download, or any other
  892. features that interact with unsupported Download Mode commands.
  893. Secure Download mode should be enabled in any application where Flash Encryption
  894. and/or Secure Boot is enabled. Disabling this option does not immediately cancel
  895. the benefits of the security features, but it increases the potential "attack
  896. surface" for an attacker to try and bypass them with a successful physical attack.
  897. It is also possible to enable secure download mode at runtime by calling
  898. esp_efuse_enable_rom_secure_download_mode()
  899. Note: Secure Download mode is not available for ESP32 (includes revisions till ECO3).
  900. config SECURE_INSECURE_ALLOW_DL_MODE
  901. bool "UART ROM download mode (Enabled (not recommended))"
  902. help
  903. This is a potentially insecure option.
  904. Enabling this option will allow the full UART download mode to stay enabled.
  905. This option SHOULD NOT BE ENABLED for production use cases.
  906. endchoice
  907. endmenu # Security features