west: runners: Add ncs-provision to west flash command

Added automatic KMU key provisioning for both NSIB and MCUboot.
A new '--ncs-provision' command line option is added to nrfutil
runner. This enables automated key provisioning during the
flashing process to enable testing nRF54L aplications using Twister.
Only applicable on NCS, when KMU keys are configured.

Signed-off-by: Grzegorz Chwierut <[email protected]>

Author: gchwier

scripts/ci/check_compliance.py

@@ -1202,10 +1202,13 @@ class SysbuildKconfigCheck(KconfigCheck):
     UNDEF_KCONFIG_ALLOWLIST = {
         # zephyr-keep-sorted-start re(^\s+")
         "FOO",
+        "MCUBOOT_SIGNATURE_USING_KMU",  # Used by west flash --ncs-provision
         "MY_IMAGE", # Used in sysbuild documentation as example
         "OTHER_APP_IMAGE_NAME", # Used in sysbuild documentation as example
         "OTHER_APP_IMAGE_PATH", # Used in sysbuild documentation as example
         "SECOND_SAMPLE", # Used in sysbuild documentation
+        "SECURE_BOOT_SIGNATURE_TYPE_ED25519",  # Used by west flash --ncs-provision
+        "SECURE_BOOT_SIGNING_KEY_FILE",  # Used by west flash --ncs-provision
         "SUIT_ENVELOPE", # Used by nRF runners to program provisioning data
         "SUIT_MPI_APP_AREA_PATH", # Used by nRF runners to program provisioning data
         "SUIT_MPI_GENERATE", # Used by nRF runners to program provisioning data

scripts/west_commands/runners/nrf_common.py

@@ -97,6 +97,7 @@ def __init__(self, cfg, family, softreset, pinreset, dev_id, erase=False,
 
         # Only applicable for nrfutil
         self.suit_starter = False
+        self.ncs_provision = False
 
         self.tool_opt = []
         if tool_opt is not None:
@@ -542,6 +543,9 @@ def do_exec_op(self, op, force=False):
             Throws subprocess.CalledProcessError with the appropriate
             returncode if a failure arises.'''
 
+    def do_ncs_provision(self):
+        ''' Provision default keys. Only applicable for nrfutil '''
+
     def flush_ops(self, force=True):
         ''' Execute any remaining ops in the self.ops array.
             Throws subprocess.CalledProcessError with the appropriate
@@ -589,6 +593,8 @@ def do_run(self, command, **kwargs):
         if self.recover:
             self.recover_target()
         self.program_hex()
+        if self.ncs_provision:
+            self.do_ncs_provision()
         if self.reset:
             self.reset_target()
         # All done, now flush any outstanding ops

scripts/west_commands/runners/nrfutil.py

@@ -19,14 +19,15 @@ class NrfUtilBinaryRunner(NrfBinaryRunner):
     def __init__(self, cfg, family, softreset, pinreset, dev_id, erase=False,
                  erase_mode=None, ext_erase_mode=None, reset=True, tool_opt=None,
                  force=False, recover=False, suit_starter=False,
-                 ext_mem_config_file=None):
+                 ext_mem_config_file=None, ncs_provision=False):
 
         super().__init__(cfg, family, softreset, pinreset, dev_id, erase,
                          erase_mode, ext_erase_mode, reset, tool_opt, force,
                          recover)
 
         self.suit_starter = suit_starter
         self.ext_mem_config_file = ext_mem_config_file
+        self.ncs_provision = ncs_provision
 
         self._ops = []
         self._op_id = 1
@@ -57,7 +58,8 @@ def do_create(cls, cfg, args):
                                    reset=args.reset, tool_opt=args.tool_opt,
                                    force=args.force, recover=args.recover,
                                    suit_starter=args.suit_manifest_starter,
-                                   ext_mem_config_file=args.ext_mem_config_file)
+                                   ext_mem_config_file=args.ext_mem_config_file,
+                                   ncs_provision=args.ncs_provision)
 
     @classmethod
     def do_add_parser(cls, parser):
