How to get security updates

Canonical delivers security fixes for Zephyr 26.10 as new source updates. Each update has a new immutable source tag. Only the latest update of the 26.10 release series receives security fixes.

Prerequisites

Before starting, ensure you have these requirements satisfied:

  • A Zephyr 26.10 workspace, in Workshop or on a host system.

  • No uncommitted changes in the workspace repositories that you need to keep.

Run the commands in this guide from the root of your workspace.

How you are notified

Canonical announces each update in:

The release notes describe any action that you must take, such as a configuration change.

Updates are not automatic

A source tag never changes, and your workspace moves to a new tag only when you switch it. You therefore decide when to apply an update.

Similarly, Workshop SDKs do not update automatically. Workshop updates the SDKs only when you run workshop refresh.

Check your current update

Print the source tag that your workspace uses:

$ git -C zephyr-manifest describe --tags --exact-match

Find the latest update

Fetch the tags from Canonical’s manifest repository:

$ git -C zephyr-manifest fetch origin --tags

List the updates in the 26.10 series, newest first:

$ git -C zephyr-manifest tag --list '26.10.*' \
    --sort=-version:refname

If the first tag in the list differs from your current tag, read its release notes, then apply it.

Apply the update

Move the manifest repository to the new tag, replacing source-tag with the tag:

$ git -C zephyr-manifest switch --detach <source-tag>

Synchronize the other repositories with the revisions that the tag pins. In Workshop, run the sync action:

$ workshop run zephyr-26-10 -- sync

On a host system installation, run west update instead:

$ west update

Confirm that the workspace now uses the new tag:

$ git -C zephyr-manifest describe --tags --exact-match

Update the development tools

In Workshop, refresh the SDKs:

$ workshop refresh zephyr-26-10

On a host system installation, upgrade the packages from the PPA:

$ sudo apt update
$ sudo apt upgrade

Rebuild and deploy your firmware

A source update fixes nothing on devices until you rebuild the firmware and install it on them:

  1. Rebuild your application with your production configuration.

  2. If you use MCUboot downgrade prevention, increase the version in your application’s VERSION file.

  3. Sign the image with your production key.

  4. Deliver the image to your devices with your update mechanism, such as MCUmgr image upload with MCUboot.

  5. Record the Zephyr 26.10 source tag with the firmware release.

See also

Explanation:

How-to guides:

Reference: