Secure Vault Integration#

Secure Vault provides hardware-backed protection for sensitive data on supported Silicon Labs devices. In Sidewalk products, it can protect endpoint private keys. The device's manufacturing data stores the references and public credentials needed by the stack; private-key material is protected by the Secure Element.

This page describes the Secure Vault integration shared by the production flow and the development prototype flow. For the provisioning concepts, see Production Provisioning Principles. For the factory procedure that creates credentials on the device, see On-Device Certificate Generation. To evaluate Secure Vault during development using a prototype, see Provision a prototyping device with Secure Vault.

Enable Secure Vault in the application#

In the Sidewalk application project, enable Secure Vault in config/sl_sidewalk_common_config.h:

#ifndef SV_ENABLED
  #define SV_ENABLED 1
#endif // SV_ENABLED

Secure Vault support depends on the selected EFR32 device and its Secure Element configuration. Check the device's security documentation and the SDK release notes for the supported capabilities and requirements.

Production Device Provisioner#

The Production Device Provisioner (PDP) is used during factory provisioning. In the usual flow it runs from RAM and is removed at reboot. When PDP includes the ROW software component, its larger image must be flashed temporarily; after the manufacturing tool completes, erase PDP and flash the product application. See Registration Over Wire for that factory sequence.

The host and device exchange commands using the communication interface configured by the PDP project. The manufacturing tools support UART and RTT; select a transport supported by the PDP build and the factory connection. A zero status code indicates success; nonzero values indicate an error.

Create the PDP project using the Create an Amazon Sidewalk Project walkthrough and select Production Device Provisioner. Build it in Simplicity Studio. The resulting .s37 image is passed to the host provisioning script.

Note: Tool versions and script options can change between SDK releases. Use the versions and invocation documented with the extension you are building against.

Key handling#

With on-device certificate generation, the device creates the private keys and returns certificate signing requests (CSRs) to the host. The Amazon signing process returns certificate chains, which the host transfers back to the device. This keeps private keys on-device while allowing the production system to obtain the public records needed for cloud provisioning.

For prototypes, credentials created in the cloud can be injected and protected by Secure Vault. This is useful for development and testing the hardware integration, but it is not the production key-generation method. Follow the prototyping walkthrough for that workflow.