@@ -68,6 +70,9 @@ def do_add_parser(cls, parser):
         parser.add_argument('--ext-mem-config-file', required=False,
                             dest='ext_mem_config_file',
                             help='path to an JSON file with external memory configuration')
+        parser.add_argument('--ncs-provision',
+                            action='store_true',
+                            help='run ncs-provision with default keys')
 
     def _exec(self, args):
         jout_all = []
@@ -115,6 +120,75 @@ def do_get_boards(self):
     def do_require(self):
         self.require('nrfutil')
 
+    def _generate_ncs_provision_key_file(
+        self,
+        keys: list[str] | str,
+        keyname: str,  # UROT_PUBKEY, BL_PUBKEY, APP_PUBKEY
+        output_file: Path
+    ):
+        """Generate a key file for ncs-provision
+
+        This function uses the 'west ncs-provision' command to generate a JSON key file.
+        Note: This functionality requires the sdk-nrf repository to be present, as it's
+        not part of the Zephyr tree.
+        """
+        build_dir = Path(self.cfg.build_dir).parent
+        ncs_keyfile = build_dir / 'keyfile.json'
+        if ncs_keyfile.exists():
+            ncs_keyfile.unlink()
+        command = [
+            'west', 'ncs-provision', 'upload',
+            '--keyname', keyname,
+            '--build-dir', str(build_dir),
+            '--dry-run'
+        ]
+        for key in keys:
+            command += ["--key", key]
+        self.check_call(command)
+
+        # move the generated ncs keyfile to the output_file
+        if output_file.exists():
+            output_file.unlink()
+        ncs_keyfile.rename(output_file)
+
+    def _ncs_provision_for_nsib(self):
+        if not self.sysbuild_conf.getboolean('SB_CONFIG_SECURE_BOOT_SIGNATURE_TYPE_ED25519'):
+            return
+        build_dir = Path(self.cfg.build_dir).parent
+        key_file = self.sysbuild_conf.get('SB_CONFIG_SECURE_BOOT_SIGNING_KEY_FILE') or str(
+            build_dir / 'GENERATED_NON_SECURE_SIGN_KEY_PRIVATE.pem')
+        if not Path(key_file).exists():
+            raise RuntimeError(f'Key file {key_file} does not exist')
+
+        ncs_keyfile = build_dir / 'keyfile_for_nsib.json'
+        self._generate_ncs_provision_key_file(
+            keys=[key_file],
+            keyname='BL_PUBKEY',
+            output_file=ncs_keyfile
+        )
+        self.exec_op('x-provision-keys', keyfile=str(ncs_keyfile))
+
+    def _ncs_provision_for_mcuboot(self):
+        if not self.sysbuild_conf.getboolean('SB_CONFIG_MCUBOOT_SIGNATURE_USING_KMU'):
+            return
+        key_file = self.sysbuild_conf.get('SB_CONFIG_BOOT_SIGNATURE_KEY_FILE')
+        if not Path(key_file).exists():
+            raise RuntimeError(f'Key figrch_rework_testsle {key_file} does not exist')
+
+        ncs_keyfile = Path(self.cfg.build_dir).parent / 'keyfile_for_mcuboot.json'
+        self._generate_ncs_provision_key_file(
+            keys=[key_file],
+            keyname='UROT_PUBKEY',
+            output_file=ncs_keyfile
+        )
+        self.exec_op('x-provision-keys', keyfile=str(ncs_keyfile))
+
+    def do_ncs_provision(self):
+        if not self.ncs_provision:
+            return
+        self._ncs_provision_for_nsib()
+        self._ncs_provision_for_mcuboot()
+
     def _insert_op(self, op):
         op['operationId'] = f'{self._op_id}'
         self._op_id += 1
@@ -147,6 +221,8 @@ def _append_batch(self, op, json_file):
             cmd += ['--reset-kind', _op['kind']]
         elif op_type == 'erase':
             cmd.append(f'--{_op["kind"]}')
+        elif op_type == 'x-provision-keys':
+            cmd += ['--key-file', _op['keyfile']]
 
         cmd += ['--core', op['core']] if op.get('core') else []
         cmd += ['--x-family', f'{self.family}']