suit: Build system changes needed for encryption

This commit contains changes to the SUIT build system
allowing for encrypting images for update.

Signed-off-by: Artur Hadasz <[email protected]>

Author: ahasztag

cmake/sysbuild/suit.cmake

@@ -236,6 +236,12 @@ function(suit_create_package)
   set(CORE_ARGS)
   set(STORAGE_BOOT_ARGS)
   sysbuild_get(app_config_dir IMAGE ${DEFAULT_IMAGE} VAR APPLICATION_CONFIG_DIR CACHE)
+  get_property(SUIT_KMS_SCRIPT GLOBAL PROPERTY SUIT_KMS_SCRIPT)
+  # If the user has not provided the path to the kms script, use the default one.
+  if(NOT SUIT_KMS_SCRIPT)
+    set(SUIT_KMS_SCRIPT "${ZEPHYR_SUIT_GENERATOR_MODULE_DIR}/ncs/basic_kms.py")
+  endif()
+
 
   if(NOT DEFINED SB_CONFIG_SUIT_ENVELOPE_SIGN)
     set(SB_CONFIG_SUIT_ENVELOPE_SIGN FALSE)
@@ -247,12 +253,40 @@ function(suit_create_package)
 
   foreach(image ${IMAGES})
     unset(target)
+    unset(encrypt)
     sysbuild_get(BINARY_DIR IMAGE ${image} VAR APPLICATION_BINARY_DIR CACHE)
     sysbuild_get(BINARY_FILE IMAGE ${image} VAR CONFIG_KERNEL_BIN_NAME KCONFIG)
     sysbuild_get(target IMAGE ${image} VAR CONFIG_SUIT_ENVELOPE_TARGET KCONFIG)
+    sysbuild_get(encrypt IMAGE ${image} VAR CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT KCONFIG)
 
     set(BINARY_FILE "${BINARY_FILE}.bin")
 
+    if(encrypt)
+      if(DEFINED target AND NOT target STREQUAL "")
+        set(${image}_SUIT_ENCRYPT_DIR "${SUIT_ROOT_DIRECTORY}/${target}_encryption_artifacts")
+      else()
+        set(${image}_SUIT_ENCRYPT_DIR "${SUIT_ROOT_DIRECTORY}/${image}_encryption_artifacts")
+      endif()
+
+      set(SUIT_ENCRYPT_ARGS)
+      sysbuild_get(encrypt_string_key_id IMAGE ${image} VAR CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT_STRING_KEY_ID KCONFIG)
+      sysbuild_get(encrypt_key_name IMAGE ${image} VAR CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT_KEY_NAME KCONFIG)
+      sysbuild_get(plaintext_hash_alg IMAGE ${image} VAR CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT_PLAINTEXT_HASH_ALG_NAME KCONFIG)
+
+      list(APPEND SUIT_ENCRYPT_ARGS --firmware ${BINARY_DIR}/zephyr/${BINARY_FILE})
+      list(APPEND SUIT_ENCRYPT_ARGS --key-name ${encrypt_key_name})
+      list(APPEND SUIT_ENCRYPT_ARGS --string-key-id ${encrypt_string_key_id})
+      list(APPEND SUIT_ENCRYPT_ARGS --hash-alg ${plaintext_hash_alg})
+      list(APPEND SUIT_ENCRYPT_ARGS --context ${SB_CONFIG_SUIT_ENVELOPE_KMS_SCRIPT_CONTEXT})
+      list(APPEND SUIT_ENCRYPT_ARGS --kms-script ${SUIT_KMS_SCRIPT})
+
+      suit_encrypt_image("${SUIT_ENCRYPT_ARGS}" ${${image}_SUIT_ENCRYPT_DIR})
+
+      set(${image}_SUIT_PAYLOAD_BINARY ${${image}_SUIT_ENCRYPT_DIR}/encrypted_content.bin)
+    else()
+      set(${image}_SUIT_PAYLOAD_BINARY ${BINARY_DIR}/zephyr/${BINARY_FILE})
+    endif()
+
     list(APPEND CORE_ARGS
       --core ${image},${SUIT_ROOT_DIRECTORY}${image}.bin,${BINARY_DIR}/zephyr/edt.pickle,${BINARY_DIR}/zephyr/.config
     )
@@ -262,11 +296,11 @@ function(suit_create_package)
       --core ${target},${SUIT_ROOT_DIRECTORY}${image}.bin,${BINARY_DIR}/zephyr/edt.pickle,${BINARY_DIR}/zephyr/.config
       )
     endif()
-    suit_copy_artifact_to_output_directory(${image} ${BINARY_DIR}/zephyr/${BINARY_FILE})
+    suit_copy_artifact_to_output_directory(${image} ${${image}_SUIT_PAYLOAD_BINARY})
 
-    unset(CONFIG_SUIT_RECOVERY)
-    sysbuild_get(CONFIG_SUIT_RECOVERY IMAGE ${image} VAR CONFIG_SUIT_RECOVERY KCONFIG)
-    if(CONFIG_SUIT_RECOVERY)
+    unset(recovery)
+    sysbuild_get(recovery IMAGE ${image} VAR CONFIG_SUIT_RECOVERY KCONFIG)
+    if(recovery)
       set_property(GLOBAL APPEND PROPERTY SUIT_RECOVERY_DFU_ARTIFACTS ${SUIT_ROOT_DIRECTORY}${image}.bin)
     else()
       set_property(GLOBAL APPEND PROPERTY SUIT_DFU_ARTIFACTS ${SUIT_ROOT_DIRECTORY}${image}.bin)
@@ -313,9 +347,9 @@ function(suit_create_package)
     suit_render_template(${INPUT_ENVELOPE_JINJA_FILE} ${ENVELOPE_YAML_FILE} "${TEMPLATE_ARGS}")
     suit_create_envelope(${ENVELOPE_YAML_FILE} ${ENVELOPE_SUIT_FILE} ${SB_CONFIG_SUIT_ENVELOPE_SIGN})
 
-    unset(CONFIG_SUIT_RECOVERY)
-    sysbuild_get(CONFIG_SUIT_RECOVERY IMAGE ${image} VAR CONFIG_SUIT_RECOVERY KCONFIG)
-    if(CONFIG_SUIT_RECOVERY)
+    unset(recovery)
+    sysbuild_get(recovery IMAGE ${image} VAR CONFIG_SUIT_RECOVERY KCONFIG)
+    if(recovery)
       set_property(GLOBAL APPEND PROPERTY SUIT_RECOVERY_DFU_ARTIFACTS ${ENVELOPE_SUIT_FILE})
     else()
       set_property(GLOBAL APPEND PROPERTY SUIT_DFU_ARTIFACTS ${ENVELOPE_SUIT_FILE})
@@ -336,10 +370,10 @@ function(suit_create_package)
     if(EXTRACT_TO_CACHE)
       sysbuild_get(CACHE_PARTITION_NUM IMAGE ${image} VAR CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE_PARTITION KCONFIG)
 
-      unset(CONFIG_SUIT_RECOVERY)
-      sysbuild_get(CONFIG_SUIT_RECOVERY IMAGE ${image} VAR CONFIG_SUIT_RECOVERY KCONFIG)
+      unset(recovery)
+      sysbuild_get(recovery IMAGE ${image} VAR CONFIG_SUIT_RECOVERY KCONFIG)
 
-      if(CONFIG_SUIT_RECOVERY)
+      if(recovery)
         list(APPEND RECOVERY_DFU_CACHE_PARTITIONS_USED ${CACHE_PARTITION_NUM})
         list(APPEND SUIT_RECOVERY_CACHE_PARTITION_${CACHE_PARTITION_NUM} ${image})
       else()
@@ -356,11 +390,10 @@ function(suit_create_package)
   foreach(CACHE_PARTITION_NUM ${DFU_CACHE_PARTITIONS_USED})
     set(CACHE_CREATE_ARGS "")
     foreach(image ${SUIT_CACHE_PARTITION_${CACHE_PARTITION_NUM}})
-      sysbuild_get(BINARY_DIR IMAGE ${image} VAR APPLICATION_BINARY_DIR CACHE)
-      sysbuild_get(BINARY_FILE IMAGE ${image} VAR CONFIG_KERNEL_BIN_NAME KCONFIG)
       sysbuild_get(IMAGE_CACHE_URI IMAGE ${image} VAR CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE_URI KCONFIG)
+
       list(APPEND CACHE_CREATE_ARGS
-        "--input" "\"${IMAGE_CACHE_URI},${BINARY_DIR}/zephyr/${BINARY_FILE}.bin\""
+        "--input" "\"${IMAGE_CACHE_URI},${${image}_SUIT_PAYLOAD_BINARY}\""
       )
     endforeach()
 
@@ -382,11 +415,9 @@ function(suit_create_package)
     foreach(CACHE_PARTITION_NUM ${RECOVERY_DFU_CACHE_PARTITIONS_USED})
       set(CACHE_CREATE_ARGS "")
       foreach(image ${SUIT_RECOVERY_CACHE_PARTITION_${CACHE_PARTITION_NUM}})
