particle-iot · avtolstoy · Jun 19, 2024 · May 16, 2024 · May 20, 2024 · May 21, 2024
diff --git a/bootloader/src/nRF52840/nrf_it.c b/bootloader/src/nRF52840/nrf_it.c
@@ -24,6 +24,7 @@
 #include "hw_config.h"
 #include "button_hal.h"
 #include "hal_platform_nrf52840_config.h"
+#include "security_mode.h"
 
 extern void Timing_Decrement(void);
 
@@ -120,6 +121,7 @@ void UsageFault_Handler(void)
 void SysTick_Handler(void)
 {
     System1MsTick();
+    security_mode_notify_system_tick();
     Timing_Decrement();
 
 #if HAL_PLATFORM_BUTTON_DEBOUNCE_IN_SYSTICK

diff --git a/bootloader/src/rtl872x/rtl_it.c b/bootloader/src/rtl872x/rtl_it.c
@@ -23,6 +23,7 @@
 #include "button_hal.h"
 #include "hal_platform_config.h"
 #include "interrupts_irq.h"
+#include "security_mode.h"
 
 extern void Timing_Decrement(void);
 
@@ -170,6 +171,7 @@ void SecureFault_Handler(void) {
 void SysTick_Handler(void)
 {
     System1MsTick();
+    security_mode_notify_system_tick();
     Timing_Decrement();
 
 #if HAL_PLATFORM_BUTTON_DEBOUNCE_IN_SYSTICK

diff --git a/hal/inc/bootloader.h b/hal/inc/bootloader.h
@@ -36,8 +36,6 @@ int bootloader_update(const void* bootloader_image, unsigned length);
 // Make sure we have only one function to retrieve the bootloader version going forward.
 uint16_t bootloader_get_version(void);
 
-int bootloader_init_security_mode(void* reserved);
-
 #ifdef __cplusplus
 }
 #endif

diff --git a/hal/inc/hal_dynalib_usb.h b/hal/inc/hal_dynalib_usb.h
@@ -43,11 +43,11 @@ DYNALIB_FN(0, hal_usb, HAL_USB_USART_Init, void(HAL_USB_USART_Serial, const HAL_
 DYNALIB_FN(1, hal_usb, HAL_USB_USART_Begin, void(HAL_USB_USART_Serial, uint32_t, void *))
 DYNALIB_FN(2, hal_usb, HAL_USB_USART_End, void(HAL_USB_USART_Serial))
 DYNALIB_FN(3, hal_usb, HAL_USB_USART_Baud_Rate, unsigned int(HAL_USB_USART_Serial))
-DYNALIB_FN(4, hal_usb, HAL_USB_USART_Available_Data, int32_t(HAL_USB_USART_Serial))
-DYNALIB_FN(5, hal_usb, HAL_USB_USART_Available_Data_For_Write, int32_t(HAL_USB_USART_Serial))
-DYNALIB_FN(6, hal_usb, HAL_USB_USART_Receive_Data, int32_t(HAL_USB_USART_Serial, uint8_t))
-DYNALIB_FN(7, hal_usb, HAL_USB_USART_Send_Data, int32_t(HAL_USB_USART_Serial, uint8_t))
-DYNALIB_FN(8, hal_usb, HAL_USB_USART_Flush_Data, void(HAL_USB_USART_Serial))
+DYNALIB_FN_WRAP(4, hal_usb, HAL_USB_USART_Available_Data, protected, int32_t(HAL_USB_USART_Serial))
+DYNALIB_FN_WRAP(5, hal_usb, HAL_USB_USART_Available_Data_For_Write, protected, int32_t(HAL_USB_USART_Serial))
+DYNALIB_FN_WRAP(6, hal_usb, HAL_USB_USART_Receive_Data, protected, int32_t(HAL_USB_USART_Serial, uint8_t))
+DYNALIB_FN_WRAP(7, hal_usb, HAL_USB_USART_Send_Data, protected, int32_t(HAL_USB_USART_Serial, uint8_t))
+DYNALIB_FN_WRAP(8, hal_usb, HAL_USB_USART_Flush_Data, protected, void(HAL_USB_USART_Serial))
 DYNALIB_FN(9, hal_usb, HAL_USB_USART_Is_Enabled, bool(HAL_USB_USART_Serial))
 DYNALIB_FN(10, hal_usb, HAL_USB_USART_Is_Connected, bool(HAL_USB_USART_Serial))
 DYNALIB_FN(11, hal_usb, HAL_USB_USART_LineCoding_BitRate_Handler, int32_t(void (*handler)(uint32_t bitRate), void* reserved))

diff --git a/hal/inc/usb_hal.h b/hal/inc/usb_hal.h
@@ -43,6 +43,8 @@
 #include "hw_config.h"
 #endif
 
+#include "security_mode.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -204,11 +206,11 @@ void HAL_USB_USART_Init(HAL_USB_USART_Serial serial, const HAL_USB_USART_Config*
 void HAL_USB_USART_Begin(HAL_USB_USART_Serial serial, uint32_t baud, void *reserved);
 void HAL_USB_USART_End(HAL_USB_USART_Serial serial);
 unsigned int HAL_USB_USART_Baud_Rate(HAL_USB_USART_Serial serial);
-int32_t HAL_USB_USART_Available_Data(HAL_USB_USART_Serial serial);
-int32_t HAL_USB_USART_Available_Data_For_Write(HAL_USB_USART_Serial serial);
-int32_t HAL_USB_USART_Receive_Data(HAL_USB_USART_Serial serial, uint8_t peek);
-int32_t HAL_USB_USART_Send_Data(HAL_USB_USART_Serial serial, uint8_t data);
-void HAL_USB_USART_Flush_Data(HAL_USB_USART_Serial serial);
+SECURITY_MODE_PROTECTED_FN(int32_t, HAL_USB_USART_Available_Data, (HAL_USB_USART_Serial serial));
+SECURITY_MODE_PROTECTED_FN(int32_t, HAL_USB_USART_Available_Data_For_Write, (HAL_USB_USART_Serial serial));
+SECURITY_MODE_PROTECTED_FN(int32_t, HAL_USB_USART_Receive_Data, (HAL_USB_USART_Serial serial, uint8_t peek));
+SECURITY_MODE_PROTECTED_FN(int32_t, HAL_USB_USART_Send_Data, (HAL_USB_USART_Serial serial, uint8_t data));
+SECURITY_MODE_PROTECTED_FN(void, HAL_USB_USART_Flush_Data, (HAL_USB_USART_Serial serial));
 bool HAL_USB_USART_Is_Enabled(HAL_USB_USART_Serial serial);
 bool HAL_USB_USART_Is_Connected(HAL_USB_USART_Serial serial);
 int32_t HAL_USB_USART_LineCoding_BitRate_Handler(void (*handler)(uint32_t bitRate), void* reserved);

diff --git a/hal/src/nRF52840/bootloader.cpp b/hal/src/nRF52840/bootloader.cpp
@@ -87,16 +87,3 @@ uint16_t bootloader_get_version(void)
     }
     return info.module_version;
 }
-
-int bootloader_init_security_mode(void* reserved) {
-    CHECK_TRUE(FLASH_VerifyCRC32(FLASH_INTERNAL, BOOTLOADER_ADDR, FLASH_ModuleLength(FLASH_INTERNAL, BOOTLOADER_ADDR)), SYSTEM_ERROR_BAD_DATA);
-    module_info_security_mode_ext_t ext = {};
-    ext.ext.length = sizeof(ext);
-    CHECK(security_mode_find_extension(HAL_STORAGE_ID_INTERNAL_FLASH, BOOTLOADER_ADDR, &ext));
-
-    if (ext.security_mode == MODULE_INFO_SECURITY_MODE_PROTECTED) {
-        security_mode_set(ext.security_mode, nullptr);
-    }
-
-    return 0;
-}
diff --git a/hal/src/nRF52840/usb_hal.cpp b/hal/src/nRF52840/usb_hal.cpp
@@ -92,10 +92,20 @@ int32_t HAL_USB_USART_Available_Data(HAL_USB_USART_Serial serial) {
     return usb_uart_available_rx_data();
 }
 
+int32_t HAL_USB_USART_Available_Data_protected(HAL_USB_USART_Serial serial) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Available_Data(serial);
+}
+
 int32_t HAL_USB_USART_Available_Data_For_Write(HAL_USB_USART_Serial serial) {
     return usb_uart_available_tx_data();
 }
 
+int32_t HAL_USB_USART_Available_Data_For_Write_protected(HAL_USB_USART_Serial serial) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Available_Data_For_Write(serial);
+}
+
 int32_t HAL_USB_USART_Receive_Data(HAL_USB_USART_Serial serial, uint8_t peek) {
     if (usb_uart_available_rx_data() == 0) {
         return -1;
@@ -108,14 +118,31 @@ int32_t HAL_USB_USART_Receive_Data(HAL_USB_USART_Serial serial, uint8_t peek) {
     }
 }
 
+int32_t HAL_USB_USART_Receive_Data_protected(HAL_USB_USART_Serial serial, uint8_t peek) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Receive_Data(serial, peek);
+}
+
 int32_t HAL_USB_USART_Send_Data(HAL_USB_USART_Serial serial, uint8_t data) {
     return usb_uart_send(&data, 1);
 }
 
