Package: manifest-tool
Device Management manifest CLI toolThis document provides instructions for installing and using the manifest tool.Below is the table of contents:Manifest tool overviewInstalling the manifest toolUsing the manifest toolDeveloper workflow exampleUpgrading from manifest tool v1.5.2 and lowerExternal signing toolTroubleshootingNote:For a comprehensive list of changes between release versions, please refer to thechangelog.Manifest tool overviewThe Device Management allows you to carry out Firmware Over-the-Air (FOTA) updates
on managed devices.On the device side, the firmware update process commences when the device receives an update manifest.The OEM (original equipment manufacturer) or the update author cryptographically signs the manifest with
a private key paired with a public key existing on the device, enabling the device to verify the
manifest's authenticity before accepting the firmware update.Device Management provides support for the following:Full updates - Deliver new firmware and install it on the device.Delta updates - The manifest tool executes a differential algorithm to create a small delta patch file.The client uses the delta patch file and the currently installed firmware to construct a new firmware image,
conserving bandwidth.Combined updates - The FOTA client enables you to define a device component as comprising several
subcomponents that are always updated together and reported to the Update service as a single component.For combined updates, the manifest tool generates a combined package containing multiple firmware images.The client processes the combined package and installs the images in a predefined order you set on the device.Themanifest-toolPython package includes the following command line tools:manifest-tool- Used for creating manifest files.manifest-delta-tool- Generates delta patch
files.manifest-package-tool- Creates combined package file.manifest-dev-tool- A developer tool for
simplifying update campaigns.Installing the manifest toolIt is advisable to install themanifest-toolPython package within a segregatedPython virtual environment.Installing the manifest tool fromPyPiPrerequisites:Python 3.7 ... 3.11.Python 3.12 support is not available yet (it functions on Linux but not on Windows).pip (Python Package Installer).Internet connectivitypip install manifest-toolNote:If your system runs Python 3.6 or an older version, you will need to use an earlier version
of this tool. You can install version 2.4.1 as follows:pip install manifest-tool==2.4.1Installing from local source treePrerequisites:Python 3.7 ... 3.11.pip (Python Package Installer).Native toolchain:GCC/Clang for Linux/MacOS.Microsoft Build Tools for Visual Studio 2019for Windows or a different version compatible with your Python version as describedhere.$ git clone https://github.com/PelionIoT/manifest-tool.git
$ pip install <path to manifest-tool's local source tree>Note:You can use$ pip install --editable <manifest-tool>to install the package
in Python setuptools development mode. For more information, please see thesetuptools development mode documentation.Using the manifest toolThis section provides an explanation of how to use the command-line tools included in themanifest-toolPython package, which are as follows:manifest-toolmanifest-delta-toolmanifest-package-toolmanifest-dev-toolmanifest-toolmanifest-toolcommands:manifest-tool create- Creates manifests.manifest-tool create-v1- Creates V1
schema-compatible manifests.manifest-tool parse- Parses and verifies
existing manifest files.manifest-tool schema- Shows the bundled input
validation schema.manifest-tool public-key- Generates an
uncompressed public key.Note:To access more detailed information about all commands,
you can runmanifest-tool --help. Additionally, for specific command details, including their
parameters and how to use them, you can runmanifest-tool <command> --help.manifest-tool createThemanifest-tool createcommand is used to generate a manifest.
This tool takes a configuration file that defines the update type and
creates a manifest based on the provided details.PrerequisitesAn update private key and public key certificate.Keep the private key secure, as it enables the installation of new firmware images on your devices.Provision the public key to the device.To generate a private key, use the following command:$opensslecparam-genkey-nameprime256v1-outformPEM-outmy.priv.key.pemTo generate a public key in uncompressed point format (X9.62), use
themanifest-tool public-keycommand.Upload the new firmware image to a server that your devices can access.The configuration file should be in JSON or YAML format and include the following fields:vendor:# One of the "domain" or "vendor-id" fields is expected.domain:izumanetworks.com# The FW owner domain, used to generate a vendor UUID.# Expected to include a dot (".").# ORvendor-id:fa6b4a53d5ad5fdfbe9de663e4d41ffe# A valid vendor UUID.custom-data-path:my.custom-data.bin# Vendor's custom data file# to be passed to the target devices.# This is only relevant for manifest v3 format.device:# One of the "model-name" or "class-id" fields is expectedmodel-name:Smart Slippers# A device model name, used to generate a class UUID.# ORclass-id:327c726ac6e54f7a82fbf1d3beda80f0# A valid device-class UUID.priority:1# Update priority  to be passed to the authorization callback,# which is implemented on the device side.payload:url:http://some-url.com/files?id=1234# Address from which the device downloads# the candidate payload.# Obtained by clicking "Copy HTTP URL" on# the Firmware image details screen# in Device Management Portal,# or by copying the `datafile` attribute.file-path:./my.fw.bin# Local path to the candidate payload file# or the delta patch file.# Used for digest calculation and signing.format:raw-binary# One of the following:#  raw-binary       - full image update campaigns.#  arm-patch-stream - delta patch update campaigns.# For manifest v3 only:#  combined           - combined updates.#  encrypted-raw      - full image update with the encrypted image.#  encrypted-combined - combined updates with encrypted image.encrypted:# Required for 'encrypted-raw', and 'encrypted-patch' formats.digest:3725565932eb5b9fbd5767a3a534cb6a1a87813e0b4a76deacb9b36695c71307# The encrypted payload digest,# obtained by copying the `encrypted_datafile_checksum` attribute# from the Firmware image details screen in the Device Management Portal.size:471304# The encrypted payload size,# obtained by copying the `encrypted_datafile_size` attribute# from the Firmware image details screen in the Device Management Portal.component:MAIN# [Optional] The name of the component to be updated,# relevant for manifest v3 format.# By default, it is set to "MAIN" for updating# the main application image.sign-image:True# [Optional] A boolean field accepting True or False values,# relevant for manifest v3 format.# When set to True, a 64-byte raw signature over the installed# image will be added to the manifest.# This image signature can be used when the device bootloader# expects to work with signed images (e.g. secure-boot).# By default, it's set to False.signing-tool:./sign.sh# Path to the external signing tool.# Enables signing with existing infrastructure.# The tool should accept the arguments: <digest algorithm> <key identifier> <input file> <output file>.# The `--key` CLI argument will be used as <key identifier>.ExampleConsider the following configuration file namedmy.config.yaml:vendor:domain:izumanetworks.comdevice:model-name:Smart Flip-flopspriority:1payload:url:http://some-url.com/files?id=1234file-path:./my.fw.binformat:raw-binarycomponent:MAINYou can run the following command to create the manifest:manifest-toolcreate\--configmy.config.yaml\--keymy.priv.key.pem\--fw-version1.2.3\--outputmy.manifest.binNote:The value of--fw-versionrefers to the firmware version of the
component to be updated. The value can be between 0.0.1 and 999.999.999 and must be greater than
the firmware version currently installed on the device.manifest-tool create-v1Themanifest-tool create-v1command is designed for older versions of the
Device Management update client, which use manifest schema V1.
These older versions assume that the public key is packaged in an x.509 certificate.PrerequisitesAn update private key and public key certificate.Keep the private key secure as it enables the installation of new firmware images on your devices.Provision the public key to the device.To generate a private key, use the following command:$opensslecparam-genkey-nameprime256v1-outformPEM-outmy.priv.key.pemTo generate a public key x.509 certificate, run the following commands:$opensslreq-new-sha256\-keymy.priv.key.pem\-informPEM\-outmy.csr.csr
$opensslreq-x509-sha256\-days7300\-keymy.priv.key.pem\-inmy.csr.csr\-outformder\-outmy.x509.certificate.derNote:Device Management update client treats the x.509 certificate as a
containerONLYand does not enforce its validity. such as expiration, chain of trust, etc.,
although it may be validated by other Device Management components.
For production purposes, it is recommended creating a certificate with a lifespan
greater than the product's expected lifespan, e.g. 20 years.Upload the new firmware binary to a server that your devices can access, and obtain the URL for the uploaded firmware binary.A configuration file in JSON or YAML format, as required for themanifest-tool createcommand.ExampleTo create a V1 schema-compatible manifest, you can run the following command:manifest-toolcreate-v1\--configmy.config.yaml\--keymy.priv.key.pem\--update-certificatemy.x509.certificate.der\--outputmy.manifest.binmanifest-tool parseThemanifest-tool parsecommand is used to parse and validate existing manifest files.PrerequisitesA manifest file (for examplemy.manifest.bin).Optionally, you can provide an update private key, public key, or certificate to
validate the manifest's signature.ExampleYou can run the following command to parse and validate a manifest file:$manifest-toolparse\my.manifest.bin\--private-keymy.priv.key.pem
-----Manifestdumpstart-----
Manifest:
vendor-id=fa6b4a53d5ad5fdfbe9de663e4d41ffe
class-id=3da0f138173350eba6f665498eace1b1
update-priority=15payload-version=1572372313payload-digest=b5f07d6c646a7c014cc8c03d2c9caf066bd29006f1356eaeaf13b7d889d3502b
payload-size=512payload-uri=https://my.server.com/some.file?new=1payload-format=raw-binary
-----Manifestdumpend-----2019-10-2920:05:13,478INFOSignatureverified!manifest-tool schemaThemanifest-tool schemacommand is used to print the input validation JSON schema
that is bundled with the current tool.
This schema can serve as a self-documenting reference to help you better understand and validate
the manifest tool's input configuration.ExampleYou can execute the following command to print the input validation schema:$manifest-toolschemamanifest-tool public-keyThemanifest-tool public-keycommand is used to create a public key file in uncompressed point format.
Provisioning this file to the device enables the device to verify the manifest's signature.ExampleTo create a public key file from a private key (for example,my.priv.key.pem) and
save it asmy.pub.key.bin, you can use the following command:manifest-toolpublic-keymy.priv.key.pem--outmy.pub.key.binmanifest-delta-toolThemanifest-delta-toolis used to generate delta patch files, which are required for delta updates.Runmanifest-delta-tool --helpfor more information about usage and
arguments.PrerequisitesThe firmware currently installed on the device and the updated
firmware image. These are required for calculating the delta patch.ExampleYou can use the following command to generate a delta patch file:$manifest-delta-tool-ccurrent_fw.bin-nnew_fw.bin-odelta-patch.binNotes:An additional configuration file with the same name but with the.yamlextension will be generated. Both files are required by the manifest tool.
Only the output file specified by the--outputargument should be uploaded to the Izuma cloud.The compression block size has a direct impact on the amount of
memory required by the device receiving the update. The device requires twice the amount of RAM
during runtime to decompress and apply the patch.The compression block must be aligned with the network (COAP/HTTP)
buffer size used for download. Misalignment in sizes may result in device's failure to process the
delta patch file.manifest-package-toolUse this tool to generate combined package files for combined updates.manifest-package-toolcommands:manifest-package-tool create- Creates a combined package file for combined updates.manifest-package-tool parse- Parses and verifies existing combined package files.Note:Runmanifest-package-tool --helpfor more information about all commands, ormanifest-package-tool <command> --helpfor more information about a specific command, including its parameters and how to use them.manifest-package-tool createThemanifest-package-tool createcommand is used to create a combined package file
based on a configuration file that contains information about firmware images for a combined update.PrerequisitesThe configuration file should be in JSON or YAML format and include the following fields:images:# Two or more images-file_name:./my.fw1.bin# Local path to one of the firmware images.sub_comp_name:fw1_id# Name of the subcomponent firmware image.vendor_data:fw1_vend# Vendor data for the firmware image.-file_name:./my.fw2.bin# Local path to another firmware image.sub_comp_name:fw2_id# Name of the subcomponent firmware image.vendor_data:fw2_vend# Vendor data for the firmware image.New firmware images to be included in the combined package.
In this example./my/fw1.binand./my.fw2.bin.ExampleYou can create a combined package by using the following command:$manifest-package-toolcreate--configcombined_package_config.yaml--outputcombined_package_fileIn this example,combined_package_config.yamlis the input configuration file.The tool creates a tar-format combined package with the firmware images listed in the configuration file, where:file_nameis the local path to the image file.sub_comp_nameis the name the tool gives to the subcomponent firmware image file in the combined package.
This name must match the name (sub_comp_name) defined on the device.vendor_datais the vendor information of the firmware image.In addition to the firmware image files, the tool creates a descriptor__desc__file
inside thetarpackage, which provides information about the contents of the combined package to
the FOTA update client.Notes:The FOTA update client reports on a combined update as an update of a
single component (defined ascomp_nameon the device), consisting of multiple subcomponents
(each defined assub_comp_nameon the device). When creating a combined package, eachsub_comp_namemust correspond to asub_comp_nameon the device.
For more information, seeImplementing combined updateWhen creating a manifest for a combined update usingmanifest-tool, in the manifest configuration
file, set theformatfield tocombinedorencrypted-combined, set thecomponentfield to the
name of the component you are updating, and set thefile-pathfield to the path of the combined
package file.To use a combined package file with themanifest-dev-tool createorupdatecommands,
set the path of the combined package file in the-pargument and pass the--combined-imageflag
to indicate that the current candidate payload is a combined image.manifest-package-tool parseThemanifest-package-tool parsecommand is used to parse and validate existing combined package files.PrerequisitesA combined package file (for examplecombined_package_file).ExampleYou can run the following command to parse and validate a combined package file:$manifest-package-toolparse--packagecombined_package_file
Contentsofthetarpackage-
Filename:_desc_
Filename:fw1_id
Filename:fw1_id
Informationofupdateimages:
OrderedDict([('id',b'fw1_id'),('vendor-data',b'fw1_vend'),('vendor-data-size',8),('image-size',417053)])OrderedDict([('id',b'fw2_id'),('vendor-data',b'fw2_vend'),('vendor-data-size',8),('image-size',253482)])manifest-dev-toolThemanifest-dev-toolis a developer tool designed for running a simplified update campaign.
It is primarily intended for use in development flows and testing.manifest-dev-toolcommands:manifest-dev-tool init- Initializes the
developer environment.manifest-dev-tool create- A simplified
tool for creating manifests.manifest-dev-tool create-v1-
A simplified tool for creating manifests using the V1 schema.manifest-dev-tool update- Allows you to
perform end-to-end tests without leaving the command shell.manifest-dev-tool update-v1- Allows
you to perform end-to-end tests without leaving the command shell using a
V1-schema manifest.Note:You can runmanifest-dev-tool --helpfor more information about
all commands, ormanifest-dev-tool <command> --helpfor more detailed information about a
specific command, including its parameters and how to use them.manifest-dev-tool initThemanifest-dev-tool initcommand is used to initialize the developer environment.Generates credentials and a configuration file in the tool's cache directory:dev.key.pem- An update private key.dev.cert.der- An update public key certificate.dev.cfg.yaml- Developer configuration file.The default cache directory name is.manifest-dev-tool.Generates an update resource C file with symbols that allow
bypassing the provisioning step in the developer flow.
The default name isupdate_default_resources.c.NotesUse the credentials generated bymanifest-dev-tool initin the development stage only.You can keep your access key in the.izuma-dev-presets.yamlfile in your home directory
and pass it using the--gw-presetoption.Example of.izuma-dev-presets.yaml:usa:host:https://api.us-east-1.mbedcloud.comaccess_key:ak_SOME_VERY_SECRET_ACCESS_KEYjapan:host:https://api.ap-northeast-1.mbedcloud.comaccess_key:ak_SOME_OTHER_VERY_SECRET_ACCESS_KEYTo obtain an access key and API host URL, in the Device Management Portal,
clickAccess Management>Access keys>New access key.
Limit access to the.izuma-dev-presets.yamlfile to your user only.ExampleYou can runmanifest-dev-tool initwith an access key as follows:manifest-dev-toolinit--access-key[DeviceManagementaccesskey]Ormanifest-dev-toolinit--gw-presetusamanifest-dev-tool createThemanifest-dev-tool createcommand is used to create developer manifest files
without requiring an input configuration file.ExampleYou can create a developer manifest with the following command:manifest-dev-toolcreate\--payload-urlhttp://test.pdmc.izumanetworks.com?fileId=1256\--payload-pathnew_fw.bin\--fw-version1.2.3\--component-nameMAIN\--outputupdate-manifest.binNotes:To run a delta update, specify the output ofmanifest-delta-toolin the--payload-pathargument and ensure that the.yamloutput with the same name sits
next to that output file.You can add the--sign-imageargument to update a device with a secure bootloader
that requires an image signature.manifest-dev-tool create-v1Themanifest-dev-tool create-v1command is used to create developer manifest files in v1
format without requiring an input configuration file.ExampleYou can create a developer manifest in v1 format with the following command:manifest-dev-toolcreate-v1\--payload-urlhttp://test.pdmc.izumanetworks.com?fileId=1256\--payload-pathnew-fw.bin\--outputupdate-manifest.binNote:To run a delta update, specify the output ofmanifest-delta-toolin the--payload-pathargument and ensure that the.yamloutput with the same name sits next to that output file.manifest-dev-tool updateThemanifest-dev-tool updatecommand is similar tomanifest-dev-tool create,
but it also allows you to interact with Device Management to run a full update campaign.
The command performs the following actions:Uploads the payload to Device Management and obtains the URL.Create a manifest file with the URL from the previous step and
obtains a manifest URL.Creates an update campaign with the manifest URL from the previous
step.Starts the update campaign if you pass the--start-campaignor--wait-for-completionargument.If you pass the--wait-for-completionargument, the tool waits for
the campaign to complete for the time period specified by--timeoutor
until the campaign reaches one of its terminating states.If you pass the--wait-for-completionargument without the--no-cleanupflag, the tool removes the uploaded test resources
from Device Management before exiting.ExampleYou can run a full update campaign with the following command:manifest-dev-toolupdate\--payload-pathmy_new_fw.bin\--fw-version1.2.3\--wait-for-completionNote:The tool creates the device filter for the campaign based on the
uniqueclass-idandvendor-idfields generated by themanifest-dev-tool initcommand.manifest-dev-tool update-v1Themanifest-dev-tool update-v1command is similar tomanifest-dev-tool update,
but it works with a v1-format manifest.ExampleYou can run a full update campaign with a v1-format manifest using the following command:manifest-dev-toolupdate-v1\--payload-pathmy_new_fw.bin\--wait-for-completionDeveloper workflow example for Mbed OS devicesClone thehttps://github.com/PelionIoT/mbed-cloud-client-examplerepository.From within the repository, execute the following command to initialize the developer environment
and generate anupdate_default_resources.cfile:manifest-dev-toolinit-a$MY_ACCESS_KEYBuild the firmware image for your device.Save thembed-cloud-client-example_update.binfile.Flash thembed-cloud-client-example.binto the device.Wait for the device to register in the cloud.Make some changes to the source of the firmware application.Build the firmware update candidate for your device.To test the delta update, create a delta patch:manifest-delta-tool-c<originalmbed-cloud-client-example_update.bin>-n<newmbed-cloud-client-example_update.bin>-odelta.binIssue an update campaign with the following command::manifest-dev-toolupdate--payload-path<newmbed-cloud-client-example_update.binordelta.bin>--wait-for-completionUpgrading from manifest tool v1.5.2 and lowerManifest tool v2.0.0 is not compatible with previous versions.This section explains how to migrate your existing configuration and credentials
for use with manifest-tool version 2.2.0 and higher.Initializing the development environment using previously-defined configuration and credentials.Run the followingmanifest-dev-tool initcommand:manifest-dev-toolinit--api-url<APIURL>\--access-key<Accesskey>\--vendor-id<VendorID>\--class-id<ClassID>\--key<privatekeypath>\--update-certificate<certificatepath>Where<API URL>and<Access key>are the values from the previous.mbed_cloud_config.jsonfile,<Vendor ID>and<Class ID>are the values from the previous.manifest_tool.jsonfile,
and<private key path>and<certificate path>are the paths to your private key and
update certificate, respectively.Once the command finishes successfully, you can remove the previously created files.Adapting the create manifest configurationIf you usemanifest-tool(notmanifest-dev-tool), create a new configuration file,
as described inmanifest-tool create, and copy the relevant information
from your existing.manifest_tool.jsonfile. This ensures that your existing configuration and
credentials are adapted for use with the new version of manifest-tool.External signing toolTypically, the manifest tool is responsible for digitally signing the manifest binary.However, in a production environment where a hardware security module (HSM) is utilized for signing operations, it is preferable to have the HSM perform the manifest signing instead.The manifest tool can seamlessly integrate with an external signing tool for this purpose.The external signing tool should be configured to accept the following parameters:<digestalgorithm><keyidentifier><inputfile><outputfile>Only SHA256 is currently supported as .
Before invoking the script, the manifest tool populates the<input file>with the data to be signed.Once the script execution is completed, the manifest tool retrieves the signature from the<output file>.It's important to note that both of these files should be in their raw binary form.Here is an explanation of how to utilize an external signing tool in both developer and production modes.Production modeTo generate a manifest signed by an external signing tool, follow these steps:Include the following key in the configuration JSON or YAML file used
as a parameter for themanifest-tool createcommand:signing-tool: ./sign.sh # Path to the external signing tool.
                        # Enables signing with existing infrastructure.
                        # The tool should accept the arguments: <digest algorithm> <key identifier> <input file> <output file>.
                        # The `--key` CLI argument will be used as <key identifier>.Execute themanifest-tool createcommand with the$SIGNING_KEY_IDargument. This will use the specified$SIGNING_KEY_IDwith thesigning-toolscript.manifest-toolcreate\--configconfig.yaml\--key$SIGNING_KEY_ID\--fw-version1.2.3\--outputmy.manifest.binThese steps enable the creation of a manifest signed by the designated