-        sysbuild_get(BINARY_DIR IMAGE ${image} VAR APPLICATION_BINARY_DIR CACHE)
-        sysbuild_get(BINARY_FILE IMAGE ${image} VAR CONFIG_KERNEL_BIN_NAME KCONFIG)
         sysbuild_get(IMAGE_CACHE_URI IMAGE ${image} VAR CONFIG_SUIT_DFU_CACHE_EXTRACT_IMAGE_URI KCONFIG)
         list(APPEND CACHE_CREATE_ARGS
-          "--input" "\"${IMAGE_CACHE_URI},${BINARY_DIR}/zephyr/${BINARY_FILE}.bin\""
+          "--input" "\"${IMAGE_CACHE_URI},${${image}_SUIT_PAYLOAD_BINARY}\""
         )
       endforeach()
 
@@ -544,9 +575,9 @@ function(suit_setup_merge)
   foreach(image ${IMAGES})
     set(ARTIFACTS_TO_MERGE)
 
-    unset(CONFIG_NRF_REGTOOL_GENERATE_UICR)
-    sysbuild_get(CONFIG_NRF_REGTOOL_GENERATE_UICR IMAGE ${image} VAR CONFIG_NRF_REGTOOL_GENERATE_UICR KCONFIG)
-    if(NOT DEFINED CONFIG_NRF_REGTOOL_GENERATE_UICR)
+    unset(regtool_generate_uicr)
+    sysbuild_get(regtool_generate_uicr IMAGE ${image} VAR CONFIG_NRF_REGTOOL_GENERATE_UICR KCONFIG)
+    if(NOT DEFINED regtool_generate_uicr)
       continue()
     endif()
 

cmake/sysbuild/suit_utilities.cmake