+int32_t HAL_USB_USART_Send_Data_protected(HAL_USB_USART_Serial serial, uint8_t data) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Send_Data(serial, data);
+}
+
 void HAL_USB_USART_Flush_Data(HAL_USB_USART_Serial serial) {
     usb_uart_flush_tx_data();
 }
 
+void HAL_USB_USART_Flush_Data_protected(HAL_USB_USART_Serial serial) {
+    if (security_mode_get(NULL) == MODULE_INFO_SECURITY_MODE_PROTECTED) {
+        return;
+    }
+    HAL_USB_USART_Flush_Data(serial);
+}
+
 bool HAL_USB_USART_Is_Enabled(HAL_USB_USART_Serial serial) {
     return usb_hal_is_enabled();
 }

diff --git a/hal/src/rtl872x/bootloader.cpp b/hal/src/rtl872x/bootloader.cpp
@@ -88,16 +88,3 @@ uint16_t bootloader_get_version(void)
     // hard code to unblock porting work for now
     return 1001;
 }
-
-int bootloader_init_security_mode(void* reserved) {
-    CHECK_TRUE(FLASH_VerifyCRC32(FLASH_INTERNAL, BOOTLOADER_ADDR, FLASH_ModuleLength(FLASH_INTERNAL, BOOTLOADER_ADDR)), SYSTEM_ERROR_BAD_DATA);
-    module_info_security_mode_ext_t ext = {};
-    ext.ext.length = sizeof(ext);
-    CHECK(security_mode_find_extension(HAL_STORAGE_ID_INTERNAL_FLASH, BOOTLOADER_ADDR, &ext));
-
-    if (ext.security_mode == MODULE_INFO_SECURITY_MODE_PROTECTED) {
-        security_mode_set(ext.security_mode, nullptr);
-    }
-
-    return 0;
-}
diff --git a/hal/src/rtl872x/usb_hal.cpp b/hal/src/rtl872x/usb_hal.cpp
@@ -170,6 +170,11 @@ int32_t HAL_USB_USART_Available_Data(HAL_USB_USART_Serial serial) {
     return getCdcClassDriver().available();
 }
 
