Device onboarding with wfx
A message that is not in the archive (sent off-list or not yet received): [email protected]
Hi All,
Just a gentle reminder for some feedback on this patchset.
Thanks and Regards,
Adithya Balakumar
________________________________
From: [email protected] <[email protected]> on behalf of Adithya Balakumar <[email protected]>
Sent: Tuesday, March 10, 2026 10:00 AM
To: [email protected] <[email protected]>; [email protected] <[email protected]>
Cc: balakumar adithya(TSIP DITC_DIT-OST) <[email protected]>; kunijadar shivanand(TSIP DITC_DIT-OST) <[email protected]>; dinesh kumar(TSIP DITC_DIT-OST) <[email protected]>; onuki koshiro(大抜 倖司朗 □DITC○CPT) <[email protected]>; hayashi kazuhiro(林 和宏 □DITC○CPT) <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>
Subject: [cip-dev] [isar-cip-core][RFC v1 0/7] Device onboarding with wfx
From: Adithya Balakumar <[email protected]>
Currently wfx does not handle device registry / onboarding. However, it provides a plugin system that allows to process incoming HTTP requests before they are handed over to wfx's internal logic. This can be leveraged to communicate with external systems based on certain parameters in the http request.
CIP software update WG has created a simple implementation for this purpose [1]. The concept includes wfx (running with a plugin) and a device registry service running in the backend. This requires a few customizations on the image side which is explained by this patch series. This implementation is currently under the cip-playground.
Here are some notes on how the current implementation works:
- The onboarding process is essentially a configuration update handled with SWUpdate.
- The plugin only interecepts the request if the client ID is set as "onboarding" and respond back without allowing the request to reach wfx. Else it lets the request pass through to wfx.
- Creates a onboarding swu file with configuration file.
- Creates a DAU workflow instance (Job).
- Respond with Job ID for onboarding job to SWUpdate.
- SWUpdate queries for the job and installs the onboarding swu in the target.
- A custom progress client [2] listens to progress messages from the onboarding job and triggers a restart swupdate in the activation step.
- The plugin requires signing keys for signing onboarding swu files. Suitable keys as used on the client side must be available to the plugin as well. Currently the plugin uses the snakeoil keys from Debian trixie.
For now I send this as a RFC for a broader visibility to understand how this integration can be improved.
[1] https://gitlab.com/cip-playground/cip-wfx-onboarding-client-plugin
[2] https://gitlab.com/cip-playground/cip-wfx-onboarding-client-plugin/-/tree/master/onboarding-progress-client?ref_type=heads
Adithya Balakumar (7):
swupdate-config-wfx: Add the required configuration of wfx based
onboarding
wfx-onboarding-progress-client: Custom progress client for device
onboarding with wfx
swupdate-config: Add custom-http-headers section in swupdate.cfg
SWUpdate: Use the backported package for trixie
Kconfig: Add kas menu options for wfx based onboarding kas/opt/wfx.yml: Consolidate wfx options into a separate kas yml file doc/README.swupdate.md: Add information about wfx based onboarding
function
Kconfig | 22 +++++++++
conf/distro/cip-core-trixie.conf | 3 ++
conf/distro/debian-trixie-backports.list | 1 +
conf/distro/preferences.trixie-backports.conf | 11 +++++
doc/README.swupdate.md | 46 +++++++++++++++++++
kas/opt/wfx.yml | 22 +++++++++
recipes-core/images/swupdate.inc | 4 --
.../files/suricatta_wfx_onboarding.conf.tmpl | 10 ++++
.../files/swupdate_override.conf | 6 +++
.../swupdate-config-wfx_0.1.bb | 15 ++++--
.../files/{swupdate.cfg => swupdate.cfg.tmpl} | 2 +
.../swupdate-config/swupdate-config_0.2.bb | 18 ++++++--
.../files/postinst | 4 ++
.../wfx-onboarding-progress-client_0.1.bb | 26 +++++++++++
14 files changed, 179 insertions(+), 11 deletions(-)
create mode 100644 conf/distro/debian-trixie-backports.list
create mode 100644 conf/distro/preferences.trixie-backports.conf
create mode 100644 kas/opt/wfx.yml
create mode 100644 recipes-core/swupdate-config-wfx/files/suricatta_wfx_onboarding.conf.tmpl
create mode 100644 recipes-core/swupdate-config-wfx/files/swupdate_override.conf
rename recipes-core/swupdate-config/files/{swupdate.cfg => swupdate.cfg.tmpl} (73%)
create mode 100644 recipes-core/wfx-onboarding-progress-client/files/postinst
create mode 100644 recipes-core/wfx-onboarding-progress-client/wfx-onboarding-progress-client_0.1.bb--
2.39.5