@@ -8,6 +8,12 @@ set(SUIT_GENERATOR_BUILD_SCRIPT "${ZEPHYR_SUIT_GENERATOR_MODULE_DIR}/ncs/build.p
 set(SUIT_GENERATOR_CLI_SCRIPT "${ZEPHYR_SUIT_GENERATOR_MODULE_DIR}/suit_generator/cli.py")
 set(SUIT_OUTPUT_ARTIFACTS_DIRECTORY "DFU")
 
+if(WIN32)
+  set(SEP $<SEMICOLON>)
+else()
+  set(SEP :)
+endif()
+
 if(NOT DEFINED SUIT_ROOT_DIRECTORY)
   set(SUIT_ROOT_DIRECTORY ${APPLICATION_BINARY_DIR}/${SUIT_OUTPUT_ARTIFACTS_DIRECTORY}/)
 endif()
@@ -84,8 +90,17 @@ function(suit_create_envelope input_file output_file create_signature)
   endif()
 endfunction()
 
+# Create a SUIT DFU cache partition file from a list of payloads.
+#
+# Usage:
+#  suit_create_cache_partition(<args> <output_file> <partition_num> <recovery>)
+#
+# Parameters:
+#   'args' - list of arguments for the cache_create command
+#   'output_file' - path to output cache partition file
+#   'partition_num' - partition number
+#   'recovery' - if set to true, the cache partition contains recovery firmware payloads
 function(suit_create_cache_partition args output_file partition_num recovery)
-
   list(APPEND args "--output-file" "${output_file}")
 
   set_property(
@@ -110,6 +125,15 @@ function(suit_create_cache_partition args output_file partition_num recovery)
   endif()
 endfunction()
 
+# Create a SUIT DFU cache partition with Nordic proprietary payloads
+# extracted from the top-level SUIT envelope.
+#
+# Usage:
+# suit_create_nordic_cache_partition(<args> <output_file>)
+#
+# Parameters:
+#   'args' - list of arguments for the cache_create command
+#   'output_file' - path to output cache partition file
 function(suit_create_nordic_cache_partition args output_file)
   list(APPEND args "--output-file" "${output_file}")
   list(APPEND args "--omit-payload-regex" "'(?!.*secdom.*\.bin|.*sysctl_v.*\.bin).*'")
@@ -143,3 +167,43 @@ function(suit_add_merge_hex_file)
     set_property(GLOBAL APPEND PROPERTY SUIT_MERGE_application_DEPENDENCIES ${arg_DEPENDENCIES})
 endif()
 endfunction()
+
+# Create SUIT encryption artifacts for a given image.
+#
+# Usage:
+# suit_encrypt_image(<args> <output_directory>)
+#
+# Parameters:
+#   'args' - list of arguments for the encryption script
+#   'output_directory' - path to a directory where the encryption artifacts will be stored
+function(suit_encrypt_image args output_directory)
+  get_property(
+    encrypt_script
+    GLOBAL PROPERTY
+    SUIT_ENCRYPT_SCRIPT
+  )
+  # If the user has not provided the path to the encrypt script, use the default one.
+  if(NOT encrypt_script)
+    set(encrypt_script "${ZEPHYR_SUIT_GENERATOR_MODULE_DIR}/ncs/encrypt_script.py")
+  endif()
+
+  if(NOT EXISTS ${encrypt_script})
+    message(SEND_ERROR "DFU: ${encrypt_script} does not exist. Corrupted configuration?")
+    return()
+  endif()
+
+  list(APPEND args --output-dir ${output_directory})
+
+  set_property(
+    GLOBAL APPEND PROPERTY SUIT_POST_BUILD_COMMANDS
+    COMMAND ${CMAKE_COMMAND} -E make_directory ${output_directory}
+  )
+  set_property(
+    GLOBAL APPEND PROPERTY SUIT_POST_BUILD_COMMANDS
+    COMMAND
+    PYTHONPATH=${ZEPHYR_SUIT_GENERATOR_MODULE_DIR}${SEP}$ENV{PYTHONPATH}
+    ${PYTHON_EXECUTABLE}
+    ${encrypt_script} encrypt-and-generate
+    ${args}
+  )
+endfunction()

config/suit/templates/nrf54h20/default/v1/app_envelope.yaml.jinja2

@@ -1,5 +1,12 @@
 {%- set mpi_application_vendor_name = sysbuild['config']['SB_CONFIG_SUIT_MPI_APP_LOCAL_1_VENDOR_NAME']|default('nordicsemi.com') %}
 {%- set mpi_application_class_name = sysbuild['config']['SB_CONFIG_SUIT_MPI_APP_LOCAL_1_CLASS_NAME']|default('nRF54H20_sample_app') %}
+{%- set suit_artifacts_base_dir = ( application['binary'].split('/')[:-1] | join('/') ) %}
+{%- if 'CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT' in application['config'] and application['config']['CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT'] != '' %}
+  {%- set encrypted = True %}
+  {%- set app_encryption_dir = ( suit_artifacts_base_dir ) + "/" + ( application['name'] ) + "_encryption_artifacts" %}
+{%- else %}
+  {%- set encrypted = False %}
+{%- endif %}
 SUIT_Envelope_Tagged:
   suit-authentication-wrapper:
     SuitDigest:
@@ -33,9 +40,17 @@ SUIT_Envelope_Tagged:
           suit-parameter-image-digest:
             suit-digest-algorithm-id: cose-alg-sha-256
             suit-digest-bytes:
+{%- if encrypted %}
+              file_direct: {{ app_encryption_dir }}/plain_text_digest.bin
+{%- else %}
               file: {{ application['binary'] }}
+{%- endif %}
           suit-parameter-image-size:
+{%- if encrypted %}
+            file_direct: {{ app_encryption_dir }}/plain_text_size.txt
+{%- else %}
             file: {{ application['binary'] }}
+{%- endif %}
       - suit-condition-vendor-identifier:
         - suit-send-record-success
         - suit-send-record-failure
@@ -102,6 +117,10 @@ SUIT_Envelope_Tagged:
     - suit-directive-set-component-index: 0
     - suit-directive-override-parameters:
         suit-parameter-source-component: 1
+{%- if encrypted %}
+        suit-parameter-encryption-info:
+          file: {{ app_encryption_dir }}/suit_encryption_info.bin
+{%- endif %}
     # When copying the data it is worth to retry the sequence of
     # suit-directive-copy and suit-condition-image-match at least once.
     # If a bit flip occurs, it might be due to a transport issue, not
@@ -138,8 +157,21 @@ SUIT_Envelope_Tagged:
           suit-digest-algorithm-id: cose-alg-sha-256
           suit-digest-bytes:
             file: {{ application['binary'] }}
+{%- if encrypted %}
+    # For the encrypted image this fetch directive is used to verify the tag and the AAD
+    # of the received encrypted image The target "CAND_IMG" behaves like a /dev/null device
+    # and all the data is discarded.
+    # This way even if the encrypted content is incorrect, the contents of the target memory
+    # will not be affected.
+    # Note that no digest checking is required on the encrypted content itself, as checking the tag
+    # and the AAD verifies the integrity of the content. In fact, suit-condition-image-match
+    # won't be able to work in this case, as the CAND_IMG won't contain any valid content.
+          suit-parameter-encryption-info:
+            file: {{ app_encryption_dir }}/suit_encryption_info.bin
+{%- endif %}
     - suit-directive-fetch:
       - suit-send-record-failure
+{%- if not encrypted %}
     - suit-directive-try-each:
       - - suit-condition-image-match:
           - suit-send-record-success
@@ -151,6 +183,7 @@ SUIT_Envelope_Tagged:
           - suit-send-record-failure
           - suit-send-sysinfo-success
           - suit-send-sysinfo-failure
+{%- endif %}
 
     suit-manifest-component-id:
     - INSTLD_MFST

config/suit/templates/nrf54h20/default/v1/rad_envelope.yaml.jinja2

@@ -1,5 +1,12 @@
 {%- set mpi_radio_vendor_name = sysbuild['config']['SB_CONFIG_SUIT_MPI_RAD_LOCAL_1_VENDOR_NAME']|default('nordicsemi.com') %}
 {%- set mpi_radio_class_name = sysbuild['config']['SB_CONFIG_SUIT_MPI_RAD_LOCAL_1_CLASS_NAME']|default('nRF54H20_sample_rad') %}
+{%- set suit_artifacts_base_dir = ( radio['binary'].split('/')[:-1] | join('/') ) %}
+{%- if 'CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT' in radio['config'] and radio['config']['CONFIG_SUIT_ENVELOPE_TARGET_ENCRYPT'] != '' %}
+  {%- set encrypted = True %}
+  {%- set rad_encryption_dir = ( suit_artifacts_base_dir ) + "/" + ( radio['name'] ) + "_encryption_artifacts" %}
+{%- else %}
+  {%- set encrypted = False %}
+{%- endif %}
 SUIT_Envelope_Tagged:
   suit-authentication-wrapper:
     SuitDigest:
@@ -33,9 +40,17 @@ SUIT_Envelope_Tagged:
           suit-parameter-image-digest:
             suit-digest-algorithm-id: cose-alg-sha-256
             suit-digest-bytes:
+{%- if encrypted %}
+              file_direct: {{ rad_encryption_dir }}/plain_text_digest.bin
+{%- else %}
               file: {{ radio['binary'] }}
+{%- endif %}
           suit-parameter-image-size:
+{%- if encrypted %}
+            file_direct: {{ rad_encryption_dir }}/plain_text_size.txt
+{%- else %}
             file: {{ radio['binary'] }}
+{%- endif %}
       - suit-condition-vendor-identifier:
         - suit-send-record-success
         - suit-send-record-failure
@@ -102,6 +117,10 @@ SUIT_Envelope_Tagged:
     - suit-directive-set-component-index: 0
     - suit-directive-override-parameters:
         suit-parameter-source-component: 1
+{%- if encrypted %}
+        suit-parameter-encryption-info:
+          file: {{ rad_encryption_dir }}/suit_encryption_info.bin
+{%- endif %}
     # When copying the data it is worth to retry the sequence of
     # suit-directive-copy and suit-condition-image-match at least once.
     # If a bit flip occurs, it might be due to a transport issue, not
@@ -138,8 +157,21 @@ SUIT_Envelope_Tagged:
           suit-digest-algorithm-id: cose-alg-sha-256
           suit-digest-bytes:
             file: {{ radio['binary'] }}
+{%- if encrypted %}
+    # For the encrypted image this fetch directive is used to verify the tag and the AAD
+    # of the received encrypted image The target "CAND_IMG" behaves like a /dev/null device
+    # and all the data is discarded.
+    # This way even if the encrypted content is incorrect, the contents of the target memory
+    # will not be affected.
+    # Note that no digest checking is required on the encrypted content itself, as checking the tag
+    # and the AAD verifies the integrity of the content. In fact, suit-condition-image-match
+    # won't be able to work in this case, as the CAND_IMG won't contain any valid content.
+          suit-parameter-encryption-info:
+            file: {{ rad_encryption_dir }}/suit_encryption_info.bin
+{%- endif %}
     - suit-directive-fetch:
       - suit-send-record-failure
+{%- if not encrypted %}
     - suit-directive-try-each:
       - - suit-condition-image-match:
           - suit-send-record-success
@@ -151,6 +183,7 @@ SUIT_Envelope_Tagged:
           - suit-send-record-failure
           - suit-send-sysinfo-success
           - suit-send-sysinfo-failure
+{%- endif %}
 
     suit-manifest-component-id:
     - INSTLD_MFST