+int32_t HAL_USB_USART_Available_Data_protected(HAL_USB_USART_Serial serial) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Available_Data(serial);
+}
+
 int32_t HAL_USB_USART_Available_Data_For_Write(HAL_USB_USART_Serial serial) {
     if (serial != HAL_USB_USART_SERIAL) {
         return SYSTEM_ERROR_INVALID_ARGUMENT;
@@ -180,6 +185,11 @@ int32_t HAL_USB_USART_Available_Data_For_Write(HAL_USB_USART_Serial serial) {
     return getCdcClassDriver().availableForWrite();
 }
 
+int32_t HAL_USB_USART_Available_Data_For_Write_protected(HAL_USB_USART_Serial serial) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Available_Data_For_Write(serial);
+}
+
 int32_t HAL_USB_USART_Receive_Data(HAL_USB_USART_Serial serial, uint8_t peek) {
     if (serial != HAL_USB_USART_SERIAL) {
         return SYSTEM_ERROR_INVALID_ARGUMENT;
@@ -197,6 +207,11 @@ int32_t HAL_USB_USART_Receive_Data(HAL_USB_USART_Serial serial, uint8_t peek) {
     return r;
 }
 
+int32_t HAL_USB_USART_Receive_Data_protected(HAL_USB_USART_Serial serial, uint8_t peek) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Receive_Data(serial, peek);
+}
+
 int32_t HAL_USB_USART_Send_Data(HAL_USB_USART_Serial serial, uint8_t data) {
     if (serial != HAL_USB_USART_SERIAL) {
         return SYSTEM_ERROR_INVALID_ARGUMENT;
@@ -220,13 +235,25 @@ int32_t HAL_USB_USART_Send_Data(HAL_USB_USART_Serial serial, uint8_t data) {
     return -1;
 }
 
+int32_t HAL_USB_USART_Send_Data_protected(HAL_USB_USART_Serial serial, uint8_t data) {
+    CHECK_SECURITY_MODE_PROTECTED();
+    return HAL_USB_USART_Send_Data(serial, data);
+}
+
 void HAL_USB_USART_Flush_Data(HAL_USB_USART_Serial serial) {
     if (serial != HAL_USB_USART_SERIAL) {
         return;
     }
     return getCdcClassDriver().flush();
 }
 
+void HAL_USB_USART_Flush_Data_protected(HAL_USB_USART_Serial serial) {
+    if (security_mode_get(NULL) == MODULE_INFO_SECURITY_MODE_PROTECTED) {
+        return;
+    }
+    return HAL_USB_USART_Flush_Data(serial);
+}
+
 bool HAL_USB_USART_Is_Enabled(HAL_USB_USART_Serial serial) {
     if (serial != HAL_USB_USART_SERIAL) {
         return false;

diff --git a/platform/MCU/nRF52840/inc/dct.h b/platform/MCU/nRF52840/inc/dct.h
@@ -255,7 +255,7 @@ STATIC_ASSERT_FLAGS_OFFSET(Factory_Reset_Done_SysFlag, 17);
 STATIC_ASSERT_FLAGS_OFFSET(StartupMode_SysFlag, 18);
 STATIC_ASSERT_FLAGS_OFFSET(FeaturesEnabled_SysFlag, 19);
 STATIC_ASSERT_FLAGS_OFFSET(RCC_CSR_SysFlag, 20);
-STATIC_ASSERT_FLAGS_OFFSET(reserved, 24);
+STATIC_ASSERT_FLAGS_OFFSET(reserved, 30);
 
 
 #ifdef	__cplusplus

diff --git a/platform/MCU/nRF52840/inc/platform_system_flags.h b/platform/MCU/nRF52840/inc/platform_system_flags.h
@@ -36,7 +36,12 @@ typedef struct __attribute__((packed)) platform_system_flags {
     uint8_t FeaturesEnabled_SysFlag;        // default is 0xFF all features enabled. If any bits are cleared in the bottom 4-bits, then the upper 4 bits should be the logical inverse of these.
                                             // This is to prevent against corrupted data causing the bootloader to be unavailable.
     uint32_t RCC_CSR_SysFlag;
-    uint16_t reserved[4];
+
+    uint8_t security_mode_override_value; // If not 0xff, specifies the temporary security mode that overrides the normal mode
+    uint8_t security_mode_override_reset_count; // Number of system resets after which the normal security mode will be restored
+    uint32_t security_mode_override_timeout; // Timeout, in seconds, after which the normal security mode will be restored
+
+    uint16_t reserved[1];
 } platform_system_flags_t;
 
 PARTICLE_STATIC_ASSERT(platform_system_flags_size_changed, sizeof(platform_system_flags_t) == 32);

diff --git a/platform/MCU/nRF52840/src/hw_config.c b/platform/MCU/nRF52840/src/hw_config.c
@@ -202,7 +202,10 @@ void Set_System(void)
     SPARK_ASSERT(!hal_flash_init());
     SPARK_ASSERT(!hal_exflash_init());
 
-    bootloader_init_security_mode(NULL);
+    security_mode_init();
+#if MODULE_FUNCTION == MOD_FUNC_BOOTLOADER
+    security_mode_notify_system_reset();
+#endif
 
     configure_uicr();
 
@@ -324,7 +327,7 @@ __attribute__((section(".retained_system_flags"))) platform_system_flags_t syste
 
 #define SYSTEM_FLAGS_MAGIC_NUMBER 0x1ADEACC0u
 
-void Load_SystemFlags()
+void Load_SystemFlags() // TODO: Rename to Init_SystemFlags() and call once on startup
 {
 	// if the header does not match the expected magic value, then initialize
 	if (system_flags.header!=SYSTEM_FLAGS_MAGIC_NUMBER) {
@@ -333,7 +336,7 @@ void Load_SystemFlags()
 	}
 }
 
-void Save_SystemFlags()
+void Save_SystemFlags() // TODO: Remove
 {
 	// nothing to do here
 }

diff --git a/platform/MCU/rtl872x/inc/dct.h b/platform/MCU/rtl872x/inc/dct.h
@@ -249,7 +249,7 @@ STATIC_ASSERT_FLAGS_OFFSET(StartupMode_SysFlag, 18);
 STATIC_ASSERT_FLAGS_OFFSET(FeaturesEnabled_SysFlag, 19);
 STATIC_ASSERT_FLAGS_OFFSET(RCC_CSR_SysFlag, 20);
 STATIC_ASSERT_FLAGS_OFFSET(restore_backup_ram, 24);
-STATIC_ASSERT_FLAGS_OFFSET(reserved, 26);
+STATIC_ASSERT_FLAGS_OFFSET(reserved, 32);
 
 
 #ifdef	__cplusplus

diff --git a/platform/MCU/rtl872x/inc/platform_system_flags.h b/platform/MCU/rtl872x/inc/platform_system_flags.h
@@ -39,7 +39,12 @@ typedef struct __attribute__((packed)) platform_system_flags {
     // bit 0: 1: restore backup ram from flash
     // bit 1: 1: session data in flash is stale
     uint16_t restore_backup_ram;
-    uint16_t reserved[3];
+
+    uint8_t security_mode_override_value; // If not 0xff, specifies the temporary security mode that overrides the normal mode
+    uint8_t security_mode_override_reset_count; // Number of system resets after which the normal security mode will be restored
+    uint32_t security_mode_override_timeout; // Timeout, in seconds, after which the normal security mode will be restored
+
+    uint16_t reserved[0];
 } platform_system_flags_t;
 
 PARTICLE_STATIC_ASSERT(platform_system_flags_size_changed, sizeof(platform_system_flags_t) == 32);

diff --git a/platform/MCU/rtl872x/src/hw_config.c b/platform/MCU/rtl872x/src/hw_config.c
@@ -376,7 +376,10 @@ void Set_System(void)
     /* Configure flash */
     SPARK_ASSERT(!hal_exflash_init());
 
-    bootloader_init_security_mode(NULL);
+    security_mode_init();
+#if MODULE_FUNCTION == MOD_FUNC_BOOTLOADER
+    security_mode_notify_system_reset();
+#endif
 
     efuse_configure();
     DWT_Init();
@@ -495,7 +498,7 @@ __attribute__((section(".retained_system_flags"))) platform_system_flags_t syste
 
 #define SYSTEM_FLAGS_MAGIC_NUMBER 0x1ADEACC0u
 
-void Load_SystemFlags()
+void Load_SystemFlags() // TODO: Rename to Init_SystemFlags() and call once on startup
 {
     // if the header does not match the expected magic value, then initialize
     if (system_flags.header!=SYSTEM_FLAGS_MAGIC_NUMBER) {
@@ -504,7 +507,7 @@ void Load_SystemFlags()
     }
 }
 
-void Save_SystemFlags()
+void Save_SystemFlags() // TODO: Remove
 {
     // nothing to do here
 }

diff --git a/proto_defs/shared b/proto_defs/shared
diff --git a/proto_defs/src/control/config.pb.c b/proto_defs/src/control/config.pb.c
@@ -132,6 +132,21 @@ PB_BIND(particle_ctrl_GetProtectedStateRequest, particle_ctrl_GetProtectedStateR
 PB_BIND(particle_ctrl_GetProtectedStateReply, particle_ctrl_GetProtectedStateReply, AUTO)
 
 
+PB_BIND(particle_ctrl_SetProtectedStateRequest, particle_ctrl_SetProtectedStateRequest, AUTO)
+
+
+PB_BIND(particle_ctrl_SetProtectedStateRequest_Prepare, particle_ctrl_SetProtectedStateRequest_Prepare, AUTO)
+
+
+PB_BIND(particle_ctrl_SetProtectedStateRequest_Confirm, particle_ctrl_SetProtectedStateRequest_Confirm, AUTO)
+
+
+PB_BIND(particle_ctrl_SetProtectedStateReply, particle_ctrl_SetProtectedStateReply, AUTO)
+
+
+PB_BIND(particle_ctrl_SetProtectedStateReply_Prepare, particle_ctrl_SetProtectedStateReply_Prepare, AUTO)
+
+
 PB_BIND(particle_ctrl_SystemResetRequest, particle_ctrl_SystemResetRequest, AUTO)
 
 
@@ -168,3 +183,4 @@ PB_BIND(particle_ctrl_StopNyanSignalReply, particle_ctrl_StopNyanSignalReply, AU
 
 
 
+