external signing tool in a production environment.Developer modeTo test the external signing tool feature, it can be beneficial to use the developer flow.Start by executing themanifest-dev-tool initcommand with the-s,--keyand--update-certificatesparameters as follows:
The$UPDATE_CERTIFICATEcertificate should match the$KEYmanifest-dev-toolinit\-a$MY_ACCESS_KEY\-s$SIGNING_TOOL\--key$KEY\--update-certificate$UPDATE_CERTIFICATEAfter the initiation of themanifest-dev-tool, the subsequentmanifest-dev-toolcommands such asupdate,update-v1,create, andcreate-v1will employ the externalSIGNING_TOOLscript to sign the manifest using the specifiedSIGNING_KEY_ID.TroubleshootingWhen encountering unexpected errors with the manifest tool, it can be helpful to get more
context on the failure. Here are some common issues and their solutions:Getting more context on unexpected errors.When the tool exits with a non-zero return code, it may be helpful to
get more context on the failure.Solution:Execute the tool with the--debugflag at the top
argument parser level. For example:manifest-dev-tool --debug updatemanifest-dev-tool update ... --wait-for-completiontakes longer than expected.manifest-dev-tool updatecreates a uniqueclass-idandvendor-idgenerated per developer. Device Management expects a
single device with these properties to connect to Device Management.During development, a device'sdevice-idmight change
after wiping out its storage, leading to two different devices with
the sameclass-idandvendor-id. In this scenario,
Device Management will try to update both devices,
although one of them no longer exists.Solution:Manually delete the unwanted device from Device
Management. Alternatively, runmanifest-dev-tool update ... --wait-for-completionwith--device-id DEVICE_IDto override the
default campaign filter and target a specific device by its ID.Update fails andmanifest-dev-tool update ... --wait-for-completioncleans all resources.You might want to leave the resources (firmware image candidate,
update manifest, and update campaign) on a service for further
investigation or retry.Solution:Executemanifest-dev-tool update ... --wait-for-completionwith the--no-cleanupflag.Device does not support this manifest schemaSolution:Your device does not support the created manifest schema.
Switch from thecreateorupdatecommand to thecreate-v1orupdate-v1command respectively
and vice versa. Make sure the manifest schema aligns with your device's compatibility.