< draft-ietf-suit-manifest-07.txt   draft-ietf-suit-manifest-08.txt >
SUIT B. Moran SUIT B. Moran
Internet-Draft H. Tschofenig Internet-Draft H. Tschofenig
Intended status: Standards Track Arm Limited Intended status: Standards Track Arm Limited
Expires: December 11, 2020 H. Birkholz Expires: January 13, 2021 H. Birkholz
Fraunhofer SIT Fraunhofer SIT
K. Zandberg K. Zandberg
Inria Inria
June 09, 2020 July 12, 2020
A Concise Binary Object Representation (CBOR)-based Serialization Format A Concise Binary Object Representation (CBOR)-based Serialization Format
for the Software Updates for Internet of Things (SUIT) Manifest for the Software Updates for Internet of Things (SUIT) Manifest
draft-ietf-suit-manifest-07 draft-ietf-suit-manifest-08
Abstract Abstract
This specification describes the format of a manifest. A manifest is This specification describes the format of a manifest. A manifest is
a bundle of metadata about the firmware for an IoT device, where to a bundle of metadata about the firmware for an IoT device, where to
find the firmware, the devices to which it applies, and cryptographic find the firmware, the devices to which it applies, and cryptographic
information protecting the manifest. Firmware updates and secure information protecting the manifest. Firmware updates and secure
boot both tend to use sequences of common operations, so the manifest boot both tend to use sequences of common operations, so the manifest
encodes those sequences of operations, rather than declaring the encodes those sequences of operations, rather than declaring the
metadata. The manifest also serves as a building block for secure metadata. The manifest also serves as a building block for secure
skipping to change at page 1, line 42 skipping to change at page 1, line 42
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/. Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on December 11, 2020. This Internet-Draft will expire on January 13, 2021.
Copyright Notice Copyright Notice
Copyright (c) 2020 IETF Trust and the persons identified as the Copyright (c) 2020 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of (https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Conventions and Terminology . . . . . . . . . . . . . . . . . 5 2. Conventions and Terminology . . . . . . . . . . . . . . . . . 6
3. How to use this Document . . . . . . . . . . . . . . . . . . 6 3. How to use this Document . . . . . . . . . . . . . . . . . . 8
4. Background . . . . . . . . . . . . . . . . . . . . . . . . . 7 4. Background . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1. IoT Firmware Update Constraints . . . . . . . . . . . . . 7 4.1. IoT Firmware Update Constraints . . . . . . . . . . . . . 9
4.2. Update Workflow Model . . . . . . . . . . . . . . . . . . 8 4.2. SUIT Workflow Model . . . . . . . . . . . . . . . . . . . 10
5. Severed Fields . . . . . . . . . . . . . . . . . . . . . . . 9 5. Metadata Structure Overview . . . . . . . . . . . . . . . . . 11
6. Interpreter Behavior . . . . . . . . . . . . . . . . . . . . 10 5.1. Envelope . . . . . . . . . . . . . . . . . . . . . . . . 12
6.1. Interpreter Setup . . . . . . . . . . . . . . . . . . . . 10 5.2. Delegation Chains . . . . . . . . . . . . . . . . . . . . 12
6.2. Required Checks . . . . . . . . . . . . . . . . . . . . . 11 5.3. Authentication Block . . . . . . . . . . . . . . . . . . 13
6.3. Interpreter Fundamental Properties . . . . . . . . . . . 12 5.4. Manifest . . . . . . . . . . . . . . . . . . . . . . . . 13
6.4. Abstract Machine Description . . . . . . . . . . . . . . 12 5.4.1. Critical Metadata . . . . . . . . . . . . . . . . . . 13
6.5. Serialized Processing Interpreter . . . . . . . . . . . . 14 5.4.2. Common . . . . . . . . . . . . . . . . . . . . . . . 13
6.6. Parallel Processing Interpreter . . . . . . . . . . . . . 14 5.4.3. Command Sequences . . . . . . . . . . . . . . . . . . 14
6.7. Processing Dependencies . . . . . . . . . . . . . . . . . 15 5.4.4. Integrity Check Values . . . . . . . . . . . . . . . 14
7. Creating Manifests . . . . . . . . . . . . . . . . . . . . . 15 5.4.5. Human-Readable Text . . . . . . . . . . . . . . . . . 14
7.1. Compatibility Check Template . . . . . . . . . . . . . . 16 5.5. Severable Elements . . . . . . . . . . . . . . . . . . . 15
7.2. Secure Boot Template . . . . . . . . . . . . . . . . . . 16 5.6. Integrated Dependencies and Payloads . . . . . . . . . . 15
7.3. Firmware Download Template . . . . . . . . . . . . . . . 16 6. Interpreter Behavior . . . . . . . . . . . . . . . . . . . . 15
7.4. Load from External Storage Template . . . . . . . . . . . 17 6.1. Interpreter Setup . . . . . . . . . . . . . . . . . . . . 16
7.5. Load & Decompress from External Storage Template . . . . 17 6.2. Required Checks . . . . . . . . . . . . . . . . . . . . . 17
7.6. Dependency Template . . . . . . . . . . . . . . . . . . . 18 6.2.1. Minimizing Signature Verifications . . . . . . . . . 18
8. Envelope . . . . . . . . . . . . . . . . . . . . . . . . . . 18 6.3. Interpreter Fundamental Properties . . . . . . . . . . . 18
8.1. Authenticated Manifests . . . . . . . . . . . . . . . . . 19 6.4. Abstract Machine Description . . . . . . . . . . . . . . 19
8.2. Encrypted Manifests . . . . . . . . . . . . . . . . . . . 20 6.5. Serialized Processing Interpreter . . . . . . . . . . . . 21
8.3. Delegation Info . . . . . . . . . . . . . . . . . . . . . 20 6.6. Parallel Processing Interpreter . . . . . . . . . . . . . 21
8.4. Severable Fields . . . . . . . . . . . . . . . . . . . . 20 6.7. Processing Dependencies . . . . . . . . . . . . . . . . . 22
8.5. Human-Readable Text . . . . . . . . . . . . . . . . . . . 20 6.8. Multiple Manifest Processors . . . . . . . . . . . . . . 22
8.6. COSWID . . . . . . . . . . . . . . . . . . . . . . . . . 21 7. Creating Manifests . . . . . . . . . . . . . . . . . . . . . 23
8.7. Encoding Considerations . . . . . . . . . . . . . . . . . 21 7.1. Compatibility Check Template . . . . . . . . . . . . . . 24
9. Manifest . . . . . . . . . . . . . . . . . . . . . . . . . . 22 7.2. Secure Boot Template . . . . . . . . . . . . . . . . . . 24
9.1. suit-manifest-version . . . . . . . . . . . . . . . . . . 22 7.3. Firmware Download Template . . . . . . . . . . . . . . . 25
9.2. suit-manifest-sequence-number . . . . . . . . . . . . . . 23 7.4. Install Template . . . . . . . . . . . . . . . . . . . . 25
9.3. suit-reference-uri . . . . . . . . . . . . . . . . . . . 23 7.5. Integrated Payload Template . . . . . . . . . . . . . . . 26
9.4. suit-text . . . . . . . . . . . . . . . . . . . . . . . . 23 7.6. Load from Nonvolatile Storage Template . . . . . . . . . 26
9.5. suit-coswid . . . . . . . . . . . . . . . . . . . . . . . 23 7.7. Load & Decompress from Nonvolatile Storage Template . . . 26
9.6. Dependencies . . . . . . . . . . . . . . . . . . . . . . 23 7.8. Dependency Template . . . . . . . . . . . . . . . . . . . 27
9.7. SUIT_Component_Reference . . . . . . . . . . . . . . . . 24 7.8.1. Composite Manifests . . . . . . . . . . . . . . . . . 27
9.8. SUIT_Command_Sequence . . . . . . . . . . . . . . . . . . 24 7.9. Encrypted Manifest Template . . . . . . . . . . . . . . . 28
9.8.1. suit-common . . . . . . . . . . . . . . . . . . . . . 26 7.10. A/B Image Template . . . . . . . . . . . . . . . . . . . 28
9.8.2. SUIT_Parameters . . . . . . . . . . . . . . . . . . . 26 8. Metadata Structure . . . . . . . . . . . . . . . . . . . . . 29
9.8.3. SUIT_Condition . . . . . . . . . . . . . . . . . . . 31 8.1. Encoding Considerations . . . . . . . . . . . . . . . . . 30
9.8.4. SUIT_Directive . . . . . . . . . . . . . . . . . . . 36 8.2. Envelope . . . . . . . . . . . . . . . . . . . . . . . . 30
10. Access Control Lists . . . . . . . . . . . . . . . . . . . . 42 8.3. Delegation Chains . . . . . . . . . . . . . . . . . . . . 30
11. SUIT Digest Container . . . . . . . . . . . . . . . . . . . . 43 8.4. Authenticated Manifests . . . . . . . . . . . . . . . . . 31
12. Creating Conditional Sequences . . . . . . . . . . . . . . . 43 8.5. Encrypted Manifests . . . . . . . . . . . . . . . . . . . 31
13. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 45 8.6. Manifest . . . . . . . . . . . . . . . . . . . . . . . . 31
13.1. SUIT Directives . . . . . . . . . . . . . . . . . . . . 45 8.6.1. suit-manifest-version . . . . . . . . . . . . . . . . 32
13.2. SUIT Conditions . . . . . . . . . . . . . . . . . . . . 46 8.6.2. suit-manifest-sequence-number . . . . . . . . . . . . 32
13.3. SUIT Parameters . . . . . . . . . . . . . . . . . . . . 46 8.6.3. suit-reference-uri . . . . . . . . . . . . . . . . . 32
13.4. SUIT Text Values . . . . . . . . . . . . . . . . . . . . 48 8.6.4. suit-text . . . . . . . . . . . . . . . . . . . . . . 33
13.5. SUIT Algorithm Identifiers . . . . . . . . . . . . . . . 48 8.7. text-version-required . . . . . . . . . . . . . . . . . . 34
13.5.1. Hash Algorithms . . . . . . . . . . . . . . . . . . 48 8.7.1. suit-coswid . . . . . . . . . . . . . . . . . . . . . 34
13.5.2. Unpack Algorithms . . . . . . . . . . . . . . . . . 49 8.7.2. suit-common . . . . . . . . . . . . . . . . . . . . . 35
14. Security Considerations . . . . . . . . . . . . . . . . . . . 49 8.7.3. SUIT_Command_Sequence . . . . . . . . . . . . . . . . 36
15. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 49 8.7.4. Reporting Policy . . . . . . . . . . . . . . . . . . 39
16. References . . . . . . . . . . . . . . . . . . . . . . . . . 50 8.7.5. SUIT_Parameters . . . . . . . . . . . . . . . . . . . 40
16.1. Normative References . . . . . . . . . . . . . . . . . . 50 8.7.6. SUIT_Condition . . . . . . . . . . . . . . . . . . . 50
16.2. Informative References . . . . . . . . . . . . . . . . . 51 8.7.7. SUIT_Directive . . . . . . . . . . . . . . . . . . . 54
A. Full CDDL . . . . . . . . . . . . . . . . . . . . . . . . . . 53 8.7.8. Integrity Check Values . . . . . . . . . . . . . . . 60
B. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 8.8. Severable Elements . . . . . . . . . . . . . . . . . . . 61
B.1. Example 0: Secure Boot . . . . . . . . . . . . . . . . . 61 9. Access Control Lists . . . . . . . . . . . . . . . . . . . . 61
10. SUIT Digest Container . . . . . . . . . . . . . . . . . . . . 62
11. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 62
11.1. SUIT Commands . . . . . . . . . . . . . . . . . . . . . 63
11.2. SUIT Parameters . . . . . . . . . . . . . . . . . . . . 64
11.3. SUIT Text Values . . . . . . . . . . . . . . . . . . . . 66
11.4. SUIT Component Text Values . . . . . . . . . . . . . . . 66
11.5. SUIT Algorithm Identifiers . . . . . . . . . . . . . . . 66
11.5.1. SUIT Digest Algorithm Identifiers . . . . . . . . . 66
11.5.2. SUIT Compression Algorithm Identifiers . . . . . . . 67
11.5.3. Unpack Algorithms . . . . . . . . . . . . . . . . . 67
12. Security Considerations . . . . . . . . . . . . . . . . . . . 68
13. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 68
14. References . . . . . . . . . . . . . . . . . . . . . . . . . 68
14.1. Normative References . . . . . . . . . . . . . . . . . . 68
14.2. Informative References . . . . . . . . . . . . . . . . . 69
14.3. URIs . . . . . . . . . . . . . . . . . . . . . . . . . . 70
A. Full CDDL . . . . . . . . . . . . . . . . . . . . . . . . . . 71
B. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
B.1. Example 0: Secure Boot . . . . . . . . . . . . . . . . . 82
B.2. Example 1: Simultaneous Download and Installation of B.2. Example 1: Simultaneous Download and Installation of
Payload . . . . . . . . . . . . . . . . . . . . . . . . . 63 Payload . . . . . . . . . . . . . . . . . . . . . . . . . 84
B.3. Example 2: Simultaneous Download, Installation, and B.3. Example 2: Simultaneous Download, Installation, Secure
Secure Boot . . . . . . . . . . . . . . . . . . . . . . . 66 Boot, Severed Fields . . . . . . . . . . . . . . . . . . 87
B.4. Example 3: Load from External Storage . . . . . . . . . . 68 B.4. Example 3: A/B images . . . . . . . . . . . . . . . . . . 91
B.5. Example 4: Load and Decompress from External Storage . . 71 B.5. Example 4: Load and Decompress from External Storage . . 95
B.6. Example 5: Compatibility Test, Download, Installation, B.6. Example 5: Two Images . . . . . . . . . . . . . . . . . . 99
and Secure Boot . . . . . . . . . . . . . . . . . . . . . 73 C. Design Rational . . . . . . . . . . . . . . . . . . . . . . . 102
B.7. Example 6: Two Images . . . . . . . . . . . . . . . . . . 76 C.1. C.1 Design Rationale: Envelope . . . . . . . . . . . . . 103
C. Design Rational . . . . . . . . . . . . . . . . . . . . . . . 79 C.2. C.2 Byte String Wrappers . . . . . . . . . . . . . . . . 104
D. Implementation Conformance Matrix . . . . . . . . . . . . . . 80 D. Implementation Conformance Matrix . . . . . . . . . . . . . . 105
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 84 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 108
1. Introduction 1. Introduction
A firmware update mechanism is an essential security feature for IoT A firmware update mechanism is an essential security feature for IoT
devices to deal with vulnerabilities. While the transport of devices to deal with vulnerabilities. While the transport of
firmware images to the devices themselves is important there are firmware images to the devices themselves is important there are
already various techniques available. Equally important is the already various techniques available. Equally important is the
inclusion of metadata about the conveyed firmware image (in the form inclusion of metadata about the conveyed firmware image (in the form
of a manifest) and the use of a security wrapper to provide end-to- of a manifest) and the use of a security wrapper to provide end-to-
end security protection to detect modifications and (optionally) to end security protection to detect modifications and (optionally) to
skipping to change at page 5, line 23 skipping to change at page 5, line 40
firmware at boot. firmware at boot.
Each of these uses happens at a different stage of the manifest Each of these uses happens at a different stage of the manifest
lifecycle, so each has different requirements. lifecycle, so each has different requirements.
It is assumed that the reader is familiar with the high-level It is assumed that the reader is familiar with the high-level
firmware update architecture [I-D.ietf-suit-architecture] and the firmware update architecture [I-D.ietf-suit-architecture] and the
threats, requirements, and user stories in threats, requirements, and user stories in
[I-D.ietf-suit-information-model]. [I-D.ietf-suit-information-model].
A core concept of the SUIT manifest specification are commands. The design of this specification is based on an observation that the
Commands are either conditions or directives used to define the vast majority of operations that a device can perform during an
required behavior. Conceptually, a sequence of commands is like a update or secure boot are composed of a small group of operations:
script but the used language is tailored to software updates and
secure boot. - Copy some data from one place to another
- Transform some data
- Digest some data and compare to an expected value
- Compare some system parameters to an expected value
- Run some code
In the SUIT manifest specification, these operations are called
commands. Commands are classed as either conditions or directives.
Conditions have no side-effects, while directives do have side-
effects. Conceptually, a sequence of commands is like a script but
the used language is tailored to software updates and secure boot.
The available commands support simple steps, such as copying a The available commands support simple steps, such as copying a
firmware image from one place to another, checking that a firmware firmware image from one place to another, checking that a firmware
image is correct, verifying that the specified firmware is the image is correct, verifying that the specified firmware is the
correct firmware for the device, or unpacking a firmware. By using correct firmware for the device, or unpacking a firmware. By using
these steps in different orders and changing the parameters they use, these steps in different orders and changing the parameters they use,
a broad range of use cases can be supported. The SUIT manifest uses a broad range of use cases can be supported. The SUIT manifest uses
this observation to heavily optimize metadata for consumption by this observation to optimize metadata for consumption by constrained
constrained devices. devices.
While the SUIT manifest is informed by and optimized for firmware While the SUIT manifest is informed by and optimized for firmware
update and secure boot use cases, there is nothing in the update and secure boot use cases, there is nothing in the
[I-D.ietf-suit-information-model] that restricts its use to only [I-D.ietf-suit-information-model] that restricts its use to only
those use cases. Other use cases include the management of trusted those use cases. Other use cases include the management of trusted
applications in a Trusted Execution Environment (TEE), see applications in a Trusted Execution Environment (TEE), see
[I-D.ietf-teep-architecture]. [I-D.ietf-teep-architecture].
2. Conventions and Terminology 2. Conventions and Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in "OPTIONAL" in this document are to be interpreted as described in
BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all
capitals, as shown here. capitals, as shown here.
The following terminology is used throughout this document: The following terminology is used throughout this document:
- SUIT: Software Update for the Internet of Things, the IETF working - SUIT: Software Update for the Internet of Things, also the IETF
group for this standard. working group for this standard.
- Payload: A piece of information to be delivered. Typically - Payload: A piece of information to be delivered. Typically
Firmware for the purposes of SUIT. Firmware for the purposes of SUIT.
- Resource: A piece of information that is used to construct a - Resource: A piece of information that is used to construct a
payload. payload.
- Manifest: A manifest is a bundle of metadata about the firmware - Manifest: A manifest is a bundle of metadata about the firmware
for an IoT device, where to find the firmware, the devices to for an IoT device, where to find the firmware, and the devices to
which it applies, and cryptographic information protecting the which it applies.
manifest.
- Envelope: A container with the manifest, an authentication - Envelope: A container with the manifest, an authentication wrapper
wrapper, authorization information, and severed fields. with cryptographic information protecting the manifest,
authorization information, and severed fields.
- Update: One or more manifests that describe one or more payloads. - Update: One or more manifests that describe one or more payloads.
- Update Authority: The owner of a cryptographic key used to sign - Update Authority: The owner of a cryptographic key used to sign
updates, trusted by Recipients. updates, trusted by Recipients.
- Recipient: The system, typically an IoT device, that receives a - Recipient: The system, typically an IoT device, that receives and
manifest. processes a manifest.
- Manifest Processor: A component of the Recipient that consumes
Manifests and executes the commands in the Manifest.
- Component: An updatable logical block of the Firmware, Software,
configuration, or data of the Recipient.
- Component Set: A group of interdependent Components that must be
updated simultaneously.
- Command: A Condition or a Directive. - Command: A Condition or a Directive.
- Condition: A test for a property of the Recipient or its - Condition: A test for a property of the Recipient or its
components. Components.
- Directive: An action for the Recipient to perform. - Directive: An action for the Recipient to perform.
- Trusted Execution: A process by which a system ensures that only - Trusted Execution: A process by which a system ensures that only
trusted code is executed, for example secure boot. trusted code is executed, for example secure boot.
- A/B images: Dividing a device's storage into two or more bootable - A/B images: Dividing a Recipient's storage into two or more
images, at different offsets, such that the active image can write bootable images, at different offsets, such that the active image
to the inactive image(s). can write to the inactive image(s).
- Record: The result of a Command and any metadata about it.
- Report: A list of Records.
- Procedure: The process of invoking one or more sequences of
commands.
- Update Procedure: A procedure that updates a Recipient by fetching
dependencies, software images, and installing them.
- Boot Procedure: A procedure that boots a Recipient by verifying
dependencies and images, loading images, and invoking one or more
image.
- Software: Instructions and data that allow a Recipient to perform
a useful function.
- Firmware: Instructions and data that allow a Recipient to perform
a useful function. Typically, changed infrequently, stored in
nonvolatile memory, and small enough to apply to [RFC7228] Class
0-2 devices.
- Image: Information that a Recipient uses to perform its function,
typically firmware/software, configuration, or resource data such
as text or images. Also, a Payload, once installed is an Image.
- Slot: One of several possible storage locations for a given
Component, typically used in A/B image systems
- Abort: The Manifest Processor immediately halts execution of the
current Procedure. It creates a Record of an error condition.
3. How to use this Document 3. How to use this Document
This specification covers four aspects of firmware update: This specification covers five aspects of firmware update:
- Section 4 describes the device constraints, use cases, and design - Section 4 describes the device constraints, use cases, and design
principles that informed the structure of the manifest. principles that informed the structure of the manifest.
- Section 6 describes what actions a manifest processor should take. - Section 5 gives a general overview of the metadata structure to
inform the following sections
- Section 7 describes the process of creating a manifest. - Section 6 describes what actions a Manifest processor should take.
- Section 9 specifies the content of the manifest and the envelope. - Section 7 describes the process of creating a Manifest.
To implement an updatable device, see Section 6 and Section 9. To - Section 8 specifies the content of the Envelope and the Manifest.
implement a tool that generates updates, see Section 7 and Section 9.
The IANA consideration section, see Section 13, provides instructions To implement an updatable device, see Section 6 and Section 8. To
implement a tool that generates updates, see Section 7 and Section 8.
The IANA consideration section, see Section 11, provides instructions
to IANA to create several registries. This section also provides the to IANA to create several registries. This section also provides the
CBOR labels for the structures defined in this document. CBOR labels for the structures defined in this document.
The complete CDDL description is provided in Appendix A, examples are The complete CDDL description is provided in [full-cddl], examples
given in Appendix B and a design rational is offered in Appendix C. are given in [examples] and a design rational is offered in
Finally, Appendix D gives a summarize of the mandatory-to-implement [design-rationale]. Finally, [implementation-matrix] gives a
features of this specification. summarize of the mandatory-to-implement features of this
specification.
4. Background 4. Background
Distributing firmware updates to diverse devices with diverse trust Distributing firmware updates to diverse devices with diverse trust
anchors in a coordinated system presents unique challenges. Devices anchors in a coordinated system presents unique challenges. Devices
have a broad set of constraints, requiring different metadata to make have a broad set of constraints, requiring different metadata to make
appropriate decisions. There may be many actors in production IoT appropriate decisions. There may be many actors in production IoT
systems, each of whom has some authority. Distributing firmware in systems, each of whom has some authority. Distributing firmware in
such a multi-party environment presents additional challenges. Each such a multi-party environment presents additional challenges. Each
party requires a different subset of data. Some data may not be party requires a different subset of data. Some data may not be
skipping to change at page 8, line 20 skipping to change at page 10, line 5
- extra information may need to be conveyed in the manifest in the - extra information may need to be conveyed in the manifest in the
earlier stages of the device lifecycle before those data items are earlier stages of the device lifecycle before those data items are
stripped when the manifest is delivery to a constrained device. stripped when the manifest is delivery to a constrained device.
Supporting the requirements introduced by the constraints on IoT Supporting the requirements introduced by the constraints on IoT
devices requires the flexibility to represent a diverse set of devices requires the flexibility to represent a diverse set of
possible metadata, but also requires that the encoding is kept possible metadata, but also requires that the encoding is kept
simple. simple.
4.2. Update Workflow Model 4.2. SUIT Workflow Model
There are several fundamental assumptions that inform the model of There are several fundamental assumptions that inform the model of
the firmware update workflow: Update Procedure workflow:
- Compatibility must be checked before any other operation is - Compatibility must be checked before any other operation is
performed. performed.
- All dependency manifests should be present before any payload is - All dependency manifests should be present before any payload is
fetched. fetched.
- In some applications, payloads must be fetched and validated prior - In some applications, payloads must be fetched and validated prior
to installation. to installation.
There are several fundamental assumptions that inform the model of There are several fundamental assumptions that inform the model of
the secure boot workflow: the Boot Procedure workflow:
- Compatibility must be checked before any other operation is - Compatibility must be checked before any other operation is
performed. performed.
- All dependencies and payloads must be validated prior to loading. - All dependencies and payloads must be validated prior to loading.
- All loaded images must be validated prior to execution. - All loaded images must be validated prior to execution.
Based on these assumptions, the manifest is structured to work with a Based on these assumptions, the manifest is structured to work with a
pull parser, where each section of the manifest is used in sequence. pull parser, where each section of the manifest is used in sequence.
The expected workflow for a device installing an update can be broken The expected workflow for a Recipient installing an update can be
down into five steps: broken down into five steps:
1. Verify the signature of the manifest. 1. Verify the signature of the manifest.
2. Verify the applicability of the manifest. 2. Verify the applicability of the manifest.
3. Resolve dependencies. 3. Resolve dependencies.
4. Fetch payload(s). 4. Fetch payload(s).
5. Install payload(s). 5. Install payload(s).
skipping to change at page 9, line 21 skipping to change at page 11, line 6
When installation is complete, similar information can be used for When installation is complete, similar information can be used for
validating and running images in a further three steps: validating and running images in a further three steps:
1. Verify image(s). 1. Verify image(s).
2. Load image(s). 2. Load image(s).
3. Run image(s). 3. Run image(s).
If verification and running is implemented in a bootloader, then the If verification and running is implemented in a bootloader, then the
bootloader must also verify the signature of the manifest and the bootloader MUST also verify the signature of the manifest and the
applicability of the manifest in order to implement secure boot applicability of the manifest in order to implement secure boot
workflows. The bootloader may add its own authentication, e.g. a workflows. The bootloader may add its own authentication, e.g. a
MAC, to the manifest in order to prevent further verifications. MAC, to the manifest in order to prevent further verifications.
When multiple manifests are used for an update, each manifest's steps When multiple manifests are used for an update, each manifest's steps
occur in a lockstep fashion; all manifests have dependency resolution occur in a lockstep fashion; all manifests have dependency resolution
performed before any manifest performs a payload fetch, etc. performed before any manifest performs a payload fetch, etc.
5. Severed Fields 5. Metadata Structure Overview
Because the manifest can be used by different actors at different This section provides a high level overview of the manifest
times, some parts of the manifest can be removed without affecting structure. The full description of the manifest structure is in
later stages of the lifecycle. This is called "Severing." Severing Section 8.6
of information is achieved by separating that information from the
signed container so that removing it does not affect the signature.
This means that ensuring authenticity of severable parts of the
manifest is a requirement for the signed portion of the manifest.
Severing some parts makes it possible to discard parts of the
manifest that are no longer necessary. This is important because it
allows the storage used by the manifest to be greatly reduced. For
example, no text size limits are needed if text is removed from the
manifest prior to delivery to a constrained device.
Elements are made severable by removing them from the manifest, The manifest is structured from several key components:
encoding them in a bstr, and placing a SUIT_Digest of the bstr in the
manifest so that they can still be authenticated. The SUIT_Digest
typically consumes 4 bytes more than the size of the raw digest,
therefore elements smaller than (Digest Bits)/8 + 4 should never be
severable. Elements larger than (Digest Bits)/8 + 4 may be
severable, while elements that are much larger than (Digest Bits)/8 +
4 should be severable.
Because of this, all command sequences in the manifest are encoded in 1. The Envelope (see Section 5.1) contains Delegation Chains, the
a bstr so that there is a single code path needed for all command Authentication Block, the Manifest, any Severable Elements, and
sequences. any Integrated Payloads or Dependencies.
2. Delegation Chains (see Section 5.2) allow a Recipient to work
from one of its Trust Anchors to an authority of the
Authentication Block.
3. The Authentication Block (see Section 5.3) contains a list of
signatures or MACs of the manifest..
4. The Manifest (see Section 5.4) contains all critical, non-
severable metadata that the Recipient requires. It is further
broken down into:
1. Critical metadata, such as sequence number.
2. Common metadata, including lists of dependencies and affected
components.
3. Command sequences, directing the Recipient how to install and
use the payload(s).
4. Integrity check values for severable fields.
5. Severable fields (see Section 5.5).
6. Integrated dependencies (see Section 5.6).
7. Integrated payloads (see Section 5.6).
The diagram below illustrates the hierarchy of the Envelope.
+-------------------------+
| Envelope |
+-------------------------+
| Delegation Chains |
| Authentication Block |
| Manifest ------------> +------------------------------+
| Severable Elements | | Manifest |
| Human-Readable Text | +------------------------------+
| COSWID | | Structure Version |
| Integrated Dependencies | | Sequence Number |
| Integrated Payloads | | Reference to Full Manifest |
+-------------------------+ +------ Common Structure |
| +---- Commands |
+-----------------------+ | | | Digests of Envelope Elements |
| Common Structure | <--+ | +------------------------------+
+-----------------------+ |
| Dependencies | +-> +-----------------------+
| Components IDs | | Commands |
| Common Commands ---------------> +-----------------------+
+-----------------------+ | List of ( pairs of ( |
| * command code |
| * argument |
| )) |
+-----------------------+
5.1. Envelope
The SUIT Envelope is a container that encloses Delegation Chains, the
Authentication Block, the Manifest, any Severable Elements, and any
integrated payloads or dependencies. The Envelope is used instead of
conventional cryptographic envelopes, such as COSE_Envelope because
it allows modular processing, severing of elements, and integrated
payloads in a way that would add substantial complexity with existing
solutions. See Appendix C.1 for a description of the reasoning for
this.
See Section 8.2 for more detail.
5.2. Delegation Chains
Delegation Chains allow a Recipient to validate intermediate Update
Authorities against long-term a Trust Anchor. These are lists of
CWTs, where the first in the list is signed by a Trust Anchor.
See Section 8.3 for more detail.
5.3. Authentication Block
The Authentication Block contains one or more COSE authentication
blocks. These blocks are one of:
- COSE_Sign_Tagged
- COSE_Sign1_Tagged
- COSE_Mac_Tagged
- COSE_Mac0_Tagged
The payload element in each of these COSE elements is a SUIT_Digest
Section 10.
See Section 8.4 for more detail.
5.4. Manifest
The Manifest contains most metadata about one or more images. The
Manifest is divided into Critical Metadata, Common Metadata, Command
Sequences, and Integrity Check Values.
See Section 8.6 for more detail.
5.4.1. Critical Metadata
Some metadata needs to be accessed before the manifest is processed.
This metadata can be used to determine which the newest manifest is
and whether the structure version is supported. It also MAY provide
a URI for obtaining a canonical copy of the manifest and Envelope.
See Section 8.6.1, Section 8.6.2, Section 8.6.3 for more detail.
5.4.2. Common
Some metadata is used repeatedly and in more than one command
sequence. In order to reduce the size of the manifest, this metadata
is collected into the Common section. Common is composed of three
parts: a list of dependencies, a list of components referenced by the
manifest, and a command sequence to execute prior to each other
command sequence. The common command sequence is typically used to
set commonly used values and perform compatibility checks. The
common command sequence MUST NOT have any side-effects outside of
setting parameter values.
See Section 8.7.2, Section 8.7.2.1 for more detail.
5.4.3. Command Sequences
Command sequences provide the instructions that a Recipient requires
in order to install or use an image. These sequences tell a device
to set parameter values, test system parameters, copy data from one
place to another, transform data, digest data, and run code.
Command sequences are broken up into three groups: Common Command
Sequence (see Section 5.4.2), update commands, and secure boot
commands.
Update Command Sequences are: Dependency Resolution, Payload Fetch,
and Payload Installation. An Update Procedure is the complete set of
each Update Command Sequence, each preceded by the Common Command
Sequence.
Boot Command Sequences are: System Validation, Image Loading, and
Image Invocation. A Boot Procedure is the complete set of each Boot
Command Sequence, each preceded by the Common Command Sequence.
Command Sequences are grouped into these sets to ensure that there is
common coordination between dependencies and dependents on when to
execute each command.
See Section 8.7.3 for more detail.
5.4.4. Integrity Check Values
To enable Section 5.5, there needs to be a mechanism to verify
integrity of any metadata outside the manifest. Integrity Check
Values are used to verify the integrity of metadata that is not
contained in the manifest. This MAY include Severable Command
Sequences, CoSWID, or Text data. Integrated Dependencies and
Integrated Payloads are integrity-checked using Command Sequences, so
they do not have Integrity Check Values present in the Manifest.
See Section 8.7.8 for more detail.
5.4.5. Human-Readable Text
Text is typically a Severable Element (Section 5.5). It contains all
the text that describes the update. Because text is explicitly for
human consumption, it is all grouped together so that it can be
Severed easily. The text section has space both for describing the
manifest as a whole and for describing each individual component.
See Section 8.6.4 for more detail.
5.5. Severable Elements
Severable Elements are elements of the Envelope (Section 5.1) that
have Integrity Check Values (Section 5.4.4) in the Manifest
(Section 5.4).
Because of this organisation, these elements can be discarded or
"Severed" from the Envelope without changing the signature of the
Manifest. This allows savings based on the size of the Envelope in
several scenarios, for example:
- A management system Severs the Text and CoSWID sections before
sending an Envelope to a constrained Recipient, which saves
Recipient bandwidth.
- A Recipient Severs the Installation section after installing the
Update, which saves storage space.
See Section 8.8 for more detail.
5.6. Integrated Dependencies and Payloads
In some cases, it is beneficial to include a dependency or a payload
in the Envelope of a manifest. For example:
- When an update is delivered via a comparatively unconstrained
medium, such as a removable mass storage device, it may be
beneficial to bundle updates into single files.
- When a manifest requires encryption, it must be referenced as a
dependency, so a trivial manifest may be used to enclose the
encrypted manifest. The encrypted manifest may be contained in
the dependent manifest's envelope.
- When a manifest transports a small payload, such as an encrypted
key, that payload may be placed in the manifest's envelope.
See Section 7.8.1, Section 8.5 for more detail.
6. Interpreter Behavior 6. Interpreter Behavior
This section describes the behavior of the manifest interpreter and This section describes the behavior of the manifest interpreter and
focuses primarily on interpreting commands in the manifest. However, focuses primarily on interpreting commands in the manifest. However,
there are several other important behaviors of the interpreter: there are several other important behaviors of the interpreter:
encoding version detection, rollback protection, and authenticity encoding version detection, rollback protection, and authenticity
verification are chief among these. verification are chief among these.
6.1. Interpreter Setup 6.1. Interpreter Setup
skipping to change at page 11, line 7 skipping to change at page 16, line 44
- Payload not available. - Payload not available.
- Dependency not available. - Dependency not available.
- Application crashed when executed. - Application crashed when executed.
- Watchdog timeout occurred. - Watchdog timeout occurred.
- Dependency or Payload verification failed. - Dependency or Payload verification failed.
- Missing component from a set.
These failure reasons MAY be combined with retry mechanisms prior to These failure reasons MAY be combined with retry mechanisms prior to
marking a manifest as invalid. marking a manifest as invalid.
Following these initial tests, the interpreter clears all parameter Following these initial tests, the interpreter clears all parameter
storage. This ensures that the interpreter begins without any leaked storage. This ensures that the interpreter begins without any leaked
data. data.
6.2. Required Checks 6.2. Required Checks
The RECOMMENDED process is to verify the signature of the manifest The RECOMMENDED process is to verify the signature of the manifest
prior to parsing/executing any section of the manifest. This guards prior to parsing/executing any section of the manifest. This guards
the parser against arbitrary input by unauthenticated third parties, the parser against arbitrary input by unauthenticated third parties,
but it costs extra energy when a device receives an incompatible but it costs extra energy when a Recipient receives an incompatible
manifest. manifest.
A device MAY choose to parse and execute only the SUIT_Common section When validating authenticity of manifests, the interpreter MAY use an
of the manifest prior to signature verification, if - it expects to ACL (see Section 9) to determine the extent of the rights conferred
receive many incompatible manifests, and - it has power budget that by that authenticity. Where a device supports only one level of
makes signature verification undesirable. access, it MAY choose to skip signature verification of dependencies,
since they are referenced by digest. Where a device supports more
The guidelines in Creating Manifests (Section 7) require that the than one trusted party, it MAY choose to defer the verification of
common section contains the applicability checks, so this section is signatures of dependencies until the list of affected components is
sufficient for applicability verification. The manifest parser MUST known so that it can skip redundant signature verifications. For
NOT execute any command with side-effects outside the parser (for example, a dependency signed by the same author as the dependent does
example, Run, Copy, Swap, or Fetch commands) prior to authentication not require a signature verification. Similarly, if the signer of
and any such command MUST result in an error. the dependent has full rights to the device, according to the ACL,
then no signature verification is necessary on the dependency.
Once a valid, authentic manifest has been selected, the interpreter Once a valid, authentic manifest has been selected, the interpreter
MUST examine the component list and verify that its maximum number of MUST examine the component list and verify that its maximum number of
components is not exceeded and that each listed component ID is components is not exceeded and that each listed component ID is
supported. supported.
For each listed component, the interpreter MUST provide storage for For each listed component, the interpreter MUST provide storage for
the supported parameters. If the interpreter does not have the supported parameters. If the interpreter does not have
sufficient temporary storage to process the parameters for all sufficient temporary storage to process the parameters for all
components, it MAY process components serially for each command components, it MAY process components serially for each command
skipping to change at page 12, line 15 skipping to change at page 18, line 9
1. At the beginning of each section in the dependent: all previous 1. At the beginning of each section in the dependent: all previous
sections of each dependency have been executed. sections of each dependency have been executed.
2. At the end of each section in the dependent: The corresponding 2. At the end of each section in the dependent: The corresponding
section in each dependency has been executed. section in each dependency has been executed.
If the interpreter does not support dependencies and a manifest If the interpreter does not support dependencies and a manifest
specifies a dependency, then the interpreter MUST reject the specifies a dependency, then the interpreter MUST reject the
manifest. manifest.
If a Recipient supports groups of interdependent components (a
Component Set), then it SHOULD require that all Components in the
Component Set are specified by one manifest and its dependencies.
This manifest is called the Root Manifest.
6.2.1. Minimizing Signature Verifications
Signature verification can be energy and time expensive on a
constrained device. MAC verification is typically unaffected by
these concerns. A Recipient MAY choose to parse and execute only the
SUIT_Common section of the manifest prior to signature verification,
if all of the below apply:
- The Authentication Block contains a COSE_Sign_Tagged or
COSE_Sign1_Tagged
- The Recipient can receive many incompatible or inapplicable
manifests, and
- The Recipient has a power budget that makes signature verification
undesirable
The guidelines in Creating Manifests (Section 7) require that the
common section contains the applicability checks, so this section is
sufficient for applicability verification. The parser MUST restrict
acceptable commands to: Conditions, Override Parameters, Set
Parameters, Try-Each, and Run Sequence ONLY. The manifest parser
MUST NOT execute any command with side-effects outside the parser
(for example, Run, Copy, Swap, or Fetch commands) prior to
authentication and any such command MUST Abort. The Common Sequence
MUST be executed again in its entirety after authenticity validation.
When executing Common prior to authenticity validation, the Manifest
Processor MUST evaluate the integrity of the manifest using the
SUIT_Digest present in the authentication block.
Alternatively, a Recipient MAY rely on network infrastructure to
filter inapplicable manifests.
6.3. Interpreter Fundamental Properties 6.3. Interpreter Fundamental Properties
The interpreter has a small set of design goals: The interpreter has a small set of design goals:
1. Executing an update MUST either result in an error, or a 1. Executing an update MUST either result in an error, or a
verifiably correct system state. verifiably correct system state.
2. Executing a secure boot MUST either result in an error, or a 2. Executing a secure boot MUST either result in an error, or a
booted system. booted system.
3. Executing the same manifest on multiple devices MUST result in 3. Executing the same manifest on multiple Recipients MUST result in
the same system state. the same system state.
NOTE: when using A/B images, the manifest functions as two (or more) NOTE: when using A/B images, the manifest functions as two (or more)
logical manifests, each of which applies to a system in a particular logical manifests, each of which applies to a system in a particular
starting state. With that provision, design goal 3 holds. starting state. With that provision, design goal 3 holds.
6.4. Abstract Machine Description 6.4. Abstract Machine Description
The heart of the manifest is the list of commands, which are The heart of the manifest is the list of commands, which are
processed by an interpreter. This interpreter can be modeled as a processed by an interpreter. This interpreter can be modeled as a
simple abstract machine. This machine consists of several data simple abstract machine. This machine consists of several data
storage locations that are modified by commands. storage locations that are modified by commands.
There are two types of commands, namely those that modify state There are two types of commands, namely those that modify state
(directives) and those that perform tests (conditions). Parameters (directives) and those that perform tests (conditions). Parameters
are used as the inputs to commands. Some directives offer control are used as the inputs to commands. Some directives offer control
flow operations. Directives target a specific component. A flow operations. Directives target a specific component or
component is a unit of code or data that can be targeted by an dependency. A dependency is another SUIT_Envelope that describes
update. Components are identified by a Component Index, i.e. arrays additional components. Dependencies are identified by digest, but
of binary strings. referenced in commands by Dependency Index, the index into the array
of Dependencies. A component is a unit of code or data that can be
targeted by an update. Components are identified by Component
Identifiers, i.e. arrays of binary strings, but referenced in
commands by Component Index, the index into the array of Component
Identifiers.
Conditions MUST NOT have any side-effects other than informing the
interpreter of success or failure. The Interpreter does not Abort if
the Soft Failure flag is set when a Condition reports failure.
Directives MAY have side-effects in the parameter table, the
interpreter state, or the current component. The Interpreter MUST
Abort if a Directive reports failure regardless of the Soft Failure
flag.
The following table describes the behavior of each command. "params" The following table describes the behavior of each command. "params"
represents the parameters for the current component or dependency. represents the parameters for the current component or dependency.
Most commands operate on either a component or a dependency. Setting
the Component Index clears the Dependency Index. Setting the
Dependency Index clears the Component Index.
+--------------------+----------------------------------------------+ +-------------------+-----------------------------------------------+
| Command Name | Semantic of the Operation | | Command Name | Semantic of the Operation |
+--------------------+----------------------------------------------+ +-------------------+-----------------------------------------------+
| Check Vendor | binary-match(component, params[vendor-id]) | | Check Vendor | assert(binary-match(current, |
| Identifier | | | Identifier | current.params[vendor-id])) |
| | | | | |
| Check Class | binary-match(component, params[class-id]) | | Check Class | assert(binary-match(current, |
| Identifier | | | Identifier | current.params[class-id])) |
| | | | | |
| Verify Image | binary-match(digest(component), | | Verify Image | assert(binary-match(digest(current), |
| | params[digest]) | | | current.params[digest])) |
| | | | | |
| Set Component | component := components[arg] | | Set Component | current := components[arg] |
| Index | | | Index | |
| | | | | |
| Override | params[k] := v for k,v in arg | | Override | current.params[k] := v for k,v in arg |
| Parameters | | | Parameters | |
| | | | | |
| Set Dependency | dependency := dependencies[arg] | | Set Dependency | current := dependencies[arg] |
| Index | | | Index | |
| | | | | |
| Set Parameters | params[k] := v if not k in params for k,v in | | Set Parameters | current.params[k] := v if not k in params for |
| | arg | | | k,v in arg |
| | | | | |
| Process Dependency | exec(dependency[common]); exec(dependency | | Process | exec(current[common]); exec(current[current- |
| | [current-segment]) | | Dependency | segment]) |
| | | | | |
| Run | run(component) | | Run | run(current) |
| | | | | |
| Fetch | store(component, fetch(params[uri])) | | Fetch | store(current, fetch(current.params[uri])) |
| | | | | |
| Use Before | assert(now() < arg) | | Use Before | assert(now() < arg) |
| | | | | |
| Check Component | assert(offsetof(component) == arg) | | Check Component | assert(offsetof(current) == arg) |
| Offset | | | Offset | |
| | | | | |
| Check Device | binary-match(component, params[device-id]) | | Check Device | assert(binary-match(current, |
| Identifier | | | Identifier | current.params[device-id])) |
| | | | | |
| Check Image Not | not binary-match(digest(component), | | Check Image Not | assert(not binary-match(digest(current), |
| Match | params[digest]) | | Match | current.params[digest])) |
| | | | | |
| Check Minimum | assert(battery >= arg) | | Check Minimum | assert(battery >= arg) |
| Battery | | | Battery | |
| | | | | |
| Check Update | assert(isAuthorized()) | | Check Update | assert(isAuthorized()) |
| Authorized | | | Authorized | |
| | | | | |
| Check Version | assert(version_check(component, arg)) | | Check Version | assert(version_check(current, arg)) |
| | | | | |
| Abort | assert(0) | | Abort | assert(0) |
| | | | | |
| Try Each | break if exec(seq) is not error for seq in | | Try Each | break if exec(seq) is not error for-each seq |
| | arg | | | in arg |
| | | | | |
| Copy | store(component, params[src-component]) | | Copy | store(current, current.params[src-component]) |
| | | | | |
| Swap | swap(component, params[src-component]) | | Swap | swap(current, current.params[src-component]) |
| | | | | |
| Wait For Event | until event(arg), wait | | Wait For Event | until event(arg), wait |
| | | | | |
| Run Sequence | exec(arg) | | Run Sequence | exec(arg) |
| | | | | |
| Run with Arguments | run(component, arg) | | Run with | run(current, arg) |
+--------------------+----------------------------------------------+ | Arguments | |
+-------------------+-----------------------------------------------+
6.5. Serialized Processing Interpreter 6.5. Serialized Processing Interpreter
Because each manifest has a list of components and a list of In highly constrained devices, where storage for parameters is
components defined by its dependencies, it is possible for the limited, the manifest processor MAY handle one component at a time,
manifest processor to handle one component at a time, traversing the traversing the manifest tree once for each listed component. In this
manifest tree once for each listed component. In this mode, the mode, the interpreter ignores any commands executed while the
interpreter ignores any commands executed while the component index component index is not the current component. This reduces the
is not the current component. This reduces the overall volatile overall volatile storage required to process the update so that the
storage required to process the update so that the only limit on only limit on number of components is the size of the manifest.
number of components is the size of the manifest. However, this However, this approach requires additional processing power.
approach requires additional processing power.
In order to operate in this mode, the manifest processor loops on
each section for every supported component, simply ignoring commands
when the current component is not selected.
6.6. Parallel Processing Interpreter 6.6. Parallel Processing Interpreter
Advanced devices may make use of the Strict Order parameter and Advanced Recipients MAY make use of the Strict Order parameter and
enable parallel processing of some segments, or it may reorder some enable parallel processing of some Command Sequences, or it may
segments. To perform parallel processing, once the Strict Order reorder some Command Sequences. To perform parallel processing, once
parameter is set to False, the device may fork a process for each the Strict Order parameter is set to False, the Recipient may fork a
command until the Strict Order parameter is returned to True or the process for each command until the Strict Order parameter is returned
command sequence ends. Then, it joins all forked processes before to True or the Command Sequence ends. Then, it joins all forked
continuing processing of commands. To perform out-of-order processes before continuing processing of commands. To perform out-
processing, a similar approach is used, except the device consumes of-order processing, a similar approach is used, except the Recipient
all commands after the Strict Order parameter is set to False, then consumes all commands after the Strict Order parameter is set to
it sorts these commands into its preferred order, invokes them all, False, then it sorts these commands into its preferred order, invokes
then continues processing. them all, then continues processing.
Under each of these scenarios the parallel processing must halt: Under each of these scenarios the parallel processing must halt:
- Set Parameters. - Set Parameters.
- Override Parameters. - Override Parameters.
- Set Strict Order = True. - Set Strict Order = True.
- Set Dependency Index. - Set Dependency Index.
- Set Component Index. - Set Component Index.
To perform more useful parallel operations, sequences of commands may To perform more useful parallel operations, sequences of commands may
be collected in a suit-directive-run-sequence. Then, each of these be collected in a suit-directive-run-sequence. Then, each of these
sequences may be run in parallel. Each sequence defaults to Strict sequences may be run in parallel. Each sequence defaults to Strict
Order = True. To isolate each sequence from each other sequence, Order = True. To isolate each sequence from each other sequence,
each sequence must declare a single target component. Set Component each sequence MUST begin with a Set Component Index directive. The
Index is not permitted inside this sequence. interpreter MUST track each Set Component Index directive, and cause
an Abort if more than one Set Component Index directive targets the
same Component Index. When Strict Order = False, each suit-
directive-run-sequence MUST begin with a Set Component Index
directive. Any further Set Component Index directives MUST cause an
Abort. This allows the interpreter that forks suit-directive-run-
sequence processes to check that the first element is correct, then
fork a process to handle the remainder of the sequence.
6.7. Processing Dependencies 6.7. Processing Dependencies
As described in Section 6.2, each manifest must invoke each of its As described in Section 6.2, each manifest must invoke each of its
dependencies sections from the corresponding section of the dependencies sections from the corresponding section of the
dependent. Any changes made to parameters by the dependency persist dependent. Any changes made to parameters by the dependency persist
in the dependent. in the dependent.
When a Process Dependency command is encountered, the interpreter When a Process Dependency command is encountered, the interpreter
loads the dependency identified by the Current Dependency Index. The loads the dependency identified by the Current Dependency Index. The
interpreter first executes the common-sequence section of the interpreter first executes the common-sequence section of the
identified dependency, then it executes the section of the dependency identified dependency, then it executes the section of the dependency
that corresponds to the currently executing section of the dependent. that corresponds to the currently executing section of the dependent.
The interpreter also performs the checks described in Section 6.2 to The interpreter also performs the checks described in Section 6.2 to
ensure that the dependent is processing the dependency correctly. ensure that the dependent is processing the dependency correctly.
6.8. Multiple Manifest Processors
When a system has multiple security domains they MAY require
independent verification of authenticity or security policies.
Security domains may be divided by separation technology such as Arm
TrustZone, or Intel SGX. Security domains may also be divided into
separate processors and memory spaces, with a communication interface
between them.
For example, an application processor may have an attached
communications module that contains a processor. The communications
module may require metadata signed by a specific Trust Authority for
regulatory approval. This may be a different Trust Authority than
the application processor.
When there are two or more security domains, a manifest processor MAY
be required in each. The first manifest processor is the normal
manifest processor as described for the Recipient in Abstract
Machine. The second manifest processor only executes sections when
the first manifest processor requests it. An API interface is
provided from the second manifest processor to the first. This
allows the first manifest processor to request a limited set of
operations from the second. These operations are limited to: setting
parameters, inserting an Envelope, invoking a Manifest Command
Sequence. The second manifest processor declares a prefix to the
first, which tells the first manifest processor when it should
delegate to the second. These rules are enforced by underlying
separation of privilege infrastructure, such as TEEs, or physical
separation.
When the first manifest processor encounters a dependency prefix,
that informs the first manifest processor that it should provide the
second manifest processor with the corresponding dependency Envelope.
This is done when the dependency is fetched. The second manifest
processor immediately verifies any authentication information in the
dependency Envelope. When a parameter is set for any component that
matches the prefix, this parameter setting is passed to the second
manifest processor via an API. As the first manifest processor works
through the Procedure (set of command sequences) it is executing,
each time it sees a Process Dependency command that is associated
with the prefix declared by the second manifest processor, it uses
the API to ask the second manifest processor to invoke that
dependency section instead.
7. Creating Manifests 7. Creating Manifests
Manifests are created using tools for constructing COSE structures, Manifests are created using tools for constructing COSE structures,
calculating cryptographic values and compiling desired system state calculating cryptographic values and compiling desired system state
into a sequence of operations required to achieve that state. The into a sequence of operations required to achieve that state. The
process of constructing COSE structures and the calculation of process of constructing COSE structures and the calculation of
cryptographic values is covered in [RFC8152]. cryptographic values is covered in [RFC8152].
Compiling desired system state into a sequence of operations can be Compiling desired system state into a sequence of operations can be
accomplished in many ways. Several templates are provided below to accomplished in many ways. Several templates are provided below to
cover common use-cases. These templates can be combined to produce cover common use-cases. These templates can be combined to produce
more complex behavior. more complex behavior.
NOTE: On systems that support only a single component, Set Current NOTE: On systems that support only a single component, Set Current
Component has no effect and can be omitted. Component has no effect and can be omitted.
NOTE: A digest should always be set using Override Parameters, since NOTE: *A digest MUST always be set using Override Parameters, since
this prevents a less-privileged dependent from replacing the digest. this prevents a less-privileged dependent from replacing the digest.*
7.1. Compatibility Check Template 7.1. Compatibility Check Template
The compatibility check ensures that devices only install compatible The compatibility check ensures that Recipients only install
images. In this template all information is contained in the common compatible images. In this template all information is contained in
block and the following sequence of operations are used: the common block and the following sequence of operations are used:
- Set Component Index directive (see Section 9.8.4.1) - Set Component Index directive (see Section 8.7.7.1)
- Set Parameters directive (see Section 9.8.4.6) for Vendor ID and - Set Parameters directive (see Section 8.7.7.6) for Vendor ID and
Class ID (see Section 9.8.2) Class ID (see Section 8.7.5)
- Check Vendor Identifier condition (see Section 9.8.3.1) - Check Vendor Identifier condition (see Section 8.7.5.1)
- Check Class Identifier condication (see Section 9.8.3.1) - Check Class Identifier condication (see Section 8.7.5.1)
7.2. Secure Boot Template 7.2. Secure Boot Template
This template performs a secure boot operation. This template performs a secure boot operation.
The following operations are placed into the common block: The following operations are placed into the common block:
- Set Component Index directive (see Section 9.8.4.1) - Set Component Index directive (see Section 8.7.7.1)
- Override Parameters directive (see Section 9.8.4.7) for Image - Override Parameters directive (see Section 8.7.7.7) for Image
Digest and Image Size (see Section 9.8.2) Digest and Image Size (see Section 8.7.5)
Then, the run block contains the following operations: Then, the run block contains the following operations:
- Set Component Index directive (see Section 9.8.4.1) - Set Component Index directive (see Section 8.7.7.1)
- Check Image Match condition (see Section 9.8.3.2) - Check Image Match condition (see Section 8.7.6.2)
- Run directive (see Section 9.8.4.12) - Run directive (see Section 8.7.7.13)
According to Section 6.4, the Run directive applies to the component According to Section 6.4, the Run directive applies to the component
referenced by the current Component Index. Hence, the Set Component referenced by the current Component Index. Hence, the Set Component
Index directive has to be used to target a specific component. Index directive has to be used to target a specific component.
7.3. Firmware Download Template 7.3. Firmware Download Template
This template triggers the download of firmware. This template triggers the download of firmware.
The following operations are placed into the common block: The following operations are placed into the common block:
- Set Component Index directive (see Section 9.8.4.1) - Set Component Index directive (see Section 8.7.7.1)
- Override Parameters directive (see Section 9.8.4.7) for Image - Override Parameters directive (see Section 8.7.7.7) for Image
Digest and Image Size (see Section 9.8.2) Digest and Image Size (see Section 8.7.5)
Then, the install block contains the following operations: Then, the install block contains the following operations:
- Set Component Index directive (see Section 9.8.4.1) - Set Component Index directive (see Section 8.7.7.1)
- Set Parameters directive (see Section 9.8.4.6) for URI (see - Set Parameters directive (see Section 8.7.7.6) for URI (see
Section 9.8.2) Section 8.7.5.12)
- Fetch directive (see Section 9.8.4.8) - Fetch directive (see Section 8.7.7.8)
- Check Image Match condition (see Section 8.7.6.2)
The Fetch directive needs the URI parameter to be set to determine The Fetch directive needs the URI parameter to be set to determine
where the image is retrieved from. Additionally, the destination of where the image is retrieved from. Additionally, the destination of
where the component shall be stored has to be configured. The URI is where the component shall be stored has to be configured. The URI is
configured via the Set Parameters directive while the destination is configured via the Set Parameters directive while the destination is
configured via the Set Component Index directive. configured via the Set Component Index directive.
7.4. Load from External Storage Template 7.4. Install Template
This template modifies the Firmware Download template and adds an
additional sequence. The Firmware Download operations are moved from
the Payload Install sequence to the Payload Fetch sequence.
Then, the Install sequence contains the following operations:
- Set Component Index directive (see Section 8.7.7.1)
- Set Parameters directive (see Section 8.7.7.6) for Source
Component (see Section 8.7.5.13)
- Copy directive (see Section 8.7.7.10)
- Check Image Match condition (see Section 8.7.6.2)
7.5. Integrated Payload Template
This template triggers the installation of a payload included in the
manifest envelope. It is identical to Section 7.3 except that it
places an added restriction on the URI passed to the Set Parameters
directive.
An implementor MAY choose to place a payload in the envelope of a
manifest. The payload envelope key MAY be a positive or negative
integer. The payload envelope key MUST NOT be a value between 0 and
24 and it MUST NOT be used by any other envelope element in the
manifest. The payload MUST be serialized in a bstr element.
The URI for a payload enclosed in this way MUST be expressed as a
fragment-only reference, as defined in [RFC3986], Section 4.4. The
fragment identifier is the stringified envelope key of the payload.
For example, an envelope that contains a payload a key 42 would use a
URI "#42", key -73 would use a URI "#-73".
7.6. Load from Nonvolatile Storage Template
This directive loads an firmware image from external storage. This directive loads an firmware image from external storage.
The following operations are placed into the load block: The following operations are placed into the load block:
- Set Component Index directive (see Section 9.8.4.1) - Set Component Index directive (see Section 8.7.7.1)
- Set Parameters directive (see Section 9.8.4.6) for Component Index - Set Parameters directive (see Section 8.7.7.6) for Component Index
(see Section 9.8.2) (see Section 8.7.5)
- Copy directive (see Section 9.8.4.9) - Copy directive (see Section 8.7.7.10)
As outlined in Section 6.4, the Copy directive needs a source and a As outlined in Section 6.4, the Copy directive needs a source and a
destination to be configured. The source is configured via Component destination to be configured. The source is configured via Component
Index (with the Set Parameters directive) and the destination is Index (with the Set Parameters directive) and the destination is
configured via the Set Component Index directive. configured via the Set Component Index directive.
7.5. Load & Decompress from External Storage Template 7.7. Load & Decompress from Nonvolatile Storage Template
The following operations are placed into the load block: The following operations are placed into the load block:
- Set Component Index directive (see Section 9.8.4.1) - Set Component Index directive (see Section 8.7.7.1)
- Set Parameters directive (see Section 9.8.4.6) for Component Index
and Compression Info (see Section 9.8.2)
- Copy directive (see Section 9.8.4.9) - Set Parameters directive (see Section 8.7.7.6) for Source
Component Index and Compression Info (see Section 8.7.5)
This example is similar to the previous case but additionally - Copy directive (see Section 8.7.7.10)
performs decompression. Hence, the only difference is in setting the This template is similar to Section 7.6 but additionally performs
decompression. Hence, the only difference is in setting the
Compression Info parameter. Compression Info parameter.
7.6. Dependency Template 7.8. Dependency Template
The following operations are placed into the dependency resolution The following operations are placed into the dependency resolution
block: block:
- Set Dependency Index directive (see Section 9.8.4.2) - Set Dependency Index directive (see Section 8.7.7.2)
- Set Parameters directive (see Section 9.8.4.6) for URI (see - Set Parameters directive (see Section 8.7.7.6) for URI (see
Section 9.8.2) Section 8.7.5)
- Fetch directive (see Section 9.8.4.8) - Fetch directive (see Section 8.7.7.8)
- Check Image Match condition (see Section 9.8.3.2) - Check Image Match condition (see Section 8.7.6.2)
- Process Dependency directive (see Section 9.8.4.5) - Process Dependency directive (see Section 8.7.7.5)
Then, the validate block contains the following operations: Then, the validate block contains the following operations:
- Set Dependency Index directive (see Section 9.8.4.2) - Set Dependency Index directive (see Section 8.7.7.2)
- Check Image Match condition (see Section 9.8.3.2) - Check Image Match condition (see Section 8.7.6.2)
- Process Dependency directive (see Section 9.8.4.5) - Process Dependency directive (see Section 8.7.7.5)
NOTE: Any changes made to parameters in a dependency persist in the NOTE: Any changes made to parameters in a dependency persist in the
dependent. dependent.
8. Envelope 7.8.1. Composite Manifests
The diagram below shows high-level structure of the SUIT manifest An implementor MAY choose to place a dependency's envelope in the
embedded in the envelope, the top-level structure. envelope of its dependent. The dependent envelope key for the
dependency envelope MUST NOT be a value between 0 and 24 and it MUST
NOT be used by any other envelope element in the dependent manifest.
+------------------------+ The URI for a dependency enclosed in this way MUST be expressed as a
| Envelope | fragment-only reference, as defined in [RFC3986], Section 4.4. The
+------------------------+ fragment identifier is the stringified envelope key of the
| Delegation Info | dependency. For example, an envelope that contains a dependency at
| Authentication Wrapper | key 42 would use a URI "#42", key -73 would use a URI "#-73".
| Plaintext or -+---------> +----------------------------+
| Encrypted Manifest-+ | | Manifest |
| Severable Fields | +----------------------------+
| Human-Readable Text | | Version |
| COSWID | | Sequence Number |
+------------------------+ +----- Common Structure |
| +--- Commands |
| | | Digest of Enveloped Fields |
+-----------------------+ | | | Reference to Full Manifest |
| Common Structure | <-+ | +----------------------------+
+-----------------------+ |
| Dependencies | +->+-----------------------+
| Components IDs | +->| Commands |
| Component References | | +-----------------------+
| Common Commands ------------+ | List of ( pairs of ( |
+-----------------------+ | * command code |
| * argument |
| )) |
+-----------------------
8.1. Authenticated Manifests 7.9. Encrypted Manifest Template
The suit-authentication-wrapper contains a list of 1 or more To use an encrypted manifest, create a plaintext dependent, and add
cryptographic authentication wrappers for the core part of the the encrypted manifest as a dependency. The dependent can include
manifest. These are implemented as COSE_Mac_Tagged or very little information.
COSE_Sign_Tagged blocks. Each of these blocks contains a SUIT_Digest
of the manifest. This enables modular processing of the manifest.
The COSE_Mac_Tagged and COSE_Sign_Tagged blocks are described in RFC
8152 [RFC8152]. The suit-authentication-wrapper MUST come before any
element in the SUIT_Envelope, except for the OPTIONAL suit-
delegation, regardless of canonical encoding of CBOR. All validators
MUST reject any SUIT_Envelope that begins with any element other than
a suit-authentication-wrapper or suit-delegation.
A SUIT_Envelope that has not had authentication information added The following operations are placed into the dependency resolution
MUST still contain the suit-authentication-wrapper element, but the block:
content MUST be nil.
For manifests that are only authenticated the envelope MUST contain - Set Dependency Index directive (see Section 8.7.7.2)
the plaintext manifest in SUIT_Manifest structure.
8.2. Encrypted Manifests - Set Parameters directive (see Section 8.7.7.6) for
For encrypted manifest both a SUIT_Encryption_Wrapper and the o URI (see Section 8.7.5)
ciphertext of a manifest is included in the envelope.
When the envelope contains the SUIT_Encryption_Wrapper, the suit- o Encryption Info (see Section 8.7.5)
authentication-wrapper MUST authenticate the plaintext of suit-
manifest-encrypted. This ensures that the manifest can be stored
decrypted and that a recipient MAY convert the suit-manifest-
encrypted element to a suit-manifest element.
The SUIT_Manifest structure describes the payload(s) to be installed - Fetch directive (see Section 8.7.7.8)
and any dependencies on other manifests.
The suit-manifest-encryption-info structure contains information - Check Image Match condition (see Section 8.7.6.2)
required to decrypt a ciphertext manifest and the suit-manifest-
encrypted structure contains the ciphertext.
8.3. Delegation Info - Process Dependency directive (see Section 8.7.7.5)
The suit-delegation field may carry one or multiple CBOR Web Tokens Then, the validate block contains the following operations:
(CWTs) [RFC8392]. They can be used to perform enhanced authorization
decisions.
8.4. Severable Fields - Set Dependency Index directive (see Section 8.7.7.2)
Each of suit-dependency-resolution, suit-payload-fetch, and suit- - Check Image Match condition (see Section 8.7.6.2)
payload-installation contain the severable contents of the
identically named portions of the manifest, described in Section 9.
8.5. Human-Readable Text - Process Dependency directive (see Section 8.7.7.5)
suit-text contains all the human-readable information that describes A plaintext manifest and its encrypted dependency may also form a
any and all parts of the manifest, its payload(s) and its composite manifest (Section 7.8.1).
resource(s). The text section is typically severable, allowing
manifests to be distributed without the text, since end-nodes do not
require text. The meaning of each field is described below.
Each section MAY be present. If present, each section MUST be as 7.10. A/B Image Template
described. Negative integer IDs are reserved for application-
specific text values.
+---------------------------------+---------------------------------+ The following operations are placed in the common block:
| CDDL Structure | Description |
+---------------------------------+---------------------------------+
| suit-text-manifest-description | Free text description of the |
| | manifest |
| | |
| suit-text-update-description | Free text description of the |
| | update |
| | |
| suit-text-vendor-name | Free text vendor name |
| | |
| suit-text-model-name | Free text model name |
| | |
| suit-text-vendor-domain | The domain used to create the |
| | vendor-id condition |
| | |
| suit-text-model-info | The information used to create |
| | the class-id condition |
| | |
| suit-text-component-description | Free text description of each |
| | component in the manifest |
| | |
| suit-text-manifest-json-source | The JSON-formatted document |
| | that was used to create the |
| | manifest |
| | |
| suit-text-manifest-yaml-source | The yaml-formatted document |
| | that was used to create the |
| | manifest |
| | |
| suit-text-version-dependencies | List of component versions |
| | required by the manifest |
+---------------------------------+---------------------------------+
8.6. COSWID - Set Component Index directive (see Section 8.7.7.1)
suit-coswid contains a Concise Software Identifier. This may be - Try Each
discarded by the Recipient, if not needed.
8.7. Encoding Considerations o First Sequence:
* Override Parameters directive (see Section 8.7.7.7,
Section 8.7.5) for Offset A
* Check Offset Condition (see Section 8.7.6.5)
* Override Parameters directive (see Section 8.7.7.7) for
Image Digest A and Image Size A (see Section 8.7.5)
o Second Sequence:
* Override Parameters directive (see Section 8.7.7.7,
Section 8.7.5) for Offset B
* Check Offset Condition (see Section 8.7.6.5)
* Override Parameters directive (see Section 8.7.7.7) for
Image Digest B and Image Size B (see Section 8.7.5)
The following operations are placed in the fetch block or install
block
- Set Component Index directive (see Section 8.7.7.1)
- Try Each
o First Sequence:
* Override Parameters directive (see Section 8.7.7.7,
Section 8.7.5) for Offset A
* Check Offset Condition (see Section 8.7.6.5)
* Set Parameters directive (see Section 8.7.7.7) for URI A
(see Section 8.7.5)
o Second Sequence:
* Override Parameters directive (see Section 8.7.7.7,
Section 8.7.5) for Offset B
* Check Offset Condition (see Section 8.7.6.5)
* Set Parameters directive (see Section 8.7.7.7) for URI B
(see Section 8.7.5)
- Fetch
8. Metadata Structure
The metadata for SUIT updates is composed of several primary
constituent parts: the Envelope, Delegation Chains, Authentication
Information, Manifest, and Severable Elements.
For a diagram of the metadata structure, see Section 5.
8.1. Encoding Considerations
The map indices in the envelope encoding are reset to 1 for each map The map indices in the envelope encoding are reset to 1 for each map
within the structure. This is to keep the indices as small as within the structure. This is to keep the indices as small as
possible. The goal is to keep the index objects to single bytes possible. The goal is to keep the index objects to single bytes
(CBOR positive integers 1-23). (CBOR positive integers 1-23).
Wherever enumerations are used, they are started at 1. This allows Wherever enumerations are used, they are started at 1. This allows
detection of several common software errors that are caused by detection of several common software errors that are caused by
uninitialised variables. Positive numbers in enumerations are uninitialised variables. Positive numbers in enumerations are
reserved for IANA registration. Negative numbers are used to reserved for IANA registration. Negative numbers are used to
identify application-specific implementations. identify application-specific implementations.
All elements of the envelope must be wrapped in a bstr to minimize All elements of the envelope must be wrapped in a bstr to minimize
the complexity of the code that evaluates the cryptographic integrity the complexity of the code that evaluates the cryptographic integrity
of the element and to ensure correct serialization for integrity and of the element and to ensure correct serialization for integrity and
authenticity checks. authenticity checks.
9. Manifest 8.2. Envelope
The Envelope contains each of the other primary constituent parts of
the SUIT metadata. It allows for modular processing of the manifest
by ordering components in the expected order of processing.
The Envelope is encoded as a CBOR Map. Each element of the Envelope
is enclosed in a bstr, which allows computation of a message digest
against known bounds.
8.3. Delegation Chains
The suit-delegation field MAY carry one or more CBOR Web Tokens
(CWTs) [RFC8392], with [RFC8747] cnf claims. They can be used to
perform enhanced authorization decisions. The CWTs are arranged into
a list of lists. Each list starts with CWT authorized by a Trust
Anchor, and finishes with a key used to authenticate the Manifest
(see Section 8.4). This allows an Update Authority to delegate from
a long term Trust Anchor, down through intermediaries, to a delegate
without any out-of-band updates Trust Anchors.
A Recipient MAY choose to cache intermediaries and/or delegates. If
an Update Distributor knows that a targeted Recipient has cached some
intermediaries or delegates, it MAY choose to strip any cached
intermediaries or delegates from the Delegation Chains in order to
reduce bandwidth and energy.
8.4. Authenticated Manifests
The suit-authentication-wrapper contains a list of one or more
cryptographic authentication wrappers for the Manifest. These are
implemented as COSE_Mac_Tagged or COSE_Sign_Tagged blocks. Each of
these blocks contains a SUIT_Digest of the Manifest. This enables
modular processing of the manifest. The COSE_Mac_Tagged and
COSE_Sign_Tagged blocks are described in RFC 8152 [RFC8152]. The
suit-authentication-wrapper MUST come before any element in the
SUIT_Envelope, except for the OPTIONAL suit-delegation, regardless of
canonical encoding of CBOR. All validators MUST reject any
SUIT_Envelope that begins with any element other than a suit-
authentication-wrapper or suit-delegation.
A SUIT_Envelope that has not had authentication information added
MUST still contain the suit-authentication-wrapper element, but the
content MUST be an empty list.
8.5. Encrypted Manifests
To use an encrypted manifest, it must be a dependency of a plaintext
manifest. This allows fine-grained control of what information is
accessible to intermediate systems for the purposes of management,
while still preserving the confidentiality of the manifest contents.
This also means that a Recipient can process an encrypted manifest in
the same way as an encrypted payload, allowing code reuse.
A template for using an encrypted manifest is covered in Encrypted
Manifest Template (Section 7.9).
8.6. Manifest
The manifest contains: The manifest contains:
- a version number (see Section 9.1) - a version number (see Section 8.6.1)
- a sequence number (see Section 9.2) - a sequence number (see Section 8.6.2)
- a common structure with information that is shared between command - a reference URI (see Section 8.6.3)
sequences (see Section 9.8.1)
- a list of commands that the Recipient should perform (see - a common structure with information that is shared between command
Section 9.8) sequences (see Section 8.7.2)
- a reference to the full manifest (see Section 9.3) - one or more lists of commands that the Recipient should perform
(see Section 8.7.3)
- a digest of human-readable text describing the manifest found in - a reference to the full manifest (see Section 8.6.3)
the SUIT_Envelope (see Section 9.4) - human-readable text describing the manifest found in the
SUIT_Envelope (see Section 8.6.4)
- a digest of the Concise Software Identifier found in the - a Concise Software Identifier found in the SUIT_Envelope (see
SUIT_Envelope (see Section 9.5) Section 8.7.1)
Several fields in the Manifest can be either a CBOR structure or a The CoSWID, Text section, or any Command Sequence of the Update
SUIT_Digest. In each of these cases, the SUIT_Digest provides for a Procedure (Dependency Resolution, Image Fetch, Image Installation)
severable field. Severable fields are RECOMMENDED to implement. In can be either a CBOR structure or a SUIT_Digest. In each of these
particular, the human-readable text SHOULD be severable, since most cases, the SUIT_Digest provides for a severable field. Severable
useful text elements occupy more space than a SUIT_Digest, but are fields are RECOMMENDED to implement. In particular, the human-
not needed by the Recipient. Because SUIT_Digest is a CBOR Array and readable text SHOULD be severable, since most useful text elements
each severable element is a CBOR bstr, it is straight-forward for a occupy more space than a SUIT_Digest, but are not needed by the
Recipient to determine whether an element has been severed. The key Recipient. Because SUIT_Digest is a CBOR Array and each severable
used for a severable element is the same in the SUIT_Manifest and in element is a CBOR bstr, it is straight-forward for a Recipient to
the SUIT_Envelope so that a Recipient can easily identify the correct determine whether an element has been severed. The key used for a
data in the envelope. severable element is the same in the SUIT_Manifest and in the
SUIT_Envelope so that a Recipient can easily identify the correct
data in the envelope. See Section 8.7.8 for more detail.
9.1. suit-manifest-version 8.6.1. suit-manifest-version
The suit-manifest-version indicates the version of serialization used The suit-manifest-version indicates the version of serialization used
to encode the manifest. Version 1 is the version described in this to encode the manifest. Version 1 is the version described in this
document. suit-manifest-version is REQUIRED to implement. document. suit-manifest-version is REQUIRED to implement.
9.2. suit-manifest-sequence-number 8.6.2. suit-manifest-sequence-number
The suit-manifest-sequence-number is a monotonically increasing anti- The suit-manifest-sequence-number is a monotonically increasing anti-
rollback counter. It also helps devices to determine which in a set rollback counter. It also helps Recipients to determine which in a
of manifests is the "root" manifest in a given update. Each manifest set of manifests is the "root" manifest in a given update. Each
MUST have a sequence number higher than each of its dependencies. manifest MUST have a sequence number higher than each of its
Each Recipient MUST reject any manifest that has a sequence number dependencies. Each Recipient MUST reject any manifest that has a
lower than its current sequence number. It MAY be convenient to use sequence number lower than its current sequence number. It MAY be
a UTC timestamp in seconds as the sequence number. suit-manifest- convenient to use a UTC timestamp in seconds as the sequence number.
sequence-number is REQUIRED to implement. suit-manifest-sequence-number is REQUIRED to implement.
9.3. suit-reference-uri 8.6.3. suit-reference-uri
suit-reference-uri is a text string that encodes a URI where a full suit-reference-uri is a text string that encodes a URI where a full
version of this manifest can be found. This is convenient for version of this manifest can be found. This is convenient for
allowing management systems to show the severed elements of a allowing management systems to show the severed elements of a
manifest when this URI is reported by a device after installation. manifest when this URI is reported by a Recipient after installation.
9.4. suit-text 8.6.4. suit-text
suit-text is a digest that uniquely identifies the content of the suit-text SHOULD be a severable element. suit-text is a map of pairs.
Text that is packaged in the SUIT_Envelope. suit-text is OPTIONAL to It MAY contain two different types of pair:
implement.
9.5. suit-coswid - integer => text mappings
- SUIT_Component_Identifier => map mappings
Each SUIT_Component_Identifier => map entry contains a map of integer
=> text values. All SUIT_Component_Identifiers present in suit-text
MUST also be present in suit-common (Section 8.7.2) or the suit-
common of a dependency.
suit-text contains all the human-readable information that describes
any and all parts of the manifest, its payload(s) and its
resource(s). The text section is typically severable, allowing
manifests to be distributed without the text, since end-nodes do not
require text. The meaning of each field is described below.
Each section MAY be present. If present, each section MUST be as
described. Negative integer IDs are reserved for application-
specific text values.
The following table describes the text fields available in suit-text:
+--------------------------------+----------------------------------+
| CDDL Structure | Description |
+--------------------------------+----------------------------------+
| suit-text-manifest-description | Free text description of the |
| | manifest |
| | |
| suit-text-update-description | Free text description of the |
| | update |
| | |
| suit-text-manifest-json-source | The JSON-formatted document that |
| | was used to create the manifest |
| | |
| suit-text-manifest-yaml-source | The yaml-formatted document that |
| | was used to create the manifest |
+--------------------------------+----------------------------------+
The following table describes the text fields available in each map
identified by a SUIT_Component_Identifier.
+---------------------------------+---------------------------------+
| CDDL Structure | Description |
+---------------------------------+---------------------------------+
| suit-text-vendor-name | Free text vendor name |
| | |
| suit-text-model-name | Free text model name |
| | |
| suit-text-vendor-domain | The domain used to create the |
| | vendor-id condition |
| | |
| suit-text-model-info | The information used to create |
| | the class-id condition |
| | |
| suit-text-component-description | Free text description of each |
| | component in the manifest |
| | |
| suit-text-component-version | A text version number |
| | |
| suit-text-version-required | A text expression of the |
| | required version number |
+---------------------------------+---------------------------------+
suit-text is OPTIONAL to implement.
8.7. text-version-required
suit-text-version-required is used to represent a version-based
dependency on suit-parameter-version as described in Section 8.7.5.17
and Section 8.7.6.8. To describe a version dependency, a Manifest
Author should populate the suit-text map with a
SUIT_Component_Identifier key for the dependency component, and place
in the corresponding map a suit-text-version-required key with a text
expression that is representative of the version constraints placed
on the dependency.
For example, to express a dependency on a component "['x', 'y']",
where the version should be any v1.x later than v1.2.5, but not v2.0
or above, the author would add the following structure to the suit-
text element. Note that this text is in cbor-diag notation.
" [h'78',h'79'] : { 7 : ">=1.2.5,<2" } "
8.7.1. suit-coswid
suit-coswid contains a Concise Software Identifier. This element
SHOULD be made severable so that it can be discarded by the Recipient
or an intermediary if it is not required by the Recipient.
suit-coswid is a digest that uniquely identifies the content of the
concise-software-identifier that is packaged in the SUIT_Envelope.
suit-coswid is OPTIONAL to implement. suit-coswid is OPTIONAL to implement.
9.6. Dependencies 8.7.2. suit-common
suit-common encodes all the information that is shared between each
of the command sequences, including: suit-dependencies, suit-
components, and suit-common-sequence. suit-common is REQUIRED to
implement.
suit-dependencies is a list of Section 8.7.2.1 blocks that specify
manifests that must be present before the current manifest can be
processed. suit-dependencies is OPTIONAL to implement.
suit-components is a list of SUIT_Component_Identifier
(Section 8.7.2.2) blocks that specify the component identifiers that
will be affected by the content of the current manifest. suit-
components is REQUIRED to implement; at least one manifest in a
dependency tree MUST contain a suit-components block.
suit-common-sequence is a SUIT_Command_Sequence to execute prior to
executing any other command sequence. Typical actions in suit-
common-sequence include setting expected Recipient identity and image
digests when they are conditional (see Section 8.7.7.4 and
Section 7.10 for more information on conditional sequences). suit-
common-sequence is RECOMMENDED to implement. It is REQUIRED if the
optimizations described in Section 6.2.1 will be used. Whenever a
parameter or try-each is required by more than one Command Sequence,
suit-common-sequence results in a smaller encoding.
8.7.2.1. Dependencies
SUIT_Dependency specifies a manifest that describes a dependency of SUIT_Dependency specifies a manifest that describes a dependency of
the current manifest. the current manifest. The Manifest is identified, however the
Recipient should expect an Envelope when it acquires the dependency.
This is because the Manifest is the one invariant element of the
Envelope, where other elements may change by countersigning, adding
authentication blocks, or severing elements.
The suit-dependency-digest specifies the dependency manifest uniquely The suit-dependency-digest specifies the dependency manifest uniquely
by identifying a particular Manifest structure. The digest is by identifying a particular Manifest structure. This is identical to
the digest that would be present as the payload of any suit-
authentication-block in the dependency's Envelope. The digest is
calculated over the Manifest structure instead of the COSE calculated over the Manifest structure instead of the COSE
Sig_structure or Mac_structure. This means that a digest may need to Sig_structure or Mac_structure. This is necessary to ensure that
be calculated more than once, however this is necessary to ensure removing a signature from a manifest does not break dependencies due
that removing a signature from a manifest does not break dependencies to missing signature elements. This is also necessary to support the
due to missing signature elements. This is also necessary to support trusted intermediary use case, where an intermediary re-signs the
the trusted intermediary use case, where an intermediary re-signs the
Manifest, removing the original signature, potentially with a Manifest, removing the original signature, potentially with a
different algorithm, or trading COSE_Sign for COSE_Mac. different algorithm, or trading COSE_Sign for COSE_Mac.
The suit-dependency-prefix element contains a The suit-dependency-prefix element contains a
SUIT_Component_Identifier. This specifies the scope at which the SUIT_Component_Identifier (see Section 8.7.2.2). This specifies the
dependency operates. This allows the dependency to be forwarded on scope at which the dependency operates. This allows the dependency
to a component that is capable of parsing its own manifests. It also to be forwarded on to a component that is capable of parsing its own
allows one manifest to be deployed to multiple dependent devices manifests. It also allows one manifest to be deployed to multiple
without those devices needing consistent component hierarchy. This dependent Recipients without those Recipients needing consistent
element is OPTIONAL. component hierarchy. This element is OPTIONAL.
9.7. SUIT_Component_Reference A dependency prefix can be used with a component identifier. This
allows complex systems to understand where dependencies need to be
applied. The dependency prefix can be used in one of two ways. The
first simply prepends the prefix to all Component Identifiers in the
dependency.
The SUIT_Component_Reference describes an image that is defined by A dependency prefix can also be used to indicate when a dependency
another manifest. This is useful for overriding the behavior of manifest needs to be processed by a secondary manifest processor, as
another manifest, for example by directing the recipient to look at a described in Section 6.8.
different URI for the image or by changing the expected format, such
as when a gateway performs decryption on behalf of a constrained
device.
9.8. SUIT_Command_Sequence 8.7.2.2. SUIT_Component_Identifier
A component is a unit of code or data that can be targeted by an
update. To facilitate composite devices, components are identified
by a list of CBOR byte strings, which allows construction of
hierarchical component structures. A dependency MAY declare a prefix
to the components defined in the dependency manifest. Components are
identified by Component Identifiers, i.e. arrays of binary strings,
but referenced in commands
A Component Identifier can be trivial, such as the simple array
[h'00']. It can also represent a filesystem path by encoding each
segment of the path as an element in the list. For example, the path
"/usr/bin/env" would encode to ['usr','bin','env'].
This hierarchical construction allows a component identifier to
identify any part of a complex, multi-component system.
8.7.3. SUIT_Command_Sequence
A SUIT_Command_Sequence defines a series of actions that the A SUIT_Command_Sequence defines a series of actions that the
Recipient MUST take to accomplish a particular goal. These goals are Recipient MUST take to accomplish a particular goal. These goals are
defined in the manifest and include: defined in the manifest and include:
1. Dependency Resolution: suit-dependency-resolution is a 1. Dependency Resolution: suit-dependency-resolution is a
SUIT_Command_Sequence to execute in order to perform dependency SUIT_Command_Sequence to execute in order to perform dependency
resolution. Typical actions include configuring URIs of resolution. Typical actions include configuring URIs of
dependency manifests, fetching dependency manifests, and dependency manifests, fetching dependency manifests, and
validating dependency manifests' contents. suit-dependency- validating dependency manifests' contents. suit-dependency-
skipping to change at page 25, line 20 skipping to change at page 37, line 43
optionally including actions such as decryption or decompression. optionally including actions such as decryption or decompression.
suit-load is OPTIONAL to implement. suit-load is OPTIONAL to implement.
6. Run or Boot: suit-run is a SUIT_Command_Sequence to execute in 6. Run or Boot: suit-run is a SUIT_Command_Sequence to execute in
order to run an image. suit-run typically contains a single order to run an image. suit-run typically contains a single
instruction: either the "run" directive for the bootable manifest instruction: either the "run" directive for the bootable manifest
or the "process dependencies" directive for any dependents of the or the "process dependencies" directive for any dependents of the
bootable manifest. suit-run is OPTIONAL to implement. Only one bootable manifest. suit-run is OPTIONAL to implement. Only one
manifest in an update may contain the "run" directive. manifest in an update may contain the "run" directive.
Each of these follows exactly the same structure to ensure that the Goals 1,2,3 form the Update Procedure. Goals 4,5,6 form the Boot
parser is as simple as possible. Procedure.
Each Command Sequence follows exactly the same structure to ensure
that the parser is as simple as possible.
Lists of commands are constructed from two kinds of element: Lists of commands are constructed from two kinds of element:
1. Conditions that MUST be true-any failure is treated as a failure 1. Conditions that MUST be true-any failure is treated as a failure
of the update/load/boot of the update/load/boot
2. Directives that MUST be executed. 2. Directives that MUST be executed.
Each condition is a command code identifier, followed by Nil. Each condition is a command code identifier, followed by a
SUIT_Reporting_Policy (Section 8.7.4).
Each directive is composed of: Each directive is composed of:
1. A command code identifier 1. A command code identifier
2. An argument block or Nil 2. An argument block or a reporting policy
Argument blocks are defined for each type of directive. Argument blocks are consumed only by flow-control directives:
- Set Component/Dependency Index
- Set/Override Parameters
- Try Each
- Run Sequence
Reporting policies provide a hint to the manifest processor of
whether or not to add the success or failure of a command to any
report that it generates.
Many conditions and directives apply to a given component, and these Many conditions and directives apply to a given component, and these
generally grouped together. Therefore, a special command to set the generally grouped together. Therefore, a special command to set the
current component index is provided with a matching command to set current component index is provided with a matching command to set
the current dependency index. This index is a numeric index into the the current dependency index. This index is a numeric index into the
component ID tables defined at the beginning of the document. For component ID tables defined at the beginning of the document. For
the purpose of setting the index, the two component ID tables are the purpose of setting the index, the two component ID tables are
considered to be concatenated together. considered to be concatenated together.
To facilitate optional conditions, a special directive is provided. To facilitate optional conditions, a special directive,
It runs several new lists of conditions/directives, one after Section 8.7.7.4, is provided. It runs several new lists of
another, that are contained as an argument to the directive. By conditions/directives, one after another, that are contained as an
default, it assumes that a failure of a condition should not indicate argument to the directive. By default, it assumes that a failure of
a failure of the update/boot, but a parameter is provided to override a condition should not indicate a failure of the update/boot, but a
this behavior. parameter is provided to override this behavior. See
Section 8.7.5.22.
9.8.1. suit-common 8.7.4. Reporting Policy
suit-common encodes all the information that is shared between each TODO: Records, bitfield
of the command sequences, including: suit-dependencies, suit-
components, suit-dependency-components, and suit-common-sequence.
suit-common is REQUIRED to implement.
suit-dependencies is a list of SUIT_Dependency blocks that specify To facilitate construction of Reports that describe the success, or
manifests that must be present before the current manifest can be failure of a given Procedure, each command is given a Reporting
processed. suit-dependencies is OPTIONAL to implement. Policy. This is an integer bitfield that follows the command and
indicates what the Recipient should do with the Record of executing
the command. The options are summarized in the table below.
In order to distinguish between components that are affected by the +-----------------------------+-------------------------------------+
current manifest and components that are affected by a dependency, | Policy | Description |
they are kept in separate lists. Components affected by the current +-----------------------------+-------------------------------------+
manifest only list the component identifier. Components affected by | suit-send-record-on-success | Record when the command succeeds |
a dependency include the component identifier and the index of the | | |
dependency that defines the component. | suit-send-record-on-failure | Record when the command fails |
| | |
| suit-send-sysinfo-success | Add system information when the |
| | command succeeds |
| | |
| suit-send-sysinfo-failure | Add system information when the |
| | command fails |
+-----------------------------+-------------------------------------+
suit-components is a list of SUIT_Component blocks that specify the Any or all of these policies may be enabled at once.
component identifiers that will be affected by the content of the
current manifest. suit-components is OPTIONAL to implement, but at
least one manifest MUST contain a suit-components block.
suit-dependency-components is a list of SUIT_Component_Reference SUIT does NOT REQUIRE a particular format of Records or Reports.
blocks that specify component identifiers that will be affected by SUIT only defines hints to the Reporting engine for which Records it
the content of a dependency of the current manifest. suit-dependency- should aggregate into the Report.
components is OPTIONAL to implement.
suit-common-sequence is a SUIT_Command_Sequence to execute prior to An OPTIONAL Record format, SUIT_Record is defined in [full-cddl]. It
executing any other command sequence. Typical actions in suit- is encoded as a map, with the following elements.
common-sequence include setting expected device identity and image
digests when they are conditional (see Section 12 for more
information on conditional sequences). suit-common-sequence is
RECOMMENDED to implement.
9.8.2. SUIT_Parameters +---------------------------------+---------------------------------+
| Element | Description |
+---------------------------------+---------------------------------+
| suit-record-success | The boolean or integer success |
| | or failure code of the command. |
| | |
| suit-record-component-id | The current component when the |
| | record was generated. |
| | |
| suit-record-dependency-id | The current dependency digest |
| | when the record was generated. |
| | |
| suit-record-command-sequence-id | The label of the Command |
| | Sequence that was executing |
| | when the record was generated. |
| | |
| suit-record-command-id | The label of the command that |
| | was in progress when the record |
| | was generated. |
| | |
| suit-record-params | The set of parameters that was |
| | consumed by the current |
| | command. |
| | |
| suit-record-actual | The value against which a suit- |
| | condition compared a parameter. |
+---------------------------------+---------------------------------+
In Secure Boot operations, the Reporting engine MAY aggregate the
Records produced in a Procedure into the evidence used for an
attestation report.
8.7.5. SUIT_Parameters
Many conditions and directives require additional information. That Many conditions and directives require additional information. That
information is contained within parameters that can be set in a information is contained within parameters that can be set in a
consistent way. This allows reduction of manifest size and consistent way. This allows reduction of manifest size and
replacement of parameters from one manifest to the next. replacement of parameters from one manifest to the next.
Most parameters are scoped to a specific component. This means that
setting a parameter for one component has no effect on the parameters
of any other component. The only exceptions to this are two Manifest
Processor parameters: Strict Order and Soft Failure.
The defined manifest parameters are described below. The defined manifest parameters are described below.
+----------------+----------------------------------+---------------+ +----------------+----------------------------------+---------------+
| Name | CDDL Structure | Reference | | Name | CDDL Structure | Reference |
+----------------+----------------------------------+---------------+ +----------------+----------------------------------+---------------+
| Vendor ID | suit-parameter-vendor-identifier | Section | | Vendor ID | suit-parameter-vendor-identifier | Section 8.7.5 |
| | | 9.8.2.1 | | | | .2 |
| | | | | | | |
| Class ID | suit-parameter-class-identifier | Section | | Class ID | suit-parameter-class-identifier | Section 8.7.5 |
| | | 9.8.2.2 | | | | .3 |
| | | | | | | |
| Image Digest | suit-parameter-image-digest | Section | | Image Digest | suit-parameter-image-digest | Section 8.7.5 |
| | | 9.8.2.3 | | | | .5 |
| | | | | | | |
| Image Size | suit-parameter-image-size | Section | | Image Size | suit-parameter-image-size | Section 8.7.5 |
| | | 9.8.2.4 | | | | .6 |
| | | | | | | |
| Use Before | suit-parameter-use-before | Section | | Use Before | suit-parameter-use-before | Section 8.7.5 |
| | | 9.8.2.5 | | | | .7 |
| | | | | | | |
| Component | suit-parameter-component-offset | Section | | Component | suit-parameter-component-offset | Section 8.7.5 |
| Offset | | 9.8.2.6 | | Offset | | .8 |
| | | | | | | |
| Encryption | suit-parameter-encryption-info | Section | | Encryption | suit-parameter-encryption-info | Section 8.7.5 |
| Info | | 9.8.2.7 | | Info | | .9 |
| | | | | | | |
| Compression | suit-parameter-compression-info | Section | | Compression | suit-parameter-compression-info | Section 8.7.5 |
| Info | | 9.8.2.8 | | Info | | .10 |
| | | | | | | |
| Unpack Info | suit-parameter-unpack-info | Section | | Unpack Info | suit-parameter-unpack-info | Section 8.7.5 |
| | | 9.8.2.9 | | | | .11 |
| | | | | | | |
| URI | suit-parameter-uri | Section | | URI | suit-parameter-uri | Section 8.7.5 |
| | | 9.8.2.10 | | | | .12 |
| | | | | | | |
| Source | suit-parameter-source-component | Section | | Source | suit-parameter-source-component | Section 8.7.5 |
| Component | | 9.8.2.11 | | Component | | .13 |
| | | | | | | |
| Run Args | suit-parameter-run-args | Section | | Run Args | suit-parameter-run-args | Section 8.7.5 |
| | | 9.8.2.12 | | | | .14 |
| | | | | | | |
| Device ID | suit-parameter-device-identifier | Section | | Device ID | suit-parameter-device-identifier | Section 8.7.5 |
| | | 9.8.2.13 | | | | .4 |
| | | | | | | |
| Minimum | suit-parameter-minimum-battery | Section | | Minimum | suit-parameter-minimum-battery | Section 8.7.5 |
| Battery | | 9.8.2.14 | | Battery | | .15 |
| | | | | | | |
| Update | suit-parameter-update-priority | Section | | Update | suit-parameter-update-priority | Section 8.7.5 |
| Priority | | 9.8.2.15 | | Priority | | .16 |
| | | | | | | |
| Version | suit-parameter-version | Section | | Version | suit-parameter-version | Section 8.7.5 |
| | | 9.8.2.16 | | | | .17 |
| | | | | | | |
| Wait Info | suit-parameter-wait-info | Section | | Wait Info | suit-parameter-wait-info | Section 8.7.5 |
| | | 9.8.2.17 | | | | .18 |
| | | | | | | |
| URI List | suit-parameter-uri-list | Section | | URI List | suit-parameter-uri-list | Section 8.7.5 |
| | | 9.8.2.18 | | | | .19 |
| | | | | | | |
| Strict Order | suit-parameter-strict-order | Section | | Fetch | suit-parameter-fetch-arguments | Section 8.7.5 |
| | | 9.8.2.19 | | Arguments | | .20 |
| | | | | | | |
| Soft Failure | suit-parameter-soft-failure | Section | | Strict Order | suit-parameter-strict-order | Section 8.7.5 |
| | | 9.8.2.20 | | | | .21 |
| | | | | | | |
| Custom | suit-parameter-custom | Section | | Soft Failure | suit-parameter-soft-failure | Section 8.7.5 |
| | | 9.8.2.21 | | | | .22 |
| | | |
| Custom | suit-parameter-custom | Section 8.7.5 |
| | | .23 |
+----------------+----------------------------------+---------------+ +----------------+----------------------------------+---------------+
CBOR-encoded object parameters are still wrapped in a bstr. This is CBOR-encoded object parameters are still wrapped in a bstr. This is
because it allows a parser that is aggregating parameters to because it allows a parser that is aggregating parameters to
reference the object with a single pointer and traverse it without reference the object with a single pointer and traverse it without
understanding the contents. This is important for modularization and understanding the contents. This is important for modularization and
division of responsibility within a pull parser. The same division of responsibility within a pull parser. The same
consideration does not apply to Directives because those elements are consideration does not apply to Directives because those elements are
invoked with their arguments immediately invoked with their arguments immediately
9.8.2.1. suit-parameter-vendor-identifier 8.7.5.1. Constructing Identifiers
Several conditions use identifiers to determine whether a manifest
matches a given Recipient or not. These identifiers are defined to
be RFC 4122 [RFC4122] UUIDs. These UUIDs are not human-readable and
are therefore used for machine-based processing only.
A Recipient MAY match any number of UUIDs for vendor or class
identifier. This may be relevant to physical or software modules.
For example, a Recipient that has an OS and one or more applications
might list one Vendor ID for the OS and one or more additional Vendor
IDs for the applications. This Recipient might also have a Class ID
that must be matched for the OS and one or more Class IDs for the
applications.
Identifiers are used for compatibility checks. They MUST NOT be used
as assertions of identity. They are evaluated by identifier
conditions (Section 8.7.6.1).
A more complete example: Imagine a device has the following physical
components: 1. A host MCU 2. A WiFi module
This same device has three software modules: 1. An operating system
2. A WiFi module interface driver 3. An application
Suppose that the WiFi module's firmware has a proprietary update
mechanism and doesn't support manifest processing. This device can
report four class IDs:
1. Hardware model/revision
2. OS
3. WiFi module model/revision
4. Application
This allows the OS, WiFi module, and application to be updated
independently. To combat possible incompatibilities, the OS class ID
can be changed each time the OS has a change to its API.
This approach allows a vendor to target, for example, all devices
with a particular WiFi module with an update, which is a very
powerful mechanism, particularly when used for security updates.
UUIDs MUST be created according to RFC 4122 [RFC4122]. UUIDs SHOULD
use versions 3, 4, or 5, as described in RFC4122. Versions 1 and 2
do not provide a tangible benefit over version 4 for this
application.
The RECOMMENDED method to create a vendor ID is: Vendor ID =
UUID5(DNS_PREFIX, vendor domain name)
The RECOMMENDED method to create a class ID is: Class ID =
UUID5(Vendor ID, Class-Specific-Information)
Class-specific information is composed of a variety of data, for
example:
- Model number.
- Hardware revision.
- Bootloader version (for immutable bootloaders).
8.7.5.2. suit-parameter-vendor-identifier
A RFC 4122 UUID representing the vendor of the device or component. A RFC 4122 UUID representing the vendor of the device or component.
The UUID is encoded as a 16 byte bstr, containing the raw bytes of
the UUID. It MUST be constructed as described in Section 8.7.5.1
9.8.2.2. suit-parameter-class-identifier 8.7.5.3. suit-parameter-class-identifier
A RFC 4122 UUID representing the class of the device or component A RFC 4122 UUID representing the class of the device or component.
The UUID is encoded as a 16 byte bstr, containing the raw bytes of
the UUID. It MUST be constructed as described in Section 8.7.5.1
9.8.2.3. suit-parameter-image-digest 8.7.5.4. suit-parameter-device-identifier
A fingerprint computed over the image itself encoded in the A RFC 4122 UUID representing the specific device or component. The
SUIT_Digest structure. UUID is encoded as a 16 byte bstr, containing the raw bytes of the
UUID. It MUST be constructed as described in Section 8.7.5.1
9.8.2.4. suit-parameter-image-size 8.7.5.5. suit-parameter-image-digest
The size of the firmware image in bytes. A fingerprint computed over the component itself, encoded in the
Section 10 structure. The SUIT_Digest is wrapped in a bstr, as
required in Section 8.7.5.
9.8.2.5. suit-parameter-use-before 8.7.5.6. suit-parameter-image-size
An expire date for the use of the manifest encoded as a POSIX The size of the firmware image in bytes. This size is encoded as a
timestamp. positive integer.
9.8.2.6. suit-parameter-component-offset 8.7.5.7. suit-parameter-use-before
This parameter sets the offset in a component. An expiry date for the use of the manifest encoded as a POSIX
timestamp; a positive integer. Implementations that use this
parameter MUST use a 64-bit internal representation of the integer.
9.8.2.7. suit-parameter-encryption-info 8.7.5.8. suit-parameter-component-offset
This parameter sets the offset in a component. Some components
support multiple possible Slots (offsets into a storage area). This
parameter describes the intended Slot to use, identified by its
offset into the component's storage area. This offset MUST be
encoded as a positive integer.
8.7.5.9. suit-parameter-encryption-info
Encryption Info defines the mechanism that Fetch or Copy should use Encryption Info defines the mechanism that Fetch or Copy should use
to decrypt the data they transfer. SUIT_Parameter_Encryption_Info is to decrypt the data they transfer. SUIT_Parameter_Encryption_Info is
encoded as a COSE_Encrypt_Tagged or a COSE_Encrypt0_Tagged, wrapped encoded as a COSE_Encrypt_Tagged or a COSE_Encrypt0_Tagged, wrapped
in a bstr. in a bstr.
9.8.2.8. suit-parameter-compression-info 8.7.5.10. suit-parameter-compression-info
Compression Info defines any information that is required for a Compression Info defines any information that is required for a
device to perform decompression operations. Typically, this includes Recipient to perform decompression operations. Typically, this
the algorithm identifier. This document defines the use of ZLIB includes the algorithm identifier. This document defines the use of
[RFC1950], Brotli [RFC7932], and ZSTD [I-D.kucherawy-rfc8478bis]. ZLIB [RFC1950], Brotli [RFC7932], and ZSTD
[I-D.kucherawy-rfc8478bis].
Additional compression formats can be registered through the IANA- Additional compression formats can be registered through the IANA-
maintained registry. maintained registry.
9.8.2.9. suit-parameter-unpack-info 8.7.5.11. suit-parameter-unpack-info
SUIT_Unpack_Info defines the information required for a device to SUIT_Unpack_Info defines the information required for a Recipient to
interpret a packed format. This document defines the use of the interpret a packed format. This document defines the use of the
following binary encodings: Intel HEX [HEX], Motorola S-record following binary encodings: Intel HEX [HEX], Motorola S-record
[SREC], Executable and Linkable Format (ELF) [ELF], and Common Object [SREC], Executable and Linkable Format (ELF) [ELF], and Common Object
File Format (COFF) [COFF]. File Format (COFF) [COFF].
Additional packing formats can be registered through the IANA- Additional packing formats can be registered through the IANA-
maintained registry. maintained registry.
9.8.2.10. suit-parameter-uri 8.7.5.12. suit-parameter-uri
A URI from which to fetch a resource. A URI from which to fetch a resource.
9.8.2.11. suit-parameter-source-component 8.7.5.13. suit-parameter-source-component
This parameter sets the source component. This parameter sets the source component to be used with either
Section 8.7.7.10 or with Section 8.7.7.14. The current Component, as
set by suit-directive-set-component-index defines the destination,
and suit-parameter-source-component defines the source.
9.8.2.12. suit-parameter-run-args 8.7.5.14. suit-parameter-run-args
This parameter contains an encoded set of arguments for Run. This parameter contains an encoded set of arguments for
Section 8.7.7.11. The arguments MUST be provided as an
implementation-defined bstr.
9.8.2.13. suit-parameter-device-identifier 8.7.5.15. suit-parameter-minimum-battery
A RFC 4122 UUID representing the device or component. This parameter sets the minimum battery level in mWh. This parameter
is encoded as a positive integer. Used with Section 8.7.6.6.
9.8.2.14. suit-parameter-minimum-battery 8.7.5.16. suit-parameter-update-priority
This parameter sets the minimum battery level in mWh. This parameter sets the priority of the update. This parameter is
encoded as an integer. It is used along with suit-condition-update-
authorized [1] to ask an application for permission to initiate an
update. This does not constitute a privilege inversion because an
explicit request for authorization has been provided by the Update
Authority in the form of the suit-condition-update-authorized
command.
9.8.2.15. suit-parameter-update-priority Applications MAY define their own meanings for the update priority.
For example, critical reliability & vulnerability fixes MAY be given
negative numbers, while bug fixes MAY be given small positive
numbers, and feature additions MAY be given larger positive numbers,
which allows an application to make an informed decision about
whether and when to allow an update to proceed.
This parameter sets the priority of the update. 8.7.5.17. suit-parameter-version
9.8.2.16. suit-parameter-version Indicates allowable versions for the specified component. Allowable
versions can be specified, either with a list or with range matching.
This parameter is compared with version asserted by the current
component when Section 8.7.6.8 is invoked. The current component may
assert the current version in many ways, including storage in a
parameter storage database, in a metadata object, or in a known
location within the component itself.
Allows to indicate the version numbers of firmware to which the The component version can be compared as:
manifest applies, either with a list or with range matching.
9.8.2.17. suit-parameter-wait-info - Greater.
suit-directive-wait Section 9.8.4.11 directs the manifest processor - Greater or Equal.
- Equal.
- Lesser or Equal.
- Lesser.
Versions are encoded as a CBOR list of integers. Comparisons are
done on each integer in sequence. Comparison stops after all
integers in the list defined by the manifest have been consumed OR
after a non-equal match has occurred. For example, if the manifest
defines a comparison, "Equal [1]", then this will match all version
sequences starting with 1. If a manifest defines both "Greater or
Equal [1,0]" and "Lesser [1,10]", then it will match versions 1.0.x
up to, but not including 1.10.
While the exact encoding of versions is application-defined, semantic
versions map conveniently. For example,
- 1.2.3 = [1,2,3].
- 1.2-rc3 = [1,2,-1,3].
- 1.2-beta = [1,2,-2].
- 1.2-alpha = [1,2,-3].
- 1.2-alpha4 = [1,2,-3,4].
suit-condition-version is OPTIONAL to implement.
Versions SHOULD be provided as follows:
1. The first integer represents the major number. This indicates
breaking changes to the component.
2. The second integer represents the minor number. This is
typically reserved for new features or large, non-breaking
changes.
3. The third integer is the patch version. This is typically
reserved for bug fixes.
4. The fourth integer is the build number.
Where Alpha (-3), Beta (-2), and Release Candidate (-1) are used,
they are inserted as a negative number between Minor and Patch
numbers. This allows these releases to compare correctly with final
releases. For example, Version 2.0, RC1 should be lower than Version
2.0.0 and higher than any Version 1.x. By encoding RC as -1, this
works correctly: [2,0,-1,1] compares as lower than [2,0,0].
Similarly, beta (-2) is lower than RC and alpha (-3) is lower than
RC.
8.7.5.18. suit-parameter-wait-info
suit-directive-wait Section 8.7.7.12 directs the manifest processor
to pause until a specified event occurs. The suit-parameter-wait- to pause until a specified event occurs. The suit-parameter-wait-
info encodes the parameters needed for the directive. info encodes the parameters needed for the directive.
9.8.2.18. suit-parameter-uri-list The exact implementation of the pause is implementation-defined. For
example, this could be done by blocking on a semaphore, registering
an event handler and suspending the manifest processor, polling for a
notification, or aborting the update entirely, then restarting when a
notification is received.
Indicates a list of URIs from which to fetch a resource. suit-parameter-wait-info is encoded as a map of wait events. When
ALL wait events are satisfied, the Manifest Processor continues. The
wait events currently defined are described in the following table.
9.8.2.19. suit-parameter-strict-order +--------------------------------------+----------+-----------------+
| Name | Encoding | Description |
+--------------------------------------+----------+-----------------+
| suit-wait-event-authorization | int | Same as Section |
| | | 8.7.5.16 |
| | | |
| suit-wait-event-power | int | Wait until |
| | | power state |
| | | |
| suit-wait-event-network | int | Wait until |
| | | network state |
| | | |
| suit-wait-event-other-device-version | See | Wait for other |
| | below | device to match |
| | | version |
| | | |
| suit-wait-event-time | uint | Wait until time |
| | | (POSIX |
| | | timestamp) |
| | | |
| suit-wait-event-time-of-day | uint | Wait until |
| | | seconds since |
| | | 00:00:00 |
| | | |
| suit-wait-event-day-of-week | uint | Wait until days |
| | | since Sunday |
+--------------------------------------+----------+-----------------+
suit-wait-event-other-device-version reuses the encoding of suit-
parameter-version-match. It is encoded as a sequence that contains
an implementation-defined bstr identifier for the other device, and a
list of one or more SUIT_Parameter_Version_Match.
8.7.5.19. suit-parameter-uri-list
Indicates a list of URIs from which to fetch a resource. The URI
list is encoded as a list of tstr, in priority order. The Recipient
should attempt to fetch the resource from each URI in turn, ruling
out each, in order, if the resource is inaccessible or it is
otherwise undesirable to fetch from that URI. suit-parameter-uri-list
is consumed by Section 8.7.7.9.
8.7.5.20. suit-parameter-fetch-arguments
An implementation-defined set of arguments to Section 8.7.7.8.
Arguments are encoded in a bstr.
8.7.5.21. suit-parameter-strict-order
The Strict Order Parameter allows a manifest to govern when The Strict Order Parameter allows a manifest to govern when
directives can be executed out-of-order. This allows for systems directives can be executed out-of-order. This allows for systems
that have a sensitivity to order of updates to choose the order in that have a sensitivity to order of updates to choose the order in
which they are executed. It also allows for more advanced systems to which they are executed. It also allows for more advanced systems to
parallelize their handling of updates. Strict Order defaults to parallelize their handling of updates. Strict Order defaults to
True. It MAY be set to False when the order of operations does not True. It MAY be set to False when the order of operations does not
matter. When arriving at the end of a command sequence, ALL commands matter. When arriving at the end of a command sequence, ALL commands
MUST have completed, regardless of the state of MUST have completed, regardless of the state of
SUIT_Parameter_Strict_Order. If SUIT_Parameter_Strict_Order is SUIT_Parameter_Strict_Order. If SUIT_Parameter_Strict_Order is
returned to True, ALL preceding commands MUST complete before the returned to True, ALL preceding commands MUST complete before the
next command is executed. next command is executed.
9.8.2.20. suit-parameter-soft-failure See Section 6.6 for behavioral description of Strict Order.
When executing a command sequence inside SUIT_Directive_Try_Each and 8.7.5.22. suit-parameter-soft-failure
a condition failure occurs, the manifest processor aborts the
sequence. If Soft Failure is True, it returns Success. Otherwise, When executing a command sequence inside Section 8.7.7.4 or
it returns the original condition failure. Section 8.7.7.13 and a condition failure occurs, the manifest
SUIT_Parameter_Soft_Failure is scoped to the enclosing processor aborts the sequence. For suit-directive-try-each, if Soft
Failure is True, the next sequence in Try Each is invoked, otherwise
suit-directive-try-each fails with the condition failure code. In
suit-directive-run-sequence, if Soft Failure is True the suit-
directive-run-sequence simply halts with no side-effects and the
Manifest Processor continues with the following command, otherwise,
the suit-directive-run-sequence fails with the condition failure
code.
suit-parameter-soft-failure is scoped to the enclosing
SUIT_Command_Sequence. Its value is discarded when SUIT_Command_Sequence. Its value is discarded when
SUIT_Command_Sequence terminates. SUIT_Command_Sequence terminates. It MUST NOT be set outside of
suit-directive-try-each or suit-directive-run-sequence.
9.8.2.21. suit-parameter-custom When suit-directive-try-each is invoked, Soft Failure defaults to
True. An Update Author may choose to set Soft Failure to False if
they require a failed condition in a sequence to force an Abort.
When suit-directive-run-sequence is invoked, Soft Failure defaults to
False. An Update Author may choose to make failures soft within a
suit-directive-run-sequence.
8.7.5.23. suit-parameter-custom
This parameter is an extension point for any proprietary, application This parameter is an extension point for any proprietary, application
specific conditions and directives. specific conditions and directives.
9.8.3. SUIT_Condition 8.7.6. SUIT_Condition
Conditions are used to define mandatory properties of a system in Conditions are used to define mandatory properties of a system in
order for an update to be applied. They can be pre-conditions or order for an update to be applied. They can be pre-conditions or
post-conditions of any directive or series of directives, depending post-conditions of any directive or series of directives, depending
on where they are placed in the list. Conditions never take on where they are placed in the list. All Conditions specify a
arguments; conditions should test using parameters instead. Reporting Policy as described Section 8.7.4. Conditions include:
Conditions include:
+----------------+----------------------------------+---------------+ +----------------+----------------------------------+---------------+
| Name | CDDL Structure | Reference | | Name | CDDL Structure | Reference |
+----------------+----------------------------------+---------------+ +----------------+----------------------------------+---------------+
| Vendor | suit-condition-vendor-identifier | Section | | Vendor | suit-condition-vendor-identifier | Section 8.7.6 |
| Identifier | | 9.8.3.1 | | Identifier | | .1 |
| | | | | | | |
| Class | suit-condition-class-identifier | Section | | Class | suit-condition-class-identifier | Section 8.7.6 |
| Identifier | | 9.8.3.1 | | Identifier | | .1 |
| | | | | | | |
| Device | suit-condition-device-identifier | Section | | Device | suit-condition-device-identifier | Section 8.7.6 |
| Identifier | | 9.8.3.1 | | Identifier | | .1 |
| | | | | | | |
| Image Match | suit-condition-image-match | Section | | Image Match | suit-condition-image-match | Section 8.7.6 |
| | | 9.8.3.2 | | | | .2 |
| | | | | | | |
| Image Not | suit-condition-image-not-match | Section | | Image Not | suit-condition-image-not-match | Section 8.7.6 |
| Match | | 9.8.3.3 | | Match | | .3 |
| | | | | | | |
| Use Before | suit-condition-use-before | Section | | Use Before | suit-condition-use-before | Section 8.7.6 |
| | | 9.8.3.4 | | | | .4 |
| | | | | | | |
| Component | suit-condition-component-offset | Section | | Component | suit-condition-component-offset | Section 8.7.6 |
| Offset | | 9.8.3.5 | | Offset | | .5 |
| | | | | | | |
| Minimum | suit-condition-minimum-battery | Section | | Minimum | suit-condition-minimum-battery | Section 8.7.6 |
| Battery | | 9.8.3.6 | | Battery | | .6 |
| | | | | | | |
| Update | suit-condition-update-authorized | Section | | Update | suit-condition-update-authorized | Section 8.7.6 |
| Authorized | | 9.8.3.7 | | Authorized | | .7 |
| | | | | | | |
| Version | suit-condition-version | Section | | Version | suit-condition-version | Section 8.7.6 |
| | | 9.8.3.8 | | | | .8 |
| | | | | | | |
| Custom | SUIT_Condition_Custom | Section | | Custom | SUIT_Condition_Custom | Section 8.7.6 |
| Condition | | 9.8.3.9 | | Condition | | .9 |
+----------------+----------------------------------+---------------+ +----------------+----------------------------------+---------------+
The abstract description of these conditions is defined in
Section 6.4.
Conditions compare parameters against properties of the system.
These properties may be asserted in many different ways, including:
calculation on-demand, volatile definition in memory, static
definition within the manifest processor, storage in known location
within an image, storage within a key storage system, storage in One-
Time-Programmable memory, inclusion in mask ROM, or inclusion as a
register in hardware. Some of these assertion methods are global in
scope, such as a hardware register, some are scoped to an individual
component, such as storage at a known location in an image, and some
assertion methods can be either global or component-scope, based on
implementation.
Each condition MUST report a result code on completion. If a Each condition MUST report a result code on completion. If a
condition reports failure, then the current sequence of commands MUST condition reports failure, then the current sequence of commands MUST
terminate. If a condition requires additional information, this MUST terminate. A subsequent command or command sequence MAY continue
be specified in one or more parameters before the condition is executing if Section 8.7.5.22 is set. If a condition requires
executed. If a Recipient attempts to process a condition that additional information, this MUST be specified in one or more
expects additional information and that information has not been set, parameters before the condition is executed. If a Recipient attempts
it MUST report a failure. If a Recipient encounters an unknown to process a condition that expects additional information and that
condition, it MUST report a failure. information has not been set, it MUST report a failure. If a
Recipient encounters an unknown condition, it MUST report a failure.
Condition labels in the positive number range are reserved for IANA Condition labels in the positive number range are reserved for IANA
registration while those in the negative range are custom conditions registration while those in the negative range are custom conditions
reserved for proprietary use. reserved for proprietary use. See Section 11 for more details.
Several conditions use identifiers to determine whether a manifest
matches a given Recipient or not. These identifiers are defined to
be RFC 4122 [RFC4122] UUIDs. These UUIDs are not human-readable and
are therefore used for machine-based processing only.
A device may match any number of UUIDs for vendor or class
identifier. This may be relevant to physical or software modules.
For example, a device that has an OS and one or more applications
might list one Vendor ID for the OS and one or more additional Vendor
IDs for the applications. This device might also have a Class ID
that must be matched for the OS and one or more Class IDs for the
applications.
A more complete example: Imagine a device has the following physical
components: 1. A host MCU 2. A WiFi module
This same device has three software modules: 1. An operating system
2. A WiFi module interface driver 3. An application
Suppose that the WiFi module's firmware has a proprietary update
mechanism and doesn't support manifest processing. This device can
report four class IDs:
1. hardware model/revision
2. OS
3. WiFi module model/revision
4. Application
This allows the OS, WiFi module, and application to be updated
independently. To combat possible incompatibilities, the OS class ID
can be changed each time the OS has a change to its API.
This approach allows a vendor to target, for example, all devices
with a particular WiFi module with an update, which is a very
powerful mechanism, particularly when used for security updates.
UUIDs MUST be created according to RFC 4122 [RFC4122]. UUIDs SHOULD
use versions 3, 4, or 5, as described in RFC4122. Versions 1 and 2
do not provide a tangible benefit over version 4 for this
application.
The RECOMMENDED method to create a vendor ID is: Vendor ID =
UUID5(DNS_PREFIX, vendor domain name)
The RECOMMENDED method to create a class ID is: Class ID =
UUID5(Vendor ID, Class-Specific-Information)
Class-specific information is composed of a variety of data, for
example:
- Model number.
- Hardware revision.
- Bootloader version (for immutable bootloaders).
9.8.3.1. suit-condition-vendor-identifier, suit-condition-class- 8.7.6.1. suit-condition-vendor-identifier, suit-condition-class-
identifier, and suit-condition-device-identifier identifier, and suit-condition-device-identifier
There are three identifier-based conditions: suit-condition-vendor- There are three identifier-based conditions: suit-condition-vendor-
identifier, suit-condition-class-identifier, and suit-condition- identifier, suit-condition-class-identifier, and suit-condition-
device-identifier. Each of these conditions match a RFC 4122 device-identifier. Each of these conditions match a RFC 4122
[RFC4122] UUID that MUST have already been set as a parameter. The [RFC4122] UUID that MUST have already been set as a parameter. The
installing device MUST match the specified UUID in order to consider installing Recipient MUST match the specified UUID in order to
the manifest valid. These identifiers MAY be scoped by component. consider the manifest valid. These identifiers are scoped by
component in the manifest. The Recipient MAY treat them as scoped by
component or as global identifiers.
The Recipient uses the ID parameter that has already been set using The Recipient uses the ID parameter that has already been set using
the Set Parameters directive. If no ID has been set, this condition the Set Parameters directive. If no ID has been set, this condition
fails. suit-condition-class-identifier and suit-condition-vendor- fails. suit-condition-class-identifier and suit-condition-vendor-
identifier are REQUIRED to implement. suit-condition-device- identifier are REQUIRED to implement. suit-condition-device-
identifier is OPTIONAL to implement. identifier is OPTIONAL to implement.
9.8.3.2. suit-condition-image-match Each identifier condition compares the corresponding identifier
parameter to a parameter asserted to the Manifest Processor by the
Recipient. Identifiers MUST be known to the Manifest Processor in
order to evaluate compatibility.
Verify that the current component matches the digest parameter for Globally-scoped identifiers MUST match, regardless of current
the current component. The digest is verified against the digest component index. Component-scoped identifiers match only when the
current component index resolves to the component associated with the
component-scoped identifier.
8.7.6.2. suit-condition-image-match
Verify that the current component matches the Section 8.7.5.5 for the
current component. The digest is verified against the digest
specified in the Component's parameters list. If no digest is specified in the Component's parameters list. If no digest is
specified, the condition fails. suit-condition-image-match is specified, the condition fails. suit-condition-image-match is
REQUIRED to implement. REQUIRED to implement.
9.8.3.3. suit-condition-image-not-match 8.7.6.3. suit-condition-image-not-match
Verify that the current component does not match the supplied digest. Verify that the current component does not match the Section 8.7.5.5.
If no digest is specified, then the digest is compared against the If no digest is specified, the condition fails. suit-condition-image-
digest specified in the Component's parameters list. If no digest is not-match is OPTIONAL to implement.
specified, the condition fails. suit-condition-image-not-match is
OPTIONAL to implement.
9.8.3.4. suit-condition-use-before 8.7.6.4. suit-condition-use-before
Verify that the current time is BEFORE the specified time. suit- Verify that the current time is BEFORE the specified time. suit-
condition-use-before is used to specify the last time at which an condition-use-before is used to specify the last time at which an
update should be installed. The recipient evaluates the current time update should be installed. The recipient evaluates the current time
against the suit-parameter-use-before parameter, which must have against the suit-parameter-use-before parameter (Section 8.7.5.7),
already been set as a parameter, encoded as a POSIX timestamp, that which must have already been set as a parameter, encoded as a POSIX
is seconds after 1970-01-01 00:00:00. Timestamp conditions MUST be timestamp, that is seconds after 1970-01-01 00:00:00. Timestamp
evaluated in 64 bits, regardless of encoded CBOR size. suit- conditions MUST be evaluated in 64 bits, regardless of encoded CBOR
condition-use-before is OPTIONAL to implement. size. suit-condition-use-before is OPTIONAL to implement.
9.8.3.5. suit-condition-component-offset 8.7.6.5. suit-condition-component-offset
TBD. Verify that the offset of the current component matches the offset
set in Section 8.7.5.8. This condition allows a manifest to select
between several images to match a target offset.
9.8.3.6. suit-condition-minimum-battery 8.7.6.6. suit-condition-minimum-battery
suit-condition-minimum-battery provides a mechanism to test a suit-condition-minimum-battery provides a mechanism to test a
device's battery level before installing an update. This condition Recipient's battery level before installing an update. This
is for use in primary-cell applications, where the battery is only condition is primarily for use in primary-cell applications, where
ever discharged. For batteries that are charged, suit-directive-wait the battery is only ever discharged. For batteries that are charged,
is more appropriate, since it defines a "wait" until the battery suit-directive-wait is more appropriate, since it defines a "wait"
level is sufficient to install the update. suit-condition-minimum- until the battery level is sufficient to install the update. suit-
battery is specified in mWh. suit-condition-minimum-battery is condition-minimum-battery is specified in mWh. suit-condition-
OPTIONAL to implement. minimum-battery is OPTIONAL to implement. suit-condition-minimum-
battery consumes Section 8.7.5.15.
9.8.3.7. suit-condition-update-authorized 8.7.6.7. suit-condition-update-authorized
Request Authorization from the application and fail if not Request Authorization from the application and fail if not
authorized. This can allow a user to decline an update. Argument is authorized. This can allow a user to decline an update.
an integer priority level. Priorities are application defined. suit- Section 8.7.5.16 provides an integer priority level that the
condition-update-authorized is OPTIONAL to implement. application can use to determine whether or not to authorize the
update. Priorities are application defined. suit-condition-update-
authorized is OPTIONAL to implement.
9.8.3.8. suit-condition-version 8.7.6.8. suit-condition-version
suit-condition-version allows comparing versions of firmware. suit-condition-version allows comparing versions of firmware.
Verifying image digests is preferred to version checks because Verifying image digests is preferred to version checks because
digests are more precise. The image can be compared as: digests are more precise. suit-condition-version examines a
component's version against the version info specified in
- Greater. Section 8.7.5.17
- Greater or Equal.
- Equal.
- Lesser or Equal.
- Lesser.
Versions are encoded as a CBOR list of integers. Comparisons are
done on each integer in sequence. Comparison stops after all
integers in the list defined by the manifest have been consumed OR
after a non-equal match has occurred. For example, if the manifest
defines a comparison, "Equal [1]", then this will match all version
sequences starting with 1. If a manifest defines both "Greater or
Equal [1,0]" and "Lesser [1,10]", then it will match versions 1.0.x
up to, but not including 1.10.
While the exact encoding of versions is application-defined, semantic
versions map conveniently. For example,
- 1.2.3 = [1,2,3].
- 1.2-rc3 = [1,2,-1,3].
- 1.2-beta = [1,2,-2].
- 1.2-alpha = [1,2,-3].
- 1.2-alpha4 = [1,2,-3,4].
suit-condition-version is OPTIONAL to implement.
9.8.3.9. SUIT_Condition_Custom 8.7.6.9. SUIT_Condition_Custom
SUIT_Condition_Custom describes any proprietary, application specific SUIT_Condition_Custom describes any proprietary, application specific
condition. This is encoded as a negative integer, chosen by the condition. This is encoded as a negative integer, chosen by the
firmware developer. If additional information must be provided to firmware developer. If additional information must be provided to
the condition, it should be encoded in a custom parameter (a nint) as the condition, it should be encoded in a custom parameter (a nint) as
described in Section 9.8.2. SUIT_Condition_Custom is OPTIONAL to described in Section 8.7.5. SUIT_Condition_Custom is OPTIONAL to
implement. implement.
9.8.4. SUIT_Directive 8.7.7. SUIT_Directive
Directives are used to define the behavior of the recipient. Directives are used to define the behavior of the recipient.
Directives include: Directives include:
+---------------+-------------------------------------+-------------+ +---------------+-------------------------------------+-------------+
| Name | CDDL Structure | Reference | | Name | CDDL Structure | Reference |
+---------------+-------------------------------------+-------------+ +---------------+-------------------------------------+-------------+
| Set Component | suit-directive-set-component-index | Section | | Set Component | suit-directive-set-component-index | Section 8.7 |
| Index | | 9.8.4.1 | | Index | | .7.1 |
| | | | | | | |
| Set | suit-directive-set-dependency-index | Section | | Set | suit-directive-set-dependency-index | Section 8.7 |
| Dependency | | 9.8.4.2 | | Dependency | | .7.2 |
| Index | | | | Index | | |
| | | | | | | |
| Abort | suit-directive-abort | Section | | Abort | suit-directive-abort | Section 8.7 |
| | | 9.8.4.3 | | | | .7.3 |
| | | | | | | |
| Try Each | suit-directive-try-each | Section | | Try Each | suit-directive-try-each | Section 8.7 |
| | | 9.8.4.4 | | | | .7.4 |
| | | | | | | |
| Process | suit-directive-process-dependency | Section | | Process | suit-directive-process-dependency | Section 8.7 |
| Dependency | | 9.8.4.5 | | Dependency | | .7.5 |
| | | | | | | |
| Set | suit-directive-set-parameters | Section | | Set | suit-directive-set-parameters | Section 8.7 |
| Parameters | | 9.8.4.6 | | Parameters | | .7.6 |
| | | | | | | |
| Override | suit-directive-override-parameters | Section | | Override | suit-directive-override-parameters | Section 8.7 |
| Parameters | | 9.8.4.7 | | Parameters | | .7.7 |
| | | | | | | |
| Fetch | suit-directive-fetch | Section | | Fetch | suit-directive-fetch | Section 8.7 |
| | | 9.8.4.8 | | | | .7.8 |
| | | | | | | |
| Copy | suit-directive-copy | Section | | Copy | suit-directive-copy | Section 8.7 |
| | | 9.8.4.9 | | | | .7.10 |
| | | | | | | |
| Run | suit-directive-run | Section | | Run | suit-directive-run | Section 8.7 |
| | | 9.8.4.10 | | | | .7.11 |
| | | | | | | |
| Wait For | suit-directive-wait | Section | | Wait For | suit-directive-wait | Section 8.7 |
| Event | | 9.8.4.11 | | Event | | .7.12 |
| | | | | | | |
| Run Sequence | suit-directive-run-sequence | Section | | Run Sequence | suit-directive-run-sequence | Section 8.7 |
| | | 9.8.4.12 | | | | .7.13 |
| | | | | | | |
| Swap | suit-directive-swap | Section | | Swap | suit-directive-swap | Section 8.7 |
| | | 9.8.4.13 | | | | .7.14 |
| | | |
| Fetch URI | suit-directive-fetch-uri-list | Section 8.7 |
| list | | .7.9 |
+---------------+-------------------------------------+-------------+ +---------------+-------------------------------------+-------------+
The abstract description of these commands is defined in Section 6.4.
When a Recipient executes a Directive, it MUST report a result code. When a Recipient executes a Directive, it MUST report a result code.
If the Directive reports failure, then the current Command Sequence If the Directive reports failure, then the current Command Sequence
MUST terminate. MUST terminate.
9.8.4.1. suit-directive-set-component-index 8.7.7.1. suit-directive-set-component-index
Set Component Index defines the component to which successive Set Component Index defines the component to which successive
directives and conditions will apply. The supplied argument MUST be directives and conditions will apply. The supplied argument MUST be
either a boolean or an unsigned integer index into the concatenation either a boolean or an unsigned integer index into suit-components.
of suit-components and suit-dependency-components. If the following If the following directives apply to ALL components, then the boolean
directives apply to ALL components, then the boolean value "True" is value "True" is used instead of an index. If the following
used instead of an index. True does not apply to dependency directives apply to NO components, then the boolean value "False" is
components. If the following directives apply to NO components, then used. When suit-directive-set-dependency-index is used, suit-
the boolean value "False" is used. When suit-directive-set- directive-set-component-index = False is implied. When suit-
dependency-index is used, suit-directive-set-component-index = False directive-set-component-index is used, suit-directive-set-dependency-
is implied. When suit-directive-set-component-index is used, suit- index = False is implied.
directive-set-dependency-index = False is implied.
9.8.4.2. suit-directive-set-dependency-index 8.7.7.2. suit-directive-set-dependency-index
Set Dependency Index defines the manifest to which successive Set Dependency Index defines the manifest to which successive
directives and conditions will apply. The supplied argument MUST be directives and conditions will apply. The supplied argument MUST be
either a boolean or an unsigned integer index into the dependencies. either a boolean or an unsigned integer index into the dependencies.
If the following directives apply to ALL dependencies, then the If the following directives apply to ALL dependencies, then the
boolean value "True" is used instead of an index. If the following boolean value "True" is used instead of an index. If the following
directives apply to NO dependencies, then the boolean value "False" directives apply to NO dependencies, then the boolean value "False"
is used. When suit-directive-set-component-index is used, suit- is used. When suit-directive-set-component-index is used, suit-
directive-set-dependency-index = False is implied. When suit- directive-set-dependency-index = False is implied. When suit-
directive-set-dependency-index is used, suit-directive-set-component- directive-set-dependency-index is used, suit-directive-set-component-
index = False is implied. index = False is implied.
Typical operations that require suit-directive-set-dependency-index Typical operations that require suit-directive-set-dependency-index
include setting a source URI, invoking "Fetch," or invoking "Process include setting a source URI or Encryption Information, invoking
Dependency" for an individual dependency. "Fetch," or invoking "Process Dependency" for an individual
dependency.
9.8.4.3. suit-directive-abort 8.7.7.3. suit-directive-abort
Unconditionally fail. This operation is typically used in Unconditionally fail. This operation is typically used in
conjunction with suit-directive-try-each. conjunction with suit-directive-try-each.
9.8.4.4. suit-directive-try-each 8.7.7.4. suit-directive-try-each
This command runs several SUIT_Command_Sequence, one after another, This command runs several SUIT_Command_Sequence, one after another,
in a strict order. Use this command to implement a "try/catch-try/ in a strict order. Use this command to implement a "try/catch-try/
catch" sequence. Manifest processors MAY implement this command. catch" sequence. Manifest processors MAY implement this command.
SUIT_Parameter_Soft_Failure is initialized to True at the beginning Section 8.7.5.22 is initialized to True at the beginning of each
of each sequence. If one sequence aborts due to a condition failure, sequence. If one sequence aborts due to a condition failure, the
the next is started. If no sequence completes without condition next is started. If no sequence completes without condition failure,
failure, then suit-directive-try-each returns an error. If a then suit-directive-try-each returns an error. If a particular
particular application calls for all sequences to fail and still application calls for all sequences to fail and still continue, then
continue, then an empty sequence (nil) can be added to the Try Each an empty sequence (nil) can be added to the Try Each Argument.
Argument.
9.8.4.5. suit-directive-process-dependency The argument to suit-directive-try-each is a list of
SUIT_Command_Sequence. suit-directive-try-each does not specify a
reporting policy.
8.7.7.5. suit-directive-process-dependency
Execute the commands in the common section of the current dependency, Execute the commands in the common section of the current dependency,
followed by the commands in the equivalent section of the current followed by the commands in the equivalent section of the current
dependency. For example, if the current section is "fetch payload," dependency. For example, if the current section is "fetch payload,"
this will execute "common" in the current dependency, then "fetch this will execute "common" in the current dependency, then "fetch
payload" in the current dependency. Once this is complete, the payload" in the current dependency. Once this is complete, the
command following suit-directive-process-dependency will be command following suit-directive-process-dependency will be
processed. processed.
If the current dependency is False, this directive has no effect. If If the current dependency is False, this directive has no effect. If
the current dependency is True, then this directive applies to all the current dependency is True, then this directive applies to all
dependencies. If the current section is "common," this directive dependencies. If the current section is "common," this directive
MUST have no effect. MUST have no effect.
When SUIT_Process_Dependency completes, it forwards the last status When SUIT_Process_Dependency completes, it forwards the last status
code that occurred in the dependency. code that occurred in the dependency.
9.8.4.6. suit-directive-set-parameters 8.7.7.6. suit-directive-set-parameters
suit-directive-set-parameters allows the manifest to configure suit-directive-set-parameters allows the manifest to configure
behavior of future directives by changing parameters that are read by behavior of future directives by changing parameters that are read by
those directives. When dependencies are used, suit-directive-set- those directives. When dependencies are used, suit-directive-set-
parameters also allows a manifest to modify the behavior of its parameters also allows a manifest to modify the behavior of its
dependencies. dependencies.
Available parameters are defined in Section 9.8.2. Available parameters are defined in Section 8.7.5.
If a parameter is already set, suit-directive-set-parameters will If a parameter is already set, suit-directive-set-parameters will
skip setting the parameter to its argument. This provides the core skip setting the parameter to its argument. This provides the core
of the override mechanism, allowing dependent manifests to change the of the override mechanism, allowing dependent manifests to change the
behavior of a manifest. behavior of a manifest.
9.8.4.7. suit-directive-override-parameters suit-directive-set-parameters does not specify a reporting policy.
8.7.7.7. suit-directive-override-parameters
suit-directive-override-parameters replaces any listed parameters suit-directive-override-parameters replaces any listed parameters
that are already set with the values that are provided in its that are already set with the values that are provided in its
argument. This allows a manifest to prevent replacement of critical argument. This allows a manifest to prevent replacement of critical
parameters. parameters.
Available parameters are defined in Section 9.8.2. Available parameters are defined in Section 8.7.5.
9.8.4.8. suit-directive-fetch suit-directive-override-parameters does not specify a reporting
policy.
8.7.7.8. suit-directive-fetch
suit-directive-fetch instructs the manifest processor to obtain one suit-directive-fetch instructs the manifest processor to obtain one
or more manifests or payloads, as specified by the manifest index and or more manifests or payloads, as specified by the manifest index and
component index, respectively. component index, respectively.
suit-directive-fetch can target one or more manifests and one or more suit-directive-fetch can target one or more manifests and one or more
payloads. suit-directive-fetch retrieves each component and each payloads. suit-directive-fetch retrieves each component and each
manifest listed in component-index and manifest-index, respectively. manifest listed in component-index and dependency-index,
If component-index or manifest-index is True, instead of an integer, respectively. If component-index or dependency-index is True,
then all current manifest components/manifests are fetched. The instead of an integer, then all current manifest components/manifests
current manifest's dependent-components are not automatically are fetched. The current manifest's dependent-components are not
fetched. In order to pre-fetch these, they MUST be specified in a automatically fetched. In order to pre-fetch these, they MUST be
component-index integer. specified in a component-index integer.
suit-directive-fetch typically takes no arguments unless one is suit-directive-fetch typically takes no arguments unless one is
needed to modify fetch behavior. If an argument is needed, it must needed to modify fetch behavior. If an argument is needed, it must
be wrapped in a bstr. be wrapped in a bstr and set in suit-parameter-fetch-arguments.
suit-directive-fetch reads the URI or URI List parameter to find the suit-directive-fetch reads the URI parameter to find the source of
source of the fetch it performs. the fetch it performs.
The behavior of suit-directive-fetch can be modified by setting one The behavior of suit-directive-fetch can be modified by setting one
or more of SUIT_Parameter_Encryption_Info, or more of SUIT_Parameter_Encryption_Info,
SUIT_Parameter_Compression_Info, SUIT_Parameter_Unpack_Info. These SUIT_Parameter_Compression_Info, SUIT_Parameter_Unpack_Info. These
three parameters each activate and configure a processing step that three parameters each activate and configure a processing step that
can be applied to the data that is transferred during suit-directive- can be applied to the data that is transferred during suit-directive-
fetch. fetch.
9.8.4.9. suit-directive-copy 8.7.7.9. suit-directive-fetch-uri-list
suit-directive-fetch-uri-list uses the same semantics as
Section 8.7.7.8, however it iterates over the URI List
(Section 8.7.5.19) to select a URI to fetch from.
8.7.7.10. suit-directive-copy
suit-directive-copy instructs the manifest processor to obtain one or suit-directive-copy instructs the manifest processor to obtain one or
more payloads, as specified by the component index. suit-directive- more payloads, as specified by the component index. suit-directive-
copy retrieves each component listed in component-index, copy retrieves each component listed in component-index,
respectively. If component-index is True, instead of an integer, respectively. If component-index is True, instead of an integer,
then all current manifest components are copied. The current then all current manifest components are copied. The current
manifest's dependent-components are not automatically copied. In manifest's dependent-components are not automatically copied. In
order to copy these, they MUST be specified in a component-index order to copy these, they MUST be specified in a component-index
integer. integer.
The behavior of suit-directive-copy can be modified by setting one or The behavior of suit-directive-copy can be modified by setting one or
more of SUIT_Parameter_Encryption_Info, more of SUIT_Parameter_Encryption_Info,
SUIT_Parameter_Compression_Info, SUIT_Parameter_Unpack_Info. These SUIT_Parameter_Compression_Info, SUIT_Parameter_Unpack_Info. These
three parameters each activate and configure a processing step that three parameters each activate and configure a processing step that
can be applied to the data that is transferred during suit-directive- can be applied to the data that is transferred during suit-directive-
copy. copy.
*N.B.* Fetch and Copy are very similar. Merging them into one suit-directive-copy reads its source from Section 8.7.5.13.
command may be appropriate.
suit-directive-copy reads its source from
SUIT_Parameter_Source_Component.
9.8.4.10. suit-directive-run 8.7.7.11. suit-directive-run
suit-directive-run directs the manifest processor to transfer suit-directive-run directs the manifest processor to transfer
execution to the current Component Index. When this is invoked, the execution to the current Component Index. When this is invoked, the
manifest processor MAY be unloaded and execution continues in the manifest processor MAY be unloaded and execution continues in the
Component Index. Arguments provided to Run are forwarded to the Component Index. Arguments are provided to suit-directive-run
executable code located in Component Index, in an application- through suit-parameter-run-arguments (Section 8.7.5.14) and are
specific way. For example, this could form the Linux Kernel Command forwarded to the executable code located in Component Index in an
Line if booting a Linux device. application-specific way. For example, this could form the Linux
Kernel Command Line if booting a Linux device.
If the executable code at Component Index is constructed in such a If the executable code at Component Index is constructed in such a
way that it does not unload the manifest processor, then the manifest way that it does not unload the manifest processor, then the manifest
processor may resume execution after the executable completes. This processor may resume execution after the executable completes. This
allows the manifest processor to invoke suitable helpers and to allows the manifest processor to invoke suitable helpers and to
verify them with image conditions. verify them with image conditions.
9.8.4.11. suit-directive-wait 8.7.7.12. suit-directive-wait
suit-directive-wait directs the manifest processor to pause until a suit-directive-wait directs the manifest processor to pause until a
specified event occurs. Some possible events include: specified event occurs. Some possible events include:
1. Authorization 1. Authorization
2. External Power 2. External Power
3. Network availability 3. Network availability
4. Other Device Firmware Version 4. Other Device Firmware Version
5. Time 5. Time
6. Time of Day 6. Time of Day
7. Day of Week 7. Day of Week
9.8.4.12. suit-directive-run-sequence 8.7.7.13. suit-directive-run-sequence
To enable conditional commands, and to allow several strictly ordered To enable conditional commands, and to allow several strictly ordered
sequences to be executed out-of-order, suit-directive-run-sequence sequences to be executed out-of-order, suit-directive-run-sequence
allows the manifest processor to execute its argument as a allows the manifest processor to execute its argument as a
SUIT_Command_Sequence. The argument must be wrapped in a bstr. SUIT_Command_Sequence. The argument must be wrapped in a bstr.
When a sequence is executed, any failure of a condition causes When a sequence is executed, any failure of a condition causes
immediate termination of the sequence. immediate termination of the sequence.
When suit-directive-run-sequence completes, it forwards the last When suit-directive-run-sequence completes, it forwards the last
status code that occurred in the sequence. If the Soft Failure status code that occurred in the sequence. If the Soft Failure
parameter is true, then suit-directive-run-sequence only fails when a parameter is true, then suit-directive-run-sequence only fails when a
directive in the argument sequence fails. directive in the argument sequence fails.
SUIT_Parameter_Soft_Failure defaults to False when suit-directive- Section 8.7.5.22 defaults to False when suit-directive-run-sequence
run-sequence begins. Its value is discarded when suit-directive-run- begins. Its value is discarded when suit-directive-run-sequence
sequence terminates. terminates.
9.8.4.13. suit-directive-swap 8.7.7.14. suit-directive-swap
suit-directive-swap instructs the manifest processor to move the suit-directive-swap instructs the manifest processor to move the
source to the destination and the destination to the source source to the destination and the destination to the source
simultaneously. Swap has nearly identical semantics to suit- simultaneously. Swap has nearly identical semantics to suit-
directive-copy except that suit-directive-swap replaces the source directive-copy except that suit-directive-swap replaces the source
with the current contents of the destination in an application- with the current contents of the destination in an application-
defined way. If SUIT_Parameter_Compression_Info or defined way. If SUIT_Parameter_Compression_Info or
SUIT_Parameter_Encryption_Info are present, they must be handled in a SUIT_Parameter_Encryption_Info are present, they MUST be handled in a
symmetric way, so that the source is decompressed into the symmetric way, so that the source is decompressed into the
destination and the destination is compressed into the source. The destination and the destination is compressed into the source. The
source is decrypted into the destination and the destination is source is decrypted into the destination and the destination is
encrypted into the source. suit-directive-swap is OPTIONAL to encrypted into the source. suit-directive-swap is OPTIONAL to
implement. implement.
10. Access Control Lists 8.7.8. Integrity Check Values
When the CoSWID, Text section, or any Command Sequence of the Update
Procedure is made severable, it is moved to the Envelope and replaced
with a SUIT_Digest. The SUIT_Digest is computed over the entire bstr
enclosing the Manifest element that has been moved to the Envelope.
Each element that is made severable from the Manifest is placed in
the Envelope with an identical key, so that it matches the key of the
corresponding Integrity Check Value.
Each Integrity Check Value covers the corresponding Envelope Element
as described in Section 8.8.
8.8. Severable Elements
Because the manifest can be used by different actors at different
times, some parts of the manifest can be removed or "Severed" without
affecting later stages of the lifecycle. Severing of information is
achieved by separating that information from the signed container so
that removing it does not affect the signature. This means that
ensuring integrity of severable parts of the manifest is a
requirement for the signed portion of the manifest. Severing some
parts makes it possible to discard parts of the manifest that are no
longer necessary. This is important because it allows the storage
used by the manifest to be greatly reduced. For example, no text
size limits are needed if text is removed from the manifest prior to
delivery to a constrained device.
Elements are made severable by removing them from the manifest,
encoding them in a bstr, and placing a SUIT_Digest of the bstr in the
manifest so that they can still be authenticated. The SUIT_Digest
typically consumes 4 bytes more than the size of the raw digest,
therefore elements smaller than (Digest Bits)/8 + 4 SHOULD NOT be
severable. Elements larger than (Digest Bits)/8 + 4 MAY be
severable, while elements that are much larger than (Digest Bits)/8 +
4 SHOULD be severable.
Because of this, all command sequences in the manifest are encoded in
a bstr so that there is a single code path needed for all command
sequences.
9. Access Control Lists
To manage permissions in the manifest, there are three models that To manage permissions in the manifest, there are three models that
can be used. can be used.
First, the simplest model requires that all manifests are First, the simplest model requires that all manifests are
authenticated by a single trusted key. This mode has the advantage authenticated by a single trusted key. This mode has the advantage
that only a root manifest needs to be authenticated, since all of its that only a root manifest needs to be authenticated, since all of its
dependencies have digests included in the root manifest. dependencies have digests included in the root manifest.
This simplest model can be extended by adding key delegation without This simplest model can be extended by adding key delegation without
much increase in complexity. much increase in complexity.
A second model requires an ACL to be presented to the device, A second model requires an ACL to be presented to the Recipient,
authenticated by a trusted party or stored on the device. This ACL authenticated by a trusted party or stored on the Recipient. This
grants access rights for specific component IDs or component ID ACL grants access rights for specific component IDs or component ID
prefixes to the listed identities or identity groups. Any identity prefixes to the listed identities or identity groups. Any identity
may verify an image digest, but fetching into or fetching from a may verify an image digest, but fetching into or fetching from a
component ID requires approval from the ACL. component ID requires approval from the ACL.
A third model allows a device to provide even more fine-grained A third model allows a Recipient to provide even more fine-grained
controls: The ACL lists the component ID or component ID prefix that controls: The ACL lists the component ID or component ID prefix that
an identity may use, and also lists the commands that the identity an identity may use, and also lists the commands that the identity
may use in combination with that component ID. may use in combination with that component ID.
11. SUIT Digest Container 10. SUIT Digest Container
RFC 8152 [RFC8152] provides containers for signature, MAC, and RFC 8152 [RFC8152] provides containers for signature, MAC, and
encryption, but no basic digest container. The container needed for encryption, but no basic digest container. The container needed for
a digest requires a type identifier and a container for the raw a digest requires a type identifier and a container for the raw
digest data. Some forms of digest may require additional parameters. digest data. Some forms of digest may require additional parameters.
These can be added following the digest. These can be added following the digest.
The algorithms listed are sufficient for verifying integrity of The SUIT digest is a CBOR List containing two elements: a suit-
Firmware Updates as of this writing, however this may change over digest-algorithm-id and a bstr containing the bytes of the digest.
time.
12. Creating Conditional Sequences 11. IANA Considerations
For some use cases, it is important to provide a sequence that can IANA is requested to:
fail without terminating an update. For example, a dual-image XIP
MCU may require an update that can be placed at one of two offsets.
This has two implications, first, the digest of each offset will be
different. Second, the image fetched for each offset will have a
different URI. Conditional sequences allow this to be resolved in a
simple way.
The following JSON representation of a manifest demonstrates how this - allocate a CBOR tag for the SUIT Envelope and another for the SUIT
would be represented. It assumes that the bootloader and manifest Manifest.
processor take care of A/B switching and that the manifest is not
aware of this distinction.
{ - allocate a media type for suit: application/suit-envelope
"structure-version" : 1,
"sequence-number" : 7,
"common" :{
"components" : [
[b'0']
],
"common-sequence" : [
{
"directive-set-var" : {
"size": 32567
},
},
{
"try-each" : [
[
{"condition-component-offset" : "<offset A>"},
{
"directive-set-var": {
"digest" : "<SHA256 A>"
}
}
],
[
{"condition-component-offset" : "<offset B>"},
{
"directive-set-var": {
"digest" : "<SHA256 B>"
}
}
],
[{ "abort" : null }]
]
}
]
}
"fetch" : [
{
"try-each" : [
[
{"condition-component-offset" : "<offset A>"},
{
"directive-set-var": {
"uri" : "<URI A>"
}
}
],
[
{"condition-component-offset" : "<offset B>"},
{
"directive-set-var": {
"uri" : "<URI B>"
}
}
],
[{ "directive-abort" : null }]
]
},
"fetch" : null
]
}
13. IANA Considerations - setup several registries as described below
IANA is requested to setup a registry for SUIT manifests. Several IANA is requested to setup a registry for SUIT manifests. Several
registries defined in the subsections below need to be created. registries defined in the subsections below need to be created.
For each registry, values 0-23 are Standards Action, 24-255 are IETF For each registry, values 0-23 are Standards Action, 24-255 are IETF
Review, 256-65535 are Expert Review, and 65536 or greater are First Review, 256-65535 are Expert Review, and 65536 or greater are First
Come First Served. Come First Served.
Negative values -23 to 0 are Experimental Use, -24 and lower are Negative values -23 to 0 are Experimental Use, -24 and lower are
Private Use. Private Use.
13.1. SUIT Directives 11.1. SUIT Commands
+-------+----------------------+ +-------+----------------------+
| Label | Name | | Label | Name |
+-------+----------------------+ +-------+----------------------+
| 1 | Vendor Identifier |
| | |
| 2 | Class Identifier |
| | |
| 3 | Image Match |
| | |
| 4 | Use Before |
| | |
| 5 | Component Offset |
| | |
| 12 | Set Component Index | | 12 | Set Component Index |
| | | | | |
| 13 | Set Dependency Index | | 13 | Set Dependency Index |
| | | | | |
| 14 | Abort | | 14 | Abort |
| | | | | |
| 15 | Try Each | | 15 | Try Each |
| | | | | |
| 16 | Reserved | | 16 | Reserved |
| | | | | |
skipping to change at page 45, line 46 skipping to change at page 63, line 44
| 19 | Set Parameters | | 19 | Set Parameters |
| | | | | |
| 20 | Override Parameters | | 20 | Override Parameters |
| | | | | |
| 21 | Fetch | | 21 | Fetch |
| | | | | |
| 22 | Copy | | 22 | Copy |
| | | | | |
| 23 | Run | | 23 | Run |
| | | | | |
| 24 | Device Identifier |
| | |
| 25 | Image Not Match |
| | |
| 26 | Minimum Battery |
| | |
| 27 | Update Authorized |
| | |
| 28 | Version |
| | |
| 29 | Wait For Event | | 29 | Wait For Event |
| | | | | |
| 30 | Run Sequence | | 30 | Fetch URI List |
| | | | | |
| 32 | Swap | | 31 | Swap |
| | |
| 32 | Run Sequence |
| | |
| nint | Custom Condition |
+-------+----------------------+ +-------+----------------------+
13.2. SUIT Conditions 11.2. SUIT Parameters
+-------+-------------------+
| Label | Name |
+-------+-------------------+
| 1 | Vendor Identifier |
| | |
| 2 | Class Identifier |
| | |
| 24 | Device Identifier |
| | |
| 3 | Image Match |
| | |
| 25 | Image Not Match |
| | |
| 4 | Use Before |
| | |
| 5 | Component Offset |
| | |
| 26 | Minimum Battery |
| | |
| 27 | Update Authorized |
| | |
| 28 | Version |
| | |
| nint | Custom Condition |
+-------+-------------------+
13.3. SUIT Parameters
+-------+------------------+ +-------+------------------+
| Label | Name | | Label | Name |
+-------+------------------+ +-------+------------------+
| 1 | Vendor ID | | 1 | Vendor ID |
| | | | | |
| 2 | Class ID | | 2 | Class ID |
| | | | | |
| 3 | Image Digest | | 3 | Image Digest |
| | | | | |
| 4 | Use Before | | 4 | Use Before |
skipping to change at page 48, line 5 skipping to change at page 66, line 5
| | | | | |
| 29 | Wait Info | | 29 | Wait Info |
| | | | | |
| 30 | URI List | | 30 | URI List |
| | | | | |
| 31 | Component Index | | 31 | Component Index |
| | | | | |
| nint | Custom | | nint | Custom |
+-------+------------------+ +-------+------------------+
13.4. SUIT Text Values 11.3. SUIT Text Values
+-------+--------------------------------+ +-------+----------------------+
| Label | Name | | Label | Name |
+-------+--------------------------------+ +-------+----------------------+
| 1 | Manifest Description | | 1 | Manifest Description |
| | | | | |
| 2 | Update Description | | 2 | Update Description |
| | | | | |
| 3 | Vendor Name | | 3 | Manifest JSON Source |
| | | | | |
| 4 | Model Name | | 4 | Manifest YAML Source |
| | | | | |
| 5 | Vendor Domain | | nint | Custom |
| | | +-------+----------------------+
| 6 | Model Info |
| | |
| 7 | Component Description |
| | |
| 8 | Manifest JSON Source |
| | |
| 9 | Manifest YAML Source |
| | |
| 10 | Component Version Dependencies |
+-------+--------------------------------+
13.5. SUIT Algorithm Identifiers 11.4. SUIT Component Text Values
13.5.1. Hash Algorithms +-------+----------------------------+
| Label | Name |
+-------+----------------------------+
| 1 | Vendor Name |
| | |
| 2 | Model Name |
| | |
| 3 | Vendor Domain |
| | |
| 4 | Model Info |
| | |
| 5 | Component Description |
| | |
| 6 | Component Version |
| | |
| 7 | Component Version Required |
| | |
| nint | Custom |
+-------+----------------------------+
11.5. SUIT Algorithm Identifiers
11.5.1. SUIT Digest Algorithm Identifiers
+-------+----------+ +-------+----------+
| Label | Name | | Label | Name |
+-------+----------+ +-------+----------+
| 1 | SHA224 | | 1 | SHA224 |
| | | | | |
| 2 | SHA256 | | 2 | SHA256 |
| | | | | |
| 3 | SHA384 | | 3 | SHA384 |
| | | | | |
| 4 | SHA512 | | 4 | SHA512 |
| | | | | |
| 5 | SHA3-224 | | 5 | SHA3-224 |
| | | | | |
| 6 | SHA3-256 | | 6 | SHA3-256 |
| | | | | |
| 7 | SHA3-384 | | 7 | SHA3-384 |
| | | | | |
| 8 | SHA3-512 | | 8 | SHA3-512 |
+-------+----------+ +-------+----------+
13.5.2. Unpack Algorithms 11.5.2. SUIT Compression Algorithm Identifiers
+-------+--------+
| Label | Name |
+-------+--------+
| 1 | zlib |
| | |
| 2 | Brotli |
| | |
| 3 | zstd |
+-------+--------+
11.5.3. Unpack Algorithms
+-------+------+ +-------+------+
| Label | Name | | Label | Name |
+-------+------+ +-------+------+
| 1 | HEX | | 1 | HEX |
| | | | | |
| 2 | ELF | | 2 | ELF |
| | | | | |
| 3 | COFF | | 3 | COFF |
| | | | | |
| 4 | SREC | | 4 | SREC |
+-------+------+ +-------+------+
14. Security Considerations 12. Security Considerations
This document is about a manifest format describing and protecting This document is about a manifest format describing and protecting
firmware images and as such it is part of a larger solution for firmware images and as such it is part of a larger solution for
offering a standardized way of delivering firmware updates to IoT offering a standardized way of delivering firmware updates to IoT
devices. A detailed security treatment can be found in the devices. A detailed security treatment can be found in the
architecture [I-D.ietf-suit-architecture] and in the information architecture [I-D.ietf-suit-architecture] and in the information
model [I-D.ietf-suit-information-model] documents. model [I-D.ietf-suit-information-model] documents.
15. Acknowledgements 13. Acknowledgements
We would like to thank the following persons for their support in We would like to thank the following persons for their support in
designing this mechanism: designing this mechanism:
- Milosch Meriac - Milosch Meriac
- Geraint Luff - Geraint Luff
- Dan Ros - Dan Ros
skipping to change at page 50, line 31 skipping to change at page 68, line 45
- Krzysztof Chru&#347;ci&#324;ski - Krzysztof Chru&#347;ci&#324;ski
- Andrzej Puzdrowski - Andrzej Puzdrowski
- Michael Richardson - Michael Richardson
- David Brown - David Brown
- Emmanuel Baccelli - Emmanuel Baccelli
16. References 14. References
16.1. Normative References 14.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997, DOI 10.17487/RFC2119, March 1997,
<https://www.rfc-editor.org/info/rfc2119>. <https://www.rfc-editor.org/info/rfc2119>.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, DOI 10.17487/RFC3986, January 2005,
<https://www.rfc-editor.org/info/rfc3986>.
[RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally [RFC4122] Leach, P., Mealling, M., and R. Salz, "A Universally
Unique IDentifier (UUID) URN Namespace", RFC 4122, Unique IDentifier (UUID) URN Namespace", RFC 4122,
DOI 10.17487/RFC4122, July 2005, DOI 10.17487/RFC4122, July 2005,
<https://www.rfc-editor.org/info/rfc4122>. <https://www.rfc-editor.org/info/rfc4122>.
[RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)", [RFC8152] Schaad, J., "CBOR Object Signing and Encryption (COSE)",
RFC 8152, DOI 10.17487/RFC8152, July 2017, RFC 8152, DOI 10.17487/RFC8152, July 2017,
<https://www.rfc-editor.org/info/rfc8152>. <https://www.rfc-editor.org/info/rfc8152>.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
May 2017, <https://www.rfc-editor.org/info/rfc8174>. May 2017, <https://www.rfc-editor.org/info/rfc8174>.
16.2. Informative References 14.2. Informative References
[COFF] Wikipedia, ., "Common Object File Format (COFF)", 2020, [COFF] Wikipedia, ., "Common Object File Format (COFF)", 2020,
<https://en.wikipedia.org/wiki/COFF>. <https://en.wikipedia.org/wiki/COFF>.
[ELF] Wikipedia, ., "Executable and Linkable Format (ELF)", [ELF] Wikipedia, ., "Executable and Linkable Format (ELF)",
2020, <https://en.wikipedia.org/wiki/ 2020, <https://en.wikipedia.org/wiki/
Executable_and_Linkable_Format>. Executable_and_Linkable_Format>.
[HEX] Wikipedia, ., "Intel HEX", 2020, [HEX] Wikipedia, ., "Intel HEX", 2020,
<https://en.wikipedia.org/wiki/Intel_HEX>. <https://en.wikipedia.org/wiki/Intel_HEX>.
skipping to change at page 51, line 32 skipping to change at page 69, line 50
[I-D.ietf-suit-information-model] [I-D.ietf-suit-information-model]
Moran, B., Tschofenig, H., and H. Birkholz, "An Moran, B., Tschofenig, H., and H. Birkholz, "An
Information Model for Firmware Updates in IoT Devices", Information Model for Firmware Updates in IoT Devices",
draft-ietf-suit-information-model-07 (work in progress), draft-ietf-suit-information-model-07 (work in progress),
June 2020. June 2020.
[I-D.ietf-teep-architecture] [I-D.ietf-teep-architecture]
Pei, M., Tschofenig, H., Thaler, D., and D. Wheeler, Pei, M., Tschofenig, H., Thaler, D., and D. Wheeler,
"Trusted Execution Environment Provisioning (TEEP) "Trusted Execution Environment Provisioning (TEEP)
Architecture", draft-ietf-teep-architecture-08 (work in Architecture", draft-ietf-teep-architecture-11 (work in
progress), April 2020. progress), July 2020.
[I-D.kucherawy-rfc8478bis] [I-D.kucherawy-rfc8478bis]
Collet, Y. and M. Kucherawy, "Zstandard Compression and Collet, Y. and M. Kucherawy, "Zstandard Compression and
the application/zstd Media Type", draft-kucherawy- the application/zstd Media Type", draft-kucherawy-
rfc8478bis-05 (work in progress), April 2020. rfc8478bis-05 (work in progress), April 2020.
[RFC1950] Deutsch, P. and J-L. Gailly, "ZLIB Compressed Data Format [RFC1950] Deutsch, P. and J-L. Gailly, "ZLIB Compressed Data Format
Specification version 3.3", RFC 1950, Specification version 3.3", RFC 1950,
DOI 10.17487/RFC1950, May 1996, DOI 10.17487/RFC1950, May 1996,
<https://www.rfc-editor.org/info/rfc1950>. <https://www.rfc-editor.org/info/rfc1950>.
[RFC7228] Bormann, C., Ersue, M., and A. Keranen, "Terminology for
Constrained-Node Networks", RFC 7228,
DOI 10.17487/RFC7228, May 2014,
<https://www.rfc-editor.org/info/rfc7228>.
[RFC7932] Alakuijala, J. and Z. Szabadka, "Brotli Compressed Data [RFC7932] Alakuijala, J. and Z. Szabadka, "Brotli Compressed Data
Format", RFC 7932, DOI 10.17487/RFC7932, July 2016, Format", RFC 7932, DOI 10.17487/RFC7932, July 2016,
<https://www.rfc-editor.org/info/rfc7932>. <https://www.rfc-editor.org/info/rfc7932>.
[RFC8392] Jones, M., Wahlstroem, E., Erdtman, S., and H. Tschofenig, [RFC8392] Jones, M., Wahlstroem, E., Erdtman, S., and H. Tschofenig,
"CBOR Web Token (CWT)", RFC 8392, DOI 10.17487/RFC8392, "CBOR Web Token (CWT)", RFC 8392, DOI 10.17487/RFC8392,
May 2018, <https://www.rfc-editor.org/info/rfc8392>. May 2018, <https://www.rfc-editor.org/info/rfc8392>.
[RFC8747] Jones, M., Seitz, L., Selander, G., Erdtman, S., and H.
Tschofenig, "Proof-of-Possession Key Semantics for CBOR
Web Tokens (CWTs)", RFC 8747, DOI 10.17487/RFC8747, March
2020, <https://www.rfc-editor.org/info/rfc8747>.
[SREC] Wikipedia, ., "SREC (file format)", 2020, [SREC] Wikipedia, ., "SREC (file format)", 2020,
<https://en.wikipedia.org/wiki/SREC_(file_format)>. <https://en.wikipedia.org/wiki/SREC_(file_format)>.
14.3. URIs
[1] suit-condition-update-authorized
A. Full CDDL A. Full CDDL
In order to create a valid SUIT Manifest document the structure of In order to create a valid SUIT Manifest document the structure of
the corresponding CBOR message MUST adhere to the following CDDL data the corresponding CBOR message MUST adhere to the following CDDL data
definition. definition.
SUIT_Envelope = { SUIT_Envelope = {
? suit-delegation => bstr .cbor SUIT_Delegation ? suit-delegation => bstr .cbor SUIT_Delegation,
? suit-authentication-wrapper ? suit-authentication-wrapper => bstr .cbor SUIT_Authentication,
=> bstr .cbor SUIT_Authentication_Wrapper / nil, suit-manifest => bstr .cbor SUIT_Manifest,
$$SUIT_Manifest_Wrapped, SUIT_Severable_Manifest_Members,
* $$SUIT_Severed_Fields, * $$SUIT_Envelope_Extensions,
(int => bstr)
} }
SUIT_Delegation = [ + [ + CWT ] ] SUIT_Delegation = [ + [ + bstr .cbor CWT ] ]
CWT = SUIT_Authentication_Block CWT = SUIT_Authentication_Block
SUIT_Authentication_Wrapper = [ + bstr .cbor SUIT_Authentication_Block ] SUIT_Authentication = [ + bstr .cbor SUIT_Authentication_Block ]
SUIT_Authentication_Block /= COSE_Mac_Tagged SUIT_Authentication_Block /= COSE_Mac_Tagged
SUIT_Authentication_Block /= COSE_Sign_Tagged SUIT_Authentication_Block /= COSE_Sign_Tagged
SUIT_Authentication_Block /= COSE_Mac0_Tagged SUIT_Authentication_Block /= COSE_Mac0_Tagged
SUIT_Authentication_Block /= COSE_Sign1_Tagged SUIT_Authentication_Block /= COSE_Sign1_Tagged
$$SUIT_Manifest_Wrapped //= (suit-manifest => bstr .cbor SUIT_Manifest) SUIT_Severable_Manifest_Members = (
$$SUIT_Manifest_Wrapped //= ( ? suit-dependency-resolution => bstr .cbor SUIT_Command_Sequence,
suit-manifest-encryption-info => bstr .cbor SUIT_Encryption_Wrapper, ? suit-payload-fetch => bstr .cbor SUIT_Command_Sequence,
suit-manifest-encrypted => bstr ? suit-install => bstr .cbor SUIT_Command_Sequence,
? suit-text => bstr .cbor SUIT_Text_Map,
? suit-coswid => bstr .cbor concise-software-identity,
* $$SUIT_severable-members-extensions,
) )
SUIT_Encryption_Wrapper = COSE_Encrypt_Tagged / COSE_Encrypt0_Tagged
$$SUIT_Severed_Fields //= ( suit-dependency-resolution =>
bstr .cbor SUIT_Command_Sequence)
$$SUIT_Severed_Fields //= (suit-payload-fetch =>
bstr .cbor SUIT_Command_Sequence)
$$SUIT_Severed_Fields //= (suit-install =>
bstr .cbor SUIT_Command_Sequence)
$$SUIT_Severed_Fields //= (suit-text =>
bstr .cbor SUIT_Text_Map)
$$SUIT_Severed_Fields //= (suit-coswid =>
bstr .cbor concise-software-identity)
COSE_Mac_Tagged = any COSE_Mac_Tagged = any
COSE_Sign_Tagged = any COSE_Sign_Tagged = any
COSE_Mac0_Tagged = any COSE_Mac0_Tagged = any
COSE_Sign1_Tagged = any COSE_Sign1_Tagged = any
COSE_Encrypt_Tagged = any COSE_Encrypt_Tagged = any
COSE_Encrypt0_Tagged = any COSE_Encrypt0_Tagged = any
SUIT_Digest = [ SUIT_Digest = [
suit-digest-algorithm-id : suit-digest-algorithm-ids, suit-digest-algorithm-id : suit-digest-algorithm-ids,
suit-digest-bytes : bstr, suit-digest-bytes : bstr,
? suit-digest-parameters : any * $$SUIT_Digest-extensions
] ]
; Named Information Hash Algorithm Identifiers ; Named Information Hash Algorithm Identifiers
suit-digest-algorithm-ids /= algorithm-id-sha224 suit-digest-algorithm-ids /= algorithm-id-sha224
suit-digest-algorithm-ids /= algorithm-id-sha256 suit-digest-algorithm-ids /= algorithm-id-sha256
suit-digest-algorithm-ids /= algorithm-id-sha384 suit-digest-algorithm-ids /= algorithm-id-sha384
suit-digest-algorithm-ids /= algorithm-id-sha512 suit-digest-algorithm-ids /= algorithm-id-sha512
suit-digest-algorithm-ids /= algorithm-id-sha3-224 suit-digest-algorithm-ids /= algorithm-id-sha3-224
suit-digest-algorithm-ids /= algorithm-id-sha3-256 suit-digest-algorithm-ids /= algorithm-id-sha3-256
suit-digest-algorithm-ids /= algorithm-id-sha3-384 suit-digest-algorithm-ids /= algorithm-id-sha3-384
suit-digest-algorithm-ids /= algorithm-id-sha3-512 suit-digest-algorithm-ids /= algorithm-id-sha3-512
skipping to change at page 54, line 36 skipping to change at page 72, line 27
algorithm-id-sha512 = 4 algorithm-id-sha512 = 4
algorithm-id-sha3-224 = 5 algorithm-id-sha3-224 = 5
algorithm-id-sha3-256 = 6 algorithm-id-sha3-256 = 6
algorithm-id-sha3-384 = 7 algorithm-id-sha3-384 = 7
algorithm-id-sha3-512 = 8 algorithm-id-sha3-512 = 8
SUIT_Manifest = { SUIT_Manifest = {
suit-manifest-version => 1, suit-manifest-version => 1,
suit-manifest-sequence-number => uint, suit-manifest-sequence-number => uint,
suit-common => bstr .cbor SUIT_Common, suit-common => bstr .cbor SUIT_Common,
? suit-reference-uri => #6.32(tstr), ? suit-reference-uri => tstr,
* $$SUIT_Severable_Command_Sequences, SUIT_Severable_Members,
* $$SUIT_Command_Sequences, SUIT_Severable_Members_Digests,
* $$SUIT_Protected_Elements, SUIT_Unseverable_Members,
* $$SUIT_Manifest_Extensions,
} }
$$SUIT_Severable_Command_Sequences //= (suit-dependency-resolution => SUIT_Unseverable_Members = (
SUIT_Severable_Command_Sequence) ? suit-validate => bstr .cbor SUIT_Command_Sequence,
$$SUIT_Severable_Command_Sequences //= (suit-payload-fetch => ? suit-load => bstr .cbor SUIT_Command_Sequence,
SUIT_Severable_Command_Sequence) ? suit-run => bstr .cbor SUIT_Command_Sequence,
$$SUIT_Severable_Command_Sequences //= (suit-install => * $$unserverble-manifest-member-extensions,
SUIT_Severable_Command_Sequence) )
SUIT_Severable_Command_Sequence =
SUIT_Digest / bstr .cbor SUIT_Command_Sequence
$$SUIT_Command_Sequences //= ( suit-validate =>
bstr .cbor SUIT_Command_Sequence )
$$SUIT_Command_Sequences //= ( suit-load =>
bstr .cbor SUIT_Command_Sequence )
$$SUIT_Command_Sequences //= ( suit-run =>
bstr .cbor SUIT_Command_Sequence )
$$SUIT_Protected_Elements //= ( suit-text => SUIT_Digest ) SUIT_Severable_Members_Digests = (
$$SUIT_Protected_Elements //= ( suit-coswid => SUIT_Digest ) ? suit-dependency-resolution-digest => SUIT_Digest,
? suit-payload-fetch-digest => SUIT_Digest,
? suit-install-digest => SUIT_Digest,
? suit-text-digest => SUIT_Digest,
? suit-coswid-digest => SUIT_Digest,
* $$severable-manifest-members-digests-extensions
)
SUIT_Common = { SUIT_Common = {
? suit-dependencies => bstr .cbor SUIT_Dependencies, ? suit-dependencies => SUIT_Dependencies,
? suit-components => bstr .cbor SUIT_Components, ? suit-components => SUIT_Components,
? suit-dependency-components ? suit-common-sequence => bstr .cbor SUIT_Common_Sequence,
=> bstr .cbor SUIT_Component_References, * $$SUIT_Common-extensions,
? suit-common-sequence => bstr .cbor SUIT_Command_Sequence,
} }
SUIT_Dependencies = [ + SUIT_Dependency ] SUIT_Dependencies = [ + SUIT_Dependency ]
SUIT_Components = [ + SUIT_Component_Identifier ] SUIT_Components = [ + SUIT_Component_Identifier ]
SUIT_Component_References = [ + SUIT_Component_Reference ]
concise-software-identity = any concise-software-identity = any
SUIT_Dependency = { SUIT_Dependency = {
suit-dependency-digest => SUIT_Digest, suit-dependency-digest => SUIT_Digest,
suit-dependency-prefix => SUIT_Component_Identifier, ? suit-dependency-prefix => SUIT_Component_Identifier,
* $$SUIT_Dependency-extensions,
} }
SUIT_Component_Identifier = [* bstr] SUIT_Component_Identifier = [* bstr]
SUIT_Component_Reference = { SUIT_Component_Reference = {
suit-component-identifier => SUIT_Component_Identifier, suit-component-identifier => SUIT_Component_Identifier,
suit-component-dependency-index => uint suit-component-dependency-index => uint
} }
SUIT_Common_Sequence = [
+ ( SUIT_Condition // SUIT_Common_Commands )
]
SUIT_Common_Commands //= (suit-directive-set-component-index, uint/bool)
SUIT_Common_Commands //= (suit-directive-set-dependency-index, uint/bool)
SUIT_Common_Commands //= (suit-directive-run-sequence,
bstr .cbor SUIT_Command_Sequence)
SUIT_Common_Commands //= (suit-directive-try-each,
SUIT_Directive_Try_Each_Argument)
SUIT_Common_Commands //= (suit-directive-set-parameters,
{+ SUIT_Parameters})
SUIT_Common_Commands //= (suit-directive-override-parameters,
{+ SUIT_Parameters})
SUIT_Command_Sequence = [ + ( SUIT_Command_Sequence = [ + (
SUIT_Condition // SUIT_Directive // SUIT_Command_Custom SUIT_Condition // SUIT_Directive // SUIT_Command_Custom
) ] ) ]
SUIT_Command_Custom = (suit-command-custom, bstr/tstr/int/nil) SUIT_Command_Custom = (suit-command-custom, bstr/tstr/int/nil)
SUIT_Condition //= (suit-condition-vendor-identifier, nil) SUIT_Condition //= (suit-condition-vendor-identifier, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-class-identifier, nil) SUIT_Condition //= (suit-condition-class-identifier, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-device-identifier, nil) SUIT_Condition //= (suit-condition-device-identifier, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-image-match, nil) SUIT_Condition //= (suit-condition-image-match, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-image-not-match, nil) SUIT_Condition //= (suit-condition-image-not-match, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-use-before, nil) SUIT_Condition //= (suit-condition-use-before, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-minimum-battery, nil) SUIT_Condition //= (suit-condition-minimum-battery, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-update-authorized, nil) SUIT_Condition //= (suit-condition-update-authorized, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-version, nil) SUIT_Condition //= (suit-condition-version, SUIT_Reporting_Policy)
SUIT_Condition //= (suit-condition-component-offset, nil) SUIT_Condition //= (suit-condition-component-offset, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-set-component-index, uint/bool) SUIT_Directive //= (suit-directive-set-component-index, uint/bool)
SUIT_Directive //= (suit-directive-set-dependency-index, uint/bool) SUIT_Directive //= (suit-directive-set-dependency-index, uint/bool)
SUIT_Directive //= (suit-directive-run-sequence, SUIT_Directive //= (suit-directive-run-sequence,
bstr .cbor SUIT_Command_Sequence) bstr .cbor SUIT_Command_Sequence)
SUIT_Directive //= (suit-directive-try-each, SUIT_Directive //= (suit-directive-try-each,
SUIT_Directive_Try_Each_Argument) SUIT_Directive_Try_Each_Argument)
SUIT_Directive //= (suit-directive-process-dependency, nil) SUIT_Directive //= (suit-directive-process-dependency, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-set-parameters, SUIT_Directive //= (suit-directive-set-parameters,
{+ SUIT_Parameters}) {+ SUIT_Parameters})
SUIT_Directive //= (suit-directive-override-parameters, SUIT_Directive //= (suit-directive-override-parameters,
{+ SUIT_Parameters}) {+ SUIT_Parameters})
SUIT_Directive //= (suit-directive-fetch, nil) SUIT_Directive //= (suit-directive-fetch, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-copy, nil) SUIT_Directive //= (suit-directive-copy, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-swap, nil) SUIT_Directive //= (suit-directive-swap, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-run, nil) SUIT_Directive //= (suit-directive-run, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-wait, nil) SUIT_Directive //= (suit-directive-wait, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-abort, nil) SUIT_Directive //= (suit-directive-abort, SUIT_Reporting_Policy)
SUIT_Directive //= (suit-directive-fetch-uri-list, SUIT_Reporting_Policy)
SUIT_Directive_Try_Each_Argument = [ SUIT_Directive_Try_Each_Argument = [
+ bstr .cbor SUIT_Command_Sequence, + bstr .cbor SUIT_Command_Sequence,
nil / bstr .cbor SUIT_Command_Sequence nil / bstr .cbor SUIT_Command_Sequence
] ]
SUIT_Reporting_Policy = uint .bits suit-reporting-bits
suit-reporting-bits = &(
suit-send-record-success : 0,
suit-send-record-failure : 1,
suit-send-sysinfo-success : 2,
suit-send-sysinfo-failure : 3
)
SUIT_Command_ID /= suit-command-custom
SUIT_Command_ID /= suit-condition-vendor-identifier
SUIT_Command_ID /= suit-condition-class-identifier
SUIT_Command_ID /= suit-condition-image-match
SUIT_Command_ID /= suit-condition-use-before
SUIT_Command_ID /= suit-condition-component-offset
SUIT_Command_ID /= suit-condition-device-identifier
SUIT_Command_ID /= suit-condition-image-not-match
SUIT_Command_ID /= suit-condition-minimum-battery
SUIT_Command_ID /= suit-condition-update-authorized
SUIT_Command_ID /= suit-condition-version
SUIT_Command_ID /= suit-directive-set-component-index
SUIT_Command_ID /= suit-directive-set-dependency-index
SUIT_Command_ID /= suit-directive-abort
SUIT_Command_ID /= suit-directive-try-each
;SUIT_Command_ID /= suit-directive-do-each
;SUIT_Command_ID /= suit-directive-map-filter
SUIT_Command_ID /= suit-directive-process-dependency
SUIT_Command_ID /= suit-directive-set-parameters
SUIT_Command_ID /= suit-directive-override-parameters
SUIT_Command_ID /= suit-directive-fetch
SUIT_Command_ID /= suit-directive-copy
SUIT_Command_ID /= suit-directive-run
SUIT_Command_ID /= suit-directive-wait
SUIT_Command_ID /= suit-directive-run-sequence
SUIT_Command_ID /= suit-directive-swap
SUIT_Command_ID /= suit-directive-fetch-uri-list
suit-record = {
suit-record-success => bool/int,
? suit-record-component-id => SUIT_Component_ID,
? suit-record-dependency-id => SUIT_Digest,
? suit-record-command-sequence-id => (
suit-common-sequence /
suit-dependency-resolution /
suit-payload-fetch /
suit-install /
suit-validate /
suit-load /
suit-run /
* $$suit-command-sequence-list-extensions
),
? suit-record-interpeter-offset => uint,
? suit-record-command-id => SUIT_Command_ID,
? suit-record-params => SUIT_Parameters,
? suit-record-actual => SUIT_Parameters,
* $$suit-record-extensions
}
SUIT_Wait_Event = { + SUIT_Wait_Events } SUIT_Wait_Event = { + SUIT_Wait_Events }
SUIT_Wait_Events //= (suit-wait-event-authorization => int) SUIT_Wait_Events //= (suit-wait-event-authorization => int)
SUIT_Wait_Events //= (suit-wait-event-power => int) SUIT_Wait_Events //= (suit-wait-event-power => int)
SUIT_Wait_Events //= (suit-wait-event-network => int) SUIT_Wait_Events //= (suit-wait-event-network => int)
SUIT_Wait_Events //= (suit-wait-event-other-device-version SUIT_Wait_Events //= (suit-wait-event-other-device-version
=> SUIT_Wait_Event_Argument_Other_Device_Version) => SUIT_Wait_Event_Argument_Other_Device_Version)
SUIT_Wait_Events //= (suit-wait-event-time => uint); Timestamp SUIT_Wait_Events //= (suit-wait-event-time => uint); Timestamp
SUIT_Wait_Events //= (suit-wait-event-time-of-day SUIT_Wait_Events //= (suit-wait-event-time-of-day
=> uint); Time of Day (seconds since 00:00:00) => uint); Time of Day (seconds since 00:00:00)
SUIT_Wait_Events //= (suit-wait-event-day-of-week SUIT_Wait_Events //= (suit-wait-event-day-of-week
=> uint); Days since Sunday => uint); Days since Sunday
SUIT_Wait_Event_Argument_Other_Device_Version = [ SUIT_Wait_Event_Argument_Other_Device_Version = [
other-device: bstr, other-device: bstr,
other-device-version: [+int] other-device-version: [ + SUIT_Parameter_Version_Match ]
] ]
SUIT_Parameters //= (suit-parameter-vendor-identifier => RFC4122_UUID) SUIT_Parameters //= (suit-parameter-vendor-identifier => RFC4122_UUID)
SUIT_Parameters //= (suit-parameter-class-identifier => RFC4122_UUID) SUIT_Parameters //= (suit-parameter-class-identifier => RFC4122_UUID)
SUIT_Parameters //= (suit-parameter-image-digest SUIT_Parameters //= (suit-parameter-image-digest
=> bstr .cbor SUIT_Digest) => bstr .cbor SUIT_Digest)
SUIT_Parameters //= (suit-parameter-image-size => uint) SUIT_Parameters //= (suit-parameter-image-size => uint)
SUIT_Parameters //= (suit-parameter-use-before => uint) SUIT_Parameters //= (suit-parameter-use-before => uint)
SUIT_Parameters //= (suit-parameter-component-offset => uint) SUIT_Parameters //= (suit-parameter-component-offset => uint)
skipping to change at page 57, line 34 skipping to change at page 76, line 48
SUIT_Parameters //= (suit-parameter-version => SUIT_Parameters //= (suit-parameter-version =>
SUIT_Parameter_Version_Match) SUIT_Parameter_Version_Match)
SUIT_Parameters //= (suit-parameter-wait-info => SUIT_Parameters //= (suit-parameter-wait-info =>
bstr .cbor SUIT_Wait_Event) bstr .cbor SUIT_Wait_Event)
SUIT_Parameters //= (suit-parameter-custom => int/bool/tstr/bstr) SUIT_Parameters //= (suit-parameter-custom => int/bool/tstr/bstr)
SUIT_Parameters //= (suit-parameter-strict-order => bool) SUIT_Parameters //= (suit-parameter-strict-order => bool)
SUIT_Parameters //= (suit-parameter-soft-failure => bool) SUIT_Parameters //= (suit-parameter-soft-failure => bool)
RFC4122_UUID = bstr .size 16 SUIT_Parameters //= (suit-parameter-uri-list =>
bstr .cbor SUIT_URI_List)
RFC4122_UUID = bstr .size 16
SUIT_Parameter_Version_Match = [ SUIT_Parameter_Version_Match = [
suit-condition-version-comparison-type: suit-condition-version-comparison-type:
SUIT_Condition_Version_Comparison_Types, SUIT_Condition_Version_Comparison_Types,
suit-condition-version-comparison-value: suit-condition-version-comparison-value:
SUIT_Condition_Version_Comparison_Value SUIT_Condition_Version_Comparison_Value
] ]
SUIT_Condition_Version_Comparison_Types /= SUIT_Condition_Version_Comparison_Types /=
suit-condition-version-comparison-greater suit-condition-version-comparison-greater
SUIT_Condition_Version_Comparison_Types /= SUIT_Condition_Version_Comparison_Types /=
suit-condition-version-comparison-greater-equal suit-condition-version-comparison-greater-equal
skipping to change at page 58, line 16 skipping to change at page 77, line 32
suit-condition-version-comparison-greater-equal = 2 suit-condition-version-comparison-greater-equal = 2
suit-condition-version-comparison-equal = 3 suit-condition-version-comparison-equal = 3
suit-condition-version-comparison-lesser-equal = 4 suit-condition-version-comparison-lesser-equal = 4
suit-condition-version-comparison-lesser = 5 suit-condition-version-comparison-lesser = 5
SUIT_Condition_Version_Comparison_Value = [+int] SUIT_Condition_Version_Comparison_Value = [+int]
SUIT_Encryption_Info = COSE_Encrypt_Tagged/COSE_Encrypt0_Tagged SUIT_Encryption_Info = COSE_Encrypt_Tagged/COSE_Encrypt0_Tagged
SUIT_Compression_Info = { SUIT_Compression_Info = {
suit-compression-algorithm => SUIT_Compression_Algorithms, suit-compression-algorithm => SUIT_Compression_Algorithms,
? suit-compression-parameters => bstr * $$SUIT_Compression_Info-extensions,
} }
SUIT_Compression_Algorithms /= SUIT_Compression_Algorithm_zlib SUIT_Compression_Algorithms /= SUIT_Compression_Algorithm_zlib
SUIT_Compression_Algorithms /= SUIT_Compression_Algorithm_brotli SUIT_Compression_Algorithms /= SUIT_Compression_Algorithm_brotli
SUIT_Compression_Algorithms /= SUIT_Compression_Algorithm_zstd SUIT_Compression_Algorithms /= SUIT_Compression_Algorithm_zstd
SUIT_Compression_Algorithm_zlib = 1 SUIT_Compression_Algorithm_zlib = 1
SUIT_Compression_Algorithm_brotli = 2 SUIT_Compression_Algorithm_brotli = 2
SUIT_Compression_Algorithm_zstd = 3 SUIT_Compression_Algorithm_zstd = 3
SUIT_Unpack_Info = { SUIT_Unpack_Info = {
suit-unpack-algorithm => SUIT_Unpack_Algorithms, suit-unpack-algorithm => SUIT_Unpack_Algorithms,
? suit-unpack-parameters => bstr * $$SUIT_Unpack_Info-extensions,
} }
SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Hex SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Hex
SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Elf SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Elf
SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Coff SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Coff
SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Srec SUIT_Unpack_Algorithms /= SUIT_Unpack_Algorithm_Srec
SUIT_Unpack_Algorithm_Hex = 1 SUIT_Unpack_Algorithm_Hex = 1
SUIT_Unpack_Algorithm_Elf = 2 SUIT_Unpack_Algorithm_Elf = 2
SUIT_Unpack_Algorithm_Coff = 3 SUIT_Unpack_Algorithm_Coff = 3
SUIT_Unpack_Algorithm_Srec = 4 SUIT_Unpack_Algorithm_Srec = 4
SUIT_Text_Map = {SUIT_Text_Keys => tstr} SUIT_URI_List = [+ tstr ]
SUIT_Text_Keys /= suit-text-manifest-description SUIT_Text_Map = {
SUIT_Text_Keys /= suit-text-update-description ? suit-text-components =>
SUIT_Text_Keys /= suit-text-vendor-name [
SUIT_Text_Keys /= suit-text-model-name + {
SUIT_Text_Keys /= suit-text-vendor-domain 1 => SUIT_Component_Identifier
SUIT_Text_Keys /= suit-text-model-info SUIT_Text_Component_Keys
SUIT_Text_Keys /= suit-text-component-description }
SUIT_Text_Keys /= suit-text-manifest-json-source ],
SUIT_Text_Keys /= suit-text-manifest-yaml-source SUIT_Text_Keys
SUIT_Text_Keys /= suit-text-version-dependencies }
SUIT_Text_Component_Keys = (
? suit-text-vendor-name => tstr,
? suit-text-model-name => tstr,
? suit-text-vendor-domain => tstr,
? suit-text-model-info => tstr,
? suit-text-component-description => tstr,
? suit-text-component-version => tstr,
? suit-text-version-required => tstr,
* $$suit-text-component-key-extensions
)
SUIT_Text_Keys = (
? suit-text-manifest-description => tstr,
? suit-text-update-description => tstr,
? suit-text-manifest-json-source => tstr,
? suit-text-manifest-yaml-source => tstr,
* $$suit-text-key-extensions
)
suit-delegation = 1 suit-delegation = 1
suit-authentication-wrapper = 2 suit-authentication-wrapper = 2
suit-manifest = 3 suit-manifest = 3
suit-manifest-encryption-info = 4
suit-manifest-encrypted = 5
suit-manifest-version = 1 suit-manifest-version = 1
suit-manifest-sequence-number = 2 suit-manifest-sequence-number = 2
suit-common = 3 suit-common = 3
suit-reference-uri = 4 suit-reference-uri = 4
suit-dependency-resolution = 7 suit-dependency-resolution = 7
suit-payload-fetch = 8 suit-payload-fetch = 8
suit-install = 9 suit-install = 9
suit-validate = 10 suit-validate = 10
suit-load = 11 suit-load = 11
suit-run = 12 suit-run = 12
skipping to change at page 60, line 17 skipping to change at page 79, line 51
;suit-directive-do-each = 16 ; TBD ;suit-directive-do-each = 16 ; TBD
;suit-directive-map-filter = 17 ; TBD ;suit-directive-map-filter = 17 ; TBD
suit-directive-process-dependency = 18 suit-directive-process-dependency = 18
suit-directive-set-parameters = 19 suit-directive-set-parameters = 19
suit-directive-override-parameters = 20 suit-directive-override-parameters = 20
suit-directive-fetch = 21 suit-directive-fetch = 21
suit-directive-copy = 22 suit-directive-copy = 22
suit-directive-run = 23 suit-directive-run = 23
suit-directive-wait = 29 suit-directive-wait = 29
suit-directive-run-sequence = 30 suit-directive-fetch-uri-list = 30
suit-directive-swap = 32 suit-directive-swap = 31
suit-directive-run-sequence = 32
suit-wait-event-authorization = 1 suit-wait-event-authorization = 1
suit-wait-event-power = 2 suit-wait-event-power = 2
suit-wait-event-network = 3 suit-wait-event-network = 3
suit-wait-event-other-device-version = 4 suit-wait-event-other-device-version = 4
suit-wait-event-time = 5 suit-wait-event-time = 5
suit-wait-event-time-of-day = 6 suit-wait-event-time-of-day = 6
suit-wait-event-day-of-week = 7 suit-wait-event-day-of-week = 7
suit-parameter-vendor-identifier = 1 suit-parameter-vendor-identifier = 1
skipping to change at page 61, line 4 skipping to change at page 80, line 38
suit-parameter-uri = 21 suit-parameter-uri = 21
suit-parameter-source-component = 22 suit-parameter-source-component = 22
suit-parameter-run-args = 23 suit-parameter-run-args = 23
suit-parameter-device-identifier = 24 suit-parameter-device-identifier = 24
suit-parameter-minimum-battery = 26 suit-parameter-minimum-battery = 26
suit-parameter-update-priority = 27 suit-parameter-update-priority = 27
suit-parameter-version = 28 suit-parameter-version = 28
suit-parameter-wait-info = 29 suit-parameter-wait-info = 29
suit-parameter-uri-list = 30 suit-parameter-uri-list = 30
suit-parameter-custom = nint suit-parameter-custom = nint
suit-compression-algorithm = 1 suit-compression-algorithm = 1
suit-compression-parameters = 2 suit-compression-parameters = 2
suit-unpack-algorithm = 1 suit-unpack-algorithm = 1
suit-unpack-parameters = 2 suit-unpack-parameters = 2
suit-text-manifest-description = 1 suit-text-manifest-description = 1
suit-text-update-description = 2 suit-text-update-description = 2
suit-text-vendor-name = 3 suit-text-manifest-json-source = 3
suit-text-model-name = 4 suit-text-manifest-yaml-source = 4
suit-text-vendor-domain = 5 suit-text-vendor-name = 1
suit-text-model-info = 6 suit-text-model-name = 2
suit-text-component-description = 7 suit-text-vendor-domain = 3
suit-text-manifest-json-source = 8 suit-text-model-info = 4
suit-text-manifest-yaml-source = 9 suit-text-component-description = 5
suit-text-version-dependencies = 10 suit-text-component-version = 6
suit-text-version-required = 7
B. Examples B. Examples
The following examples demonstrate a small subset of the The following examples demonstrate a small subset of the
functionality of the manifest. However, despite this, even a simple functionality of the manifest. However, despite this, even a simple
manifest processor can execute most of these manifests. manifest processor can execute most of these manifests.
The examples are signed using the following ECDSA secp256r1 key: The examples are signed using the following ECDSA secp256r1 key:
-----BEGIN PRIVATE KEY----- -----BEGIN PRIVATE KEY-----
skipping to change at page 61, line 46 skipping to change at page 81, line 35
The corresponding public key can be used to verify these examples: The corresponding public key can be used to verify these examples:
-----BEGIN PUBLIC KEY----- -----BEGIN PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEhJaBGq4LqqvSYVcYnuzaJr6qi/Eb MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEhJaBGq4LqqvSYVcYnuzaJr6qi/Eb
bz/m4rVlnIXbwK07HypLbAmBMcCjbazR14vTgdzfsJwFLbM5kdtzOLSolg== bz/m4rVlnIXbwK07HypLbAmBMcCjbazR14vTgdzfsJwFLbM5kdtzOLSolg==
-----END PUBLIC KEY----- -----END PUBLIC KEY-----
Each example uses SHA256 as the digest function. Each example uses SHA256 as the digest function.
Note that reporting policies are declared for each non-flow-control
command in these examples. The reporting policies used in the
examples are described in the following tables.
+-----------------------------+----------+
| Policy | Label |
+-----------------------------+----------+
| suit-send-record-on-success | Rec-Pass |
| | |
| suit-send-record-on-failure | Rec-Fail |
| | |
| suit-send-sysinfo-success | Sys-Pass |
| | |
| suit-send-sysinfo-failure | Sys-Fail |
+-----------------------------+----------+
+----------------------------+--------+---------+---------+---------+
| Command | Sys- | Sys- | Rec- | Rec- |
| | Fail | Pass | Fail | Pass |
+----------------------------+--------+---------+---------+---------+
| suit-condition-vendor- | 1 | 1 | 1 | 1 |
| identifier | | | | |
| | | | | |
| suit-condition-class- | 1 | 1 | 1 | 1 |
| identifier | | | | |
| | | | | |
| suit-condition-image-match | 1 | 1 | 1 | 1 |
| | | | | |
| suit-condition-component- | 0 | 1 | 0 | 1 |
| offset | | | | |
| | | | | |
| suit-directive-fetch | 0 | 0 | 1 | 0 |
| | | | | |
| suit-directive-copy | 0 | 0 | 1 | 0 |
| | | | | |
| suit-directive-run | 0 | 0 | 1 | 0 |
+----------------------------+--------+---------+---------+---------+
B.1. Example 0: Secure Boot B.1. Example 0: Secure Boot
Secure boot and compatibility check. This example covers the following templates:
{ - Compatibility Check (Section 7.1)
/ authentication-wrapper / 2:h'81586fd28443a10126a0582482025820655
f1230fd3833ca828c18200498fd1cd90656a9a2620c6989921c06623703515840a0416 - Secure Boot (Section 7.2)
20607b7765a51fe0566e5d8fed95491ee6df622132524fdbe67607bf7f2794d7a71dad
7230d3cab86c5091a226d00061b0a74a01b3d371e07d5b3eca3d4' / [ It also serves as the minimum example.
h'd28443a10126a0582482025820655f1230fd3833ca828c18200498fd1cd9
0656a9a2620c6989921c06623703515840a041620607b7765a51fe0566e5d8fed95491 {
ee6df622132524fdbe67607bf7f2794d7a71dad7230d3cab86c5091a226d00061b0a74 / authentication-wrapper / 2:h'81588fd28443a10126a0584482025840356
a01b3d371e07d5b3eca3d4' / 18([ 3303937656636346266336262396234393465373165316632343138656566386434363
6636339303266363339613835356563396166336539656464623939584093347ceebc1
209a2d660bfbbe78e461079f1952c614e1ae8f734ff0ea438110d056c1a0cce6b0599d
b54e6704847de49efe60e9a7b821215d83368a2c8c7c088' / [
h'd28443a10126a05844820258403563303937656636346266336262396234
3934653731653166323431386565663864343636636339303266363339613835356563
396166336539656464623939584093347ceebc1209a2d660bfbbe78e461079f1952c61
4e1ae8f734ff0ea438110d056c1a0cce6b0599db54e6704847de49efe60e9a7b821215
d83368a2c8c7c088' / 18([
/ protected / h'a10126' / { / protected / h'a10126' / {
/ alg / 1:-7 / "ES256" /, / alg / 1:-7 / "ES256" /,
} /, } /,
/ unprotected / { / unprotected / {
}, },
/ payload / h'82025820655f1230fd3833ca828c18200498fd1c / payload / h'8202584035633039376566363462663362623962
d90656a9a2620c6989921c0662370351' / [ 3439346537316531663234313865656638643436366363393032663633396138353565
63396166336539656464623939' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes / h'3563303937656636346266336262396
h'"655f1230fd3833ca828c18200498fd1cd90656a9a2620c6989921c0662370351"' 2343934653731653166323431386565663864343636636339303266363339613835356
563396166336539656464623939'
] /, ] /,
/ signature / h'"a041620607b7765a51fe0566e5d8fed95491e / signature / h'93347ceebc1209a2d660bfbbe78e461079f195
e6df622132524fdbe67607bf7f2794d7a71dad7230d3cab86c5091a226d00061b0a74a 2c614e1ae8f734ff0ea438110d056c1a0cce6b0599db54e6704847de49efe60e9a7b82
01b3d371e07d5b3eca3d4"' 1215d83368a2c8c7c088'
]) / ]) /
] /, ] /,
/ manifest / 3:h'a501010201035860a20244818141000458568614a40150fa6 / manifest / 3:h'a50101020003585fa202818141000458568614a40150fa6b4
b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582 a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248
48202582000112233445566778899aabbccddeeff0123456789abcdeffedcba9876543 202582000112233445566778899aabbccddeeff0123456789abcdeffedcba987654321
2100e1987d001f602f60a438203f60c438217f6' / { 00e1987d0010f020f0a4382030f0c43821702' / {
/ manifest-version / 1:1, / manifest-version / 1:1,
/ manifest-sequence-number / 2:1, / manifest-sequence-number / 2:0,
/ common / 3:h'a20244818141000458568614a40150fa6b4a53d5ad5fdfb / common / 3:h'a202818141000458568614a40150fa6b4a53d5ad5fdfbe9
e9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112 de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45035824820258200011223
233445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f 3445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f0
602f6' / { 20f' / {
/ components / 2:h'81814100' / [ / components / 2:[
[h'"00"'] [h'00']
] /, ],
/ common-sequence / 4:h'8614a40150fa6b4a53d5ad5fdfbe9de663 / common-sequence / 4:h'8614a40150fa6b4a53d5ad5fdfbe9de663
e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582482025820001122334455 e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582482025820001122334455
66778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f602f6' 66778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f020f'
/ [ / [
/ directive-override-parameters / 20,{ / directive-override-parameters / 20,{
/ vendor-id / / vendor-id /
1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf- 1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf-
be9d-e663e4d41ffe /, be9d-e663e4d41ffe /,
/ class-id / / class-id /
2:h'"1492af1425695e48bf429b2d51f2ab45"' / 2:h'"1492af1425695e48bf429b2d51f2ab45"' /
1492af14-2569-5e48-bf42-9b2d51f2ab45 /, 1492af14-2569-5e48-bf42-9b2d51f2ab45 /,
/ image-digest / 3:h'8202582000112233445566778899a / image-digest / 3:h'8202582000112233445566778899a
abbccddeeff0123456789abcdeffedcba9876543210' / [ abbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes /
h'"00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210"' h'00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210'
] /, ] /,
/ image-size / 14:34768, / image-size / 14:34768,
} , } ,
/ condition-vendor-identifier / 1,F6 / nil / , / condition-vendor-identifier / 1,15 ,
/ condition-class-identifier / 2,F6 / nil / / condition-class-identifier / 2,15
] /, ] /,
} /, } /,
/ validate / 10:h'8203f6' / [ / validate / 10:h'82030f' / [
/ condition-image-match / 3,F6 / nil / / condition-image-match / 3,15
] /, ] /,
/ run / 12:h'8217f6' / [ / run / 12:h'821702' / [
/ directive-run / 23,F6 / nil / / directive-run / 23,2
] /, ] /,
} /, } /,
} }
Total size of manifest without COSE authentication object: 118 Total size of Envelope without COSE authentication object: 117
Manifest: Envelope:
a1035872a501010201035860a20244818141000458568614a40150fa6b4a a1035871a50101020003585fa202818141000458568614a40150fa6b4a53
53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45
450358248202582000112233445566778899aabbccddeeff0123456789ab 0358248202582000112233445566778899aabbccddeeff0123456789abcd
cdeffedcba98765432100e1987d001f602f60a438203f60c438217f6 effedcba98765432100e1987d0010f020f0a4382030f0c43821702
Total size of manifest with COSE authentication object: 235 Total size of Envelope with COSE authentication object: 266
Manifest with COSE authentication object: Envelope with COSE authentication object:
a202587281586fd28443a10126a0582482025820655f1230fd3833ca828c a202589281588fd28443a10126a058448202584035633039376566363462
18200498fd1cd90656a9a2620c6989921c06623703515840a041620607b7 663362623962343934653731653166323431386565663864343636636339
765a51fe0566e5d8fed95491ee6df622132524fdbe67607bf7f2794d7a71 303266363339613835356563396166336539656464623939584093347cee
dad7230d3cab86c5091a226d00061b0a74a01b3d371e07d5b3eca3d40358 bc1209a2d660bfbbe78e461079f1952c614e1ae8f734ff0ea438110d056c
72a501010201035860a20244818141000458568614a40150fa6b4a53d5ad 1a0cce6b0599db54e6704847de49efe60e9a7b821215d83368a2c8c7c088
5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358 035871a50101020003585fa202818141000458568614a40150fa6b4a53d5
248202582000112233445566778899aabbccddeeff0123456789abcdeffe ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503
dcba98765432100e1987d001f602f60a438203f60c438217f6 58248202582000112233445566778899aabbccddeeff0123456789abcdef
fedcba98765432100e1987d0010f020f0a4382030f0c43821702
B.2. Example 1: Simultaneous Download and Installation of Payload B.2. Example 1: Simultaneous Download and Installation of Payload
Simultaneous download and installation of payload. This example covers the following templates:
{ - Compatibility Check (Section 7.1)
/ authentication-wrapper / 2:h'81586fd28443a10126a0582482025820815
32771898e4ebcccf12c607420eba62b5086192cac4c99692835b58ee62f7b584081592 - Firmware Download (Section 7.3)
1e5148e9b81e79d8be570de6bb42ba2e903c8549f0e13dee4d0ee420d90dd9f8537ebe
ad3f92b37df703539879129183b0beaf3ba75cacd8a91e075a24e' / [ Simultaneous download and installation of payload. No secure boot is
h'd28443a10126a058248202582081532771898e4ebcccf12c607420eba62b present in this example to demonstrate a download-only manifest.
5086192cac4c99692835b58ee62f7b5840815921e5148e9b81e79d8be570de6bb42ba2
e903c8549f0e13dee4d0ee420d90dd9f8537ebead3f92b37df703539879129183b0bea {
f3ba75cacd8a91e075a24e' / 18([ / authentication-wrapper / 2:h'81588fd28443a10126a0584482025840393
8376565633835666139396664333164333332333831623938313066393062303563326
530643466323834613666343231313230376564303066666637353058404931df82e15
3bf1e3af5a59800216d8a47c33a37839e7d63d9f526fd369aa8359daae18f7619c9591
23e7f7f928ee92a9893afedd35d06a936d6ed3d5843bf2a' / [
h'd28443a10126a05844820258403938376565633835666139396664333164
3333323338316239383130663930623035633265306434663238346136663432313132
30376564303066666637353058404931df82e153bf1e3af5a59800216d8a47c33a3783
9e7d63d9f526fd369aa8359daae18f7619c959123e7f7f928ee92a9893afedd35d06a9
36d6ed3d5843bf2a' / 18([
/ protected / h'a10126' / { / protected / h'a10126' / {
/ alg / 1:-7 / "ES256" /, / alg / 1:-7 / "ES256" /,
} /, } /,
/ unprotected / { / unprotected / {
}, },
/ payload / h'8202582081532771898e4ebcccf12c607420eba6 / payload / h'8202584039383765656338356661393966643331
2b5086192cac4c99692835b58ee62f7b' / [ 6433333233383162393831306639306230356332653064346632383461366634323131
32303765643030666666373530' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes / h'3938376565633835666139396664333
h'"81532771898e4ebcccf12c607420eba62b5086192cac4c99692835b58ee62f7b"' 1643333323338316239383130663930623035633265306434663238346136663432313
132303765643030666666373530'
] /, ] /,
/ signature / h'"815921e5148e9b81e79d8be570de6bb42ba2e / signature / h'4931df82e153bf1e3af5a59800216d8a47c33a
903c8549f0e13dee4d0ee420d90dd9f8537ebead3f92b37df703539879129183b0beaf 37839e7d63d9f526fd369aa8359daae18f7619c959123e7f7f928ee92a9893afedd35d
3ba75cacd8a91e075a24e"' 06a936d6ed3d5843bf2a'
]) / ]) /
] /, ] /,
/ manifest / 3:h'a501010202035860a20244818141000458568614a40150fa6 / manifest / 3:h'a50101020103585fa202818141000458568614a40150fa6b4
b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582 a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248
48202582000112233445566778899aabbccddeeff0123456789abcdeffedcba9876543 202582000112233445566778899aabbccddeeff0123456789abcdeffedcba987654321
2100e1987d001f602f60958258613a115781b687474703a2f2f6578616d706c652e636 00e1987d0010f020f0958258613a115781b687474703a2f2f6578616d706c652e636f6
f6d2f66696c652e62696e15f603f60a438203f6' / { d2f66696c652e62696e1502030f0a4382030f' / {
/ manifest-version / 1:1, / manifest-version / 1:1,
/ manifest-sequence-number / 2:2, / manifest-sequence-number / 2:1,
/ common / 3:h'a20244818141000458568614a40150fa6b4a53d5ad5fdfb / common / 3:h'a202818141000458568614a40150fa6b4a53d5ad5fdfbe9
e9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112 de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45035824820258200011223
233445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f 3445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f0
602f6' / { 20f' / {
/ components / 2:h'81814100' / [ / components / 2:[
[h'"00"'] [h'00']
] /, ],
/ common-sequence / 4:h'8614a40150fa6b4a53d5ad5fdfbe9de663 / common-sequence / 4:h'8614a40150fa6b4a53d5ad5fdfbe9de663
e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582482025820001122334455 e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582482025820001122334455
66778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f602f6' 66778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f020f'
/ [ / [
/ directive-override-parameters / 20,{ / directive-override-parameters / 20,{
/ vendor-id / / vendor-id /
1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf- 1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf-
be9d-e663e4d41ffe /, be9d-e663e4d41ffe /,
/ class-id / / class-id /
2:h'"1492af1425695e48bf429b2d51f2ab45"' / 2:h'"1492af1425695e48bf429b2d51f2ab45"' /
1492af14-2569-5e48-bf42-9b2d51f2ab45 /, 1492af14-2569-5e48-bf42-9b2d51f2ab45 /,
/ image-digest / 3:h'8202582000112233445566778899a / image-digest / 3:h'8202582000112233445566778899a
abbccddeeff0123456789abcdeffedcba9876543210' / [ abbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes /
h'"00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210"' h'00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210'
] /, ] /,
/ image-size / 14:34768, / image-size / 14:34768,
} , } ,
/ condition-vendor-identifier / 1,F6 / nil / , / condition-vendor-identifier / 1,15 ,
/ condition-class-identifier / 2,F6 / nil / / condition-class-identifier / 2,15
] /, ] /,
} /, } /,
/ install / 9:h'8613a115781b687474703a2f2f6578616d706c652e636f / install / 9:h'8613a115781b687474703a2f2f6578616d706c652e636f
6d2f66696c652e62696e15f603f6' / [ 6d2f66696c652e62696e1502030f' / [
/ directive-set-parameters / 19,{ / directive-set-parameters / 19,{
/ uri / 21:'http://example.com/file.bin', / uri / 21:'http://example.com/file.bin',
} , } ,
/ directive-fetch / 21,F6 / nil / , / directive-fetch / 21,2 ,
/ condition-image-match / 3,F6 / nil / / condition-image-match / 3,15
] /, ] /,
/ validate / 10:h'8203f6' / [ / validate / 10:h'82030f' / [
/ condition-image-match / 3,F6 / nil / / condition-image-match / 3,15
] /, ] /,
} /, } /,
} }
Total size of manifest without COSE authentication object: 153 Total size of Envelope without COSE authentication object: 152
Manifest: Envelope:
a1035895a501010202035860a20244818141000458568614a40150fa6b4a a1035894a50101020103585fa202818141000458568614a40150fa6b4a53
53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45
450358248202582000112233445566778899aabbccddeeff0123456789ab 0358248202582000112233445566778899aabbccddeeff0123456789abcd
cdeffedcba98765432100e1987d001f602f60958258613a115781b687474 effedcba98765432100e1987d0010f020f0958258613a115781b68747470
703a2f2f6578616d706c652e636f6d2f66696c652e62696e15f603f60a43 3a2f2f6578616d706c652e636f6d2f66696c652e62696e1502030f0a4382
8203f6 030f
Total size of manifest with COSE authentication object: 270 Total size of Envelope with COSE authentication object: 301
Manifest with COSE authentication object: Envelope with COSE authentication object:
a202587281586fd28443a10126a058248202582081532771898e4ebcccf1 a202589281588fd28443a10126a058448202584039383765656338356661
2c607420eba62b5086192cac4c99692835b58ee62f7b5840815921e5148e 393966643331643333323338316239383130663930623035633265306434
9b81e79d8be570de6bb42ba2e903c8549f0e13dee4d0ee420d90dd9f8537 66323834613666343231313230376564303066666637353058404931df82
ebead3f92b37df703539879129183b0beaf3ba75cacd8a91e075a24e0358 e153bf1e3af5a59800216d8a47c33a37839e7d63d9f526fd369aa8359daa
95a501010202035860a20244818141000458568614a40150fa6b4a53d5ad e18f7619c959123e7f7f928ee92a9893afedd35d06a936d6ed3d5843bf2a
5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358 035894a50101020103585fa202818141000458568614a40150fa6b4a53d5
248202582000112233445566778899aabbccddeeff0123456789abcdeffe ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503
dcba98765432100e1987d001f602f60958258613a115781b687474703a2f 58248202582000112233445566778899aabbccddeeff0123456789abcdef
2f6578616d706c652e636f6d2f66696c652e62696e15f603f60a438203f6 fedcba98765432100e1987d0010f020f0958258613a115781b687474703a
2f2f6578616d706c652e636f6d2f66696c652e62696e1502030f0a438203
0f
B.3. Example 2: Simultaneous Download, Installation, and Secure Boot B.3. Example 2: Simultaneous Download, Installation, Secure Boot,
Severed Fields
Compatibility test, simultaneous download and installation, and This example covers the following templates:
secure boot.
- Compatibility Check (Section 7.1)
- Secure Boot (Section 7.2)
- Firmware Download (Section 7.3)
This example also demonstrates severable elements (Section 5.5), and
text (Section 8.6.4).
{ {
/ authentication-wrapper / 2:h'81586fd28443a10126a0582482025820883 / authentication-wrapper / 2:h'81588fd28443a10126a0584482025840373
90f8988639d8a2cfb6da969fce488333ac5ba77aaf0d66b5623009bbf341158401929f 5363835353739613833626162643731656338656632326661343961633837336637386
fd488c455ab40eaf1aa96a7df4a9c16c658221055c3a113232fb81c5751a23a74b5efc 13730386134336136373465373832616433306236353938643137615840faca70796c3
06c459eb47a07028ef3c6a0d9051185dd78899c654249f9070dea' / [ 19ce6dae69690a64ced3ab91b9bb7f3e9a5004122d629d2816216a870448424ce4410d
h'd28443a10126a058248202582088390f8988639d8a2cfb6da969fce48833 658b80215185e32d8ec6feb15c7275d64437c36418463e4' / [
3ac5ba77aaf0d66b5623009bbf341158401929ffd488c455ab40eaf1aa96a7df4a9c16 h'd28443a10126a05844820258403735363835353739613833626162643731
c658221055c3a113232fb81c5751a23a74b5efc06c459eb47a07028ef3c6a0d9051185 6563386566323266613439616338373366373861373038613433613637346537383261
dd78899c654249f9070dea' / 18([ 6433306236353938643137615840faca70796c319ce6dae69690a64ced3ab91b9bb7f3
e9a5004122d629d2816216a870448424ce4410d658b80215185e32d8ec6feb15c7275d
64437c36418463e4' / 18([
/ protected / h'a10126' / { / protected / h'a10126' / {
/ alg / 1:-7 / "ES256" /, / alg / 1:-7 / "ES256" /,
} /, } /,
/ unprotected / { / unprotected / {
}, },
/ payload / h'8202582088390f8988639d8a2cfb6da969fce488 / payload / h'8202584037353638353537396138336261626437
333ac5ba77aaf0d66b5623009bbf3411' / [ 3165633865663232666134396163383733663738613730386134336136373465373832
61643330623635393864313761' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes / h'3735363835353739613833626162643
h'"88390f8988639d8a2cfb6da969fce488333ac5ba77aaf0d66b5623009bbf3411"' 7316563386566323266613439616338373366373861373038613433613637346537383
261643330623635393864313761'
] /, ] /,
/ signature / h'"1929ffd488c455ab40eaf1aa96a7df4a9c16c / signature / h'faca70796c319ce6dae69690a64ced3ab91b9b
658221055c3a113232fb81c5751a23a74b5efc06c459eb47a07028ef3c6a0d9051185d b7f3e9a5004122d629d2816216a870448424ce4410d658b80215185e32d8ec6feb15c7
d78899c654249f9070dea"' 275d64437c36418463e4'
]) / ]) /
] /, ] /,
/ manifest / 3:h'a601010203035860a20244818141000458568614a40150fa6 / manifest / 3:h'a70101020203585fa202818141000458568614a40150fa6b4
b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582 a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248
48202582000112233445566778899aabbccddeeff0123456789abcdeffedcba9876543 202582000112233445566778899aabbccddeeff0123456789abcdeffedcba987654321
2100e1987d001f602f60958258613a115781b687474703a2f2f6578616d706c652e636 00e1987d0010f020f09820258203ee96dc79641970ae46b929ccf0b72ba9536dd84602
f6d2f66696c652e62696e15f603f60a438203f60c438217f6' / { 0dbdc9f949d84ea0e18d20a4382030f0c438217020d8202582023f48b2e2838650f43c
144234aee18401ffe3cce4733b23881c3a8ae2d2b66e8' / {
/ manifest-version / 1:1, / manifest-version / 1:1,
/ manifest-sequence-number / 2:3, / manifest-sequence-number / 2:2,
/ common / 3:h'a20244818141000458568614a40150fa6b4a53d5ad5fdfb / common / 3:h'a202818141000458568614a40150fa6b4a53d5ad5fdfbe9
de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45035824820258200011223
e9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112 3445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f0
233445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f 20f' / {
602f6' / { / components / 2:[
/ components / 2:h'81814100' / [ [h'00']
[h'"00"'] ],
] /,
/ common-sequence / 4:h'8614a40150fa6b4a53d5ad5fdfbe9de663 / common-sequence / 4:h'8614a40150fa6b4a53d5ad5fdfbe9de663
e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582482025820001122334455 e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582482025820001122334455
66778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f602f6' 66778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f020f'
/ [ / [
/ directive-override-parameters / 20,{ / directive-override-parameters / 20,{
/ vendor-id / / vendor-id /
1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf- 1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf-
be9d-e663e4d41ffe /, be9d-e663e4d41ffe /,
/ class-id / / class-id /
2:h'"1492af1425695e48bf429b2d51f2ab45"' / 2:h'"1492af1425695e48bf429b2d51f2ab45"' /
1492af14-2569-5e48-bf42-9b2d51f2ab45 /, 1492af14-2569-5e48-bf42-9b2d51f2ab45 /,
/ image-digest / 3:h'8202582000112233445566778899a / image-digest / 3:h'8202582000112233445566778899a
abbccddeeff0123456789abcdeffedcba9876543210' / [ abbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes /
h'"00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210"' h'00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210'
] /, ] /,
/ image-size / 14:34768, / image-size / 14:34768,
} , } ,
/ condition-vendor-identifier / 1,F6 / nil / , / condition-vendor-identifier / 1,15 ,
/ condition-class-identifier / 2,F6 / nil / / condition-class-identifier / 2,15
] /, ] /,
} /, } /,
/ install / 9:h'8613a115781b687474703a2f2f6578616d706c652e636f / install / 9:[
6d2f66696c652e62696e15f603f6' / [ / algorithm-id / 2 / "sha256" /,
/ directive-set-parameters / 19,{ / digest-bytes /
/ uri / 21:'http://example.com/file.bin',
} , h'3ee96dc79641970ae46b929ccf0b72ba9536dd846020dbdc9f949d84ea0e18d2'
/ directive-fetch / 21,F6 / nil / , ],
/ condition-image-match / 3,F6 / nil / / validate / 10:h'82030f' / [
] /, / condition-image-match / 3,15
/ validate / 10:h'8203f6' / [
/ condition-image-match / 3,F6 / nil /
] /, ] /,
/ run / 12:h'8217f6' / [ / run / 12:h'821702' / [
/ directive-run / 23,F6 / nil / / directive-run / 23,2
] /, ] /,
/ text / 13:[
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'23f48b2e2838650f43c144234aee18401ffe3cce4733b23881c3a8ae2d2b66e8'
],
} /,
/ install / 9:h'8613a1157832687474703a2f2f6578616d706c652e636f6d2f
766572792f6c6f6e672f706174682f746f2f66696c652f66696c652e62696e1502030f
' / [
/ directive-set-parameters / 19,{
/ uri /
21:'http://example.com/very/long/path/to/file/file.bin',
} ,
/ directive-fetch / 21,2 ,
/ condition-image-match / 3,15
] /,
/ text / 13:h'a1814100a2036761726d2e636f6d0578525468697320636f6d70
6f6e656e7420697320612064656d6f6e7374726174696f6e2e20546865206469676573
7420697320612073616d706c65207061747465726e2c206e6f742061207265616c206f
6e652e' / {
[h'00']:{
/ vendor-domain / 3:'arm.com',
/ component-description / 5:'This component is a
demonstration. The digest is a sample pattern, not a real one.',
}
} /, } /,
} }
Total size of manifest without COSE authentication object: 158 Total size of the Envelope without COSE authentication object or
Manifest: Severable Elements: 191
a103589aa601010203035860a20244818141000458568614a40150fa6b4a Envelope:
53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab
450358248202582000112233445566778899aabbccddeeff0123456789ab
cdeffedcba98765432100e1987d001f602f60958258613a115781b687474
703a2f2f6578616d706c652e636f6d2f66696c652e62696e15f603f60a43
8203f60c438217f6
Total size of manifest with COSE authentication object: 275 a10358bba70101020203585fa202818141000458568614a40150fa6b4a53
d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45
0358248202582000112233445566778899aabbccddeeff0123456789abcd
effedcba98765432100e1987d0010f020f09820258203ee96dc79641970a
e46b929ccf0b72ba9536dd846020dbdc9f949d84ea0e18d20a4382030f0c
438217020d8202582023f48b2e2838650f43c144234aee18401ffe3cce47
33b23881c3a8ae2d2b66e8
Total size of the Envelope with COSE authentication object but
without Severable Elements: 340
Manifest with COSE authentication object: Envelope:
a202587281586fd28443a10126a058248202582088390f8988639d8a2cfb a202589281588fd28443a10126a058448202584037353638353537396138
6da969fce488333ac5ba77aaf0d66b5623009bbf341158401929ffd488c4 336261626437316563386566323266613439616338373366373861373038
55ab40eaf1aa96a7df4a9c16c658221055c3a113232fb81c5751a23a74b5 6134336136373465373832616433306236353938643137615840faca7079
efc06c459eb47a07028ef3c6a0d9051185dd78899c654249f9070dea0358 6c319ce6dae69690a64ced3ab91b9bb7f3e9a5004122d629d2816216a870
9aa601010203035860a20244818141000458568614a40150fa6b4a53d5ad 448424ce4410d658b80215185e32d8ec6feb15c7275d64437c36418463e4
5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358 0358bba70101020203585fa202818141000458568614a40150fa6b4a53d5
248202582000112233445566778899aabbccddeeff0123456789abcdeffe ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503
dcba98765432100e1987d001f602f60958258613a115781b687474703a2f 58248202582000112233445566778899aabbccddeeff0123456789abcdef
2f6578616d706c652e636f6d2f66696c652e62696e15f603f60a438203f6 fedcba98765432100e1987d0010f020f09820258203ee96dc79641970ae4
0c438217f6 6b929ccf0b72ba9536dd846020dbdc9f949d84ea0e18d20a4382030f0c43
8217020d8202582023f48b2e2838650f43c144234aee18401ffe3cce4733
b23881c3a8ae2d2b66e8
B.4. Example 3: Load from External Storage Total size of Envelope with COSE authentication object: 923
Compatibility test, simultaneous download and installation, load from Envelope with COSE authentication object:
external storage, and secure boot.
a402589281588fd28443a10126a058448202584037353638353537396138
336261626437316563386566323266613439616338373366373861373038
6134336136373465373832616433306236353938643137615840faca7079
6c319ce6dae69690a64ced3ab91b9bb7f3e9a5004122d629d2816216a870
448424ce4410d658b80215185e32d8ec6feb15c7275d64437c36418463e4
0358bba70101020203585fa202818141000458568614a40150fa6b4a53d5
ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503
58248202582000112233445566778899aabbccddeeff0123456789abcdef
fedcba98765432100e1987d0010f020f09820258203ee96dc79641970ae4
6b929ccf0b72ba9536dd846020dbdc9f949d84ea0e18d20a4382030f0c43
8217020d8202582023f48b2e2838650f43c144234aee18401ffe3cce4733
b23881c3a8ae2d2b66e809583c8613a1157832687474703a2f2f6578616d
706c652e636f6d2f766572792f6c6f6e672f706174682f746f2f66696c65
2f66696c652e62696e1502030f0d590204a20179019d2323204578616d70
6c6520323a2053696d756c74616e656f757320446f776e6c6f61642c2049
6e7374616c6c6174696f6e2c2053656375726520426f6f742c2053657665
726564204669656c64730a0a2020202054686973206578616d706c652063
6f766572732074686520666f6c6c6f77696e672074656d706c617465733a
0a202020200a202020202a20436f6d7061746962696c6974792043686563
6b20287b7b74656d706c6174652d636f6d7061746962696c6974792d6368
65636b7d7d290a202020202a2053656375726520426f6f7420287b7b7465
6d706c6174652d7365637572652d626f6f747d7d290a202020202a204669
726d7761726520446f776e6c6f616420287b7b6669726d776172652d646f
776e6c6f61642d74656d706c6174657d7d290a202020200a202020205468
6973206578616d706c6520616c736f2064656d6f6e737472617465732073
6576657261626c6520656c656d656e747320287b7b6f76722d7365766572
61626c657d7d292c20616e64207465787420287b7b6d616e69666573742d
6469676573742d746578747d7d292e814100a2036761726d2e636f6d0578
525468697320636f6d706f6e656e7420697320612064656d6f6e73747261
74696f6e2e205468652064696765737420697320612073616d706c652070
61747465726e2c206e6f742061207265616c206f6e652e
B.4. Example 3: A/B images
This example covers the following templates:
- Compatibility Check (Section 7.1)
- Secure Boot (Section 7.2)
- Firmware Download (Section 7.3)
- A/B Image Template (Section 7.10)
{ {
/ authentication-wrapper / 2:h'81586fd28443a10126a0582482025820568 / authentication-wrapper / 2:h'81588fd28443a10126a0584482025840616
56a72f9ac0ee73b4ea3a866cf2e5c990e8ed8c6056608bc221efd42172b2758402a9d7 5306331656136383963393830306138343335353066333837393662366664626435326
573ef6dcf5653b39027fdf87b81adeb0f03122bef0ecf5af9c7d77323c32827230f660 1306337386265356432363031316438653738346461343364343763584010222ddbce4
8342b7bf5c125f17148bd67880420ab0d03e235e6ca1d15127499' / [ e82a85f6ec7b72db34d7c5be8d2e822e4b2d099a4cf1d08aa2174c56c2e93bf20c785b
h'd28443a10126a058248202582056856a72f9ac0ee73b4ea3a866cf2e5c99 ca298900208d92d352faf86e6cddc902a726bbc443c21ff' / [
0e8ed8c6056608bc221efd42172b2758402a9d7573ef6dcf5653b39027fdf87b81adeb h'd28443a10126a05844820258406165306331656136383963393830306138
0f03122bef0ecf5af9c7d77323c32827230f6608342b7bf5c125f17148bd67880420ab 3433353530663338373936623666646264353261306337386265356432363031316438
0d03e235e6ca1d15127499' / 18([ 653738346461343364343763584010222ddbce4e82a85f6ec7b72db34d7c5be8d2e822
e4b2d099a4cf1d08aa2174c56c2e93bf20c785bca298900208d92d352faf86e6cddc90
2a726bbc443c21ff' / 18([
/ protected / h'a10126' / { / protected / h'a10126' / {
/ alg / 1:-7 / "ES256" /, / alg / 1:-7 / "ES256" /,
} /, } /,
/ unprotected / { / unprotected / {
}, },
/ payload / h'8202582056856a72f9ac0ee73b4ea3a866cf2e5c / payload / h'8202584061653063316561363839633938303061
990e8ed8c6056608bc221efd42172b27' / [ 3834333535306633383739366236666462643532613063373862653564323630313164
38653738346461343364343763' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes / h'6165306331656136383963393830306
h'"56856a72f9ac0ee73b4ea3a866cf2e5c990e8ed8c6056608bc221efd42172b27"' 1383433353530663338373936623666646264353261306337386265356432363031316
438653738346461343364343763'
] /, ] /,
/ signature / h'"2a9d7573ef6dcf5653b39027fdf87b81adeb0 / signature / h'10222ddbce4e82a85f6ec7b72db34d7c5be8d2
f03122bef0ecf5af9c7d77323c32827230f6608342b7bf5c125f17148bd67880420ab0 e822e4b2d099a4cf1d08aa2174c56c2e93bf20c785bca298900208d92d352faf86e6cd
d03e235e6ca1d15127499"' dc902a726bbc443c21ff'
]) / ]) /
] /, ] /,
/ manifest / 3:h'a701010204035865a2024782814100814101045858880c001 / manifest / 3:h'a5010102030358aaa202818141000458a18814a20150fa6b4
4a40150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450f82583
2ab450358248202582000112233445566778899aabbccddeeff0123456789abcdeffed 68614a105198400050514a20358248202582000112233445566778899aabbccddeeff0
cba98765432100e1987d001f602f6095827880c0013a115781b687474703a2f2f65786 123456789abcdeffedcba98765432100e1987d0583a8614a1051a00084400050514a20
16d706c652e636f6d2f66696c652e62696e15f603f60a45840c0003f60b4b880c0113a 35824820258200123456789abcdeffedcba987654321000112233445566778899aabbc
1160016f603f60c45840c0117f6' / { cddeeff0e1a00012c22010f020f095861860f82582a8613a105198400050513a115781
c687474703a2f2f6578616d706c652e636f6d2f66696c65312e62696e582c8613a1051
a00084400050513a115781c687474703a2f2f6578616d706c652e636f6d2f66696c653
22e62696e1502030f0a4382030f' / {
/ manifest-version / 1:1, / manifest-version / 1:1,
/ manifest-sequence-number / 2:4, / manifest-sequence-number / 2:3,
/ common / 3:h'a2024782814100814101045858880c0014a40150fa6b4a5 / common / 3:h'a202818141000458a18814a20150fa6b4a53d5ad5fdfbe9
3d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45035824820 de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450f8258368614a10519840
2582000112233445566778899aabbccddeeff0123456789abcdeffedcba98765432100 0050514a20358248202582000112233445566778899aabbccddeeff0123456789abcde
e1987d001f602f6' / { ffedcba98765432100e1987d0583a8614a1051a00084400050514a2035824820258200
/ components / 2:h'82814100814101' / [ 123456789abcdeffedcba987654321000112233445566778899aabbccddeeff0e1a000
[h'"00"'] , 12c22010f020f' / {
[h'"01"'] / components / 2:[
] /, [h'00']
/ common-sequence / 4:h'880c0014a40150fa6b4a53d5ad5fdfbe9d ],
e663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112233 / common-sequence / 4:h'8814a20150fa6b4a53d5ad5fdfbe9de663
445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f602 e4d41ffe02501492af1425695e48bf429b2d51f2ab450f8258368614a1051984000505
f6' / [ 14a20358248202582000112233445566778899aabbccddeeff0123456789abcdeffedc
/ directive-set-component-index / 12,0 , ba98765432100e1987d0583a8614a1051a00084400050514a203582482025820012345
6789abcdeffedcba987654321000112233445566778899aabbccddeeff0e1a00012c22
010f020f' / [
/ directive-override-parameters / 20,{ / directive-override-parameters / 20,{
/ vendor-id / / vendor-id /
1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf- 1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf-
be9d-e663e4d41ffe /, be9d-e663e4d41ffe /,
/ class-id / / class-id /
2:h'"1492af1425695e48bf429b2d51f2ab45"' / 2:h'"1492af1425695e48bf429b2d51f2ab45"' /
1492af14-2569-5e48-bf42-9b2d51f2ab45 /, 1492af14-2569-5e48-bf42-9b2d51f2ab45 /,
/ image-digest / 3:h'8202582000112233445566778899a
abbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'"00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210"'
] /,
/ image-size / 14:34768,
} , } ,
/ condition-vendor-identifier / 1,F6 / nil / , / directive-try-each / 15,[
/ condition-class-identifier / 2,F6 / nil / h'8614a105198400050514a203582482025820001122334455
66778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0' / [
/ directive-override-parameters / 20,{
/ offset / 5:33792,
} ,
/ condition-component-offset / 5,5 ,
/ directive-override-parameters / 20,{
/ image-digest / 3:h'820258200011223344556
6778899aabbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210'
] /,
/ image-size / 14:34768,
}
] / ,
h'8614a1051a00084400050514a20358248202582001234567
89abcdeffedcba987654321000112233445566778899aabbccddeeff0e1a00012c22'
/ [
/ directive-override-parameters / 20,{
/ offset / 5:541696,
} ,
/ condition-component-offset / 5,5 ,
/ directive-override-parameters / 20,{
/ image-digest / 3:h'820258200123456789abc
deffedcba987654321000112233445566778899aabbccddeeff' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'0123456789abcdeffedcba987654321000112233445566778899aabbccddeeff'
] /,
/ image-size / 14:76834,
}
] /
] ,
/ condition-vendor-identifier / 1,15 ,
/ condition-class-identifier / 2,15
] /, ] /,
} /, } /,
/ install / 9:h'880c0013a115781b687474703a2f2f6578616d706c652e / install / 9:h'860f82582a8613a105198400050513a115781c68747470
636f6d2f66696c652e62696e15f603f6' / [ 3a2f2f6578616d706c652e636f6d2f66696c65312e62696e582c8613a1051a00084400
/ directive-set-component-index / 12,0 , 050513a115781c687474703a2f2f6578616d706c652e636f6d2f66696c65322e62696e
/ directive-set-parameters / 19,{ 1502030f' / [
/ uri / 21:'http://example.com/file.bin', / directive-try-each / 15,[
} , h'8613a105198400050513a115781c687474703a2f2f6578616d70
/ directive-fetch / 21,F6 / nil / , 6c652e636f6d2f66696c65312e62696e' / [
/ condition-image-match / 3,F6 / nil / / directive-set-parameters / 19,{
] /, / offset / 5:33792,
/ validate / 10:h'840c0003f6' / [ } ,
/ directive-set-component-index / 12,0 , / condition-component-offset / 5,5 ,
/ condition-image-match / 3,F6 / nil / / directive-set-parameters / 19,{
] /, / uri / 21:'http://example.com/file1.bin',
/ load / 11:h'880c0113a1160016f603f6' / [ }
/ directive-set-component-index / 12,1 , ] / ,
/ directive-set-parameters / 19,{ h'8613a1051a00084400050513a115781c687474703a2f2f657861
/ source-component / 22:0 / [h'"00"'] /, 6d706c652e636f6d2f66696c65322e62696e' / [
} , / directive-set-parameters / 19,{
/ directive-copy / 22,F6 / nil / , / offset / 5:541696,
/ condition-image-match / 3,F6 / nil / } ,
/ condition-component-offset / 5,5 ,
/ directive-set-parameters / 19,{
/ uri / 21:'http://example.com/file2.bin',
}
] /
] ,
/ directive-fetch / 21,2 ,
/ condition-image-match / 3,15
] /, ] /,
/ run / 12:h'840c0117f6' / [ / validate / 10:h'82030f' / [
/ directive-set-component-index / 12,1 , / condition-image-match / 3,15
/ directive-run / 23,F6 / nil /
] /, ] /,
} /, } /,
} }
Total size of manifest without COSE authentication object: 182 Total size of Envelope without COSE authentication object: 288
Manifest: Envelope:
a10358b2a701010204035865a2024782814100814101045858880c0014a4 a10359011ba5010102030358aaa202818141000458a18814a20150fa6b4a
0150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf42 53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab
9b2d51f2ab450358248202582000112233445566778899aabbccddeeff01 450f8258368614a105198400050514a20358248202582000112233445566
23456789abcdeffedcba98765432100e1987d001f602f6095827880c0013 778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d058
a115781b687474703a2f2f6578616d706c652e636f6d2f66696c652e6269 3a8614a1051a00084400050514a2035824820258200123456789abcdeffe
6e15f603f60a45840c0003f60b4b880c0113a1160016f603f60c45840c01 dcba987654321000112233445566778899aabbccddeeff0e1a00012c2201
17f6 0f020f095861860f82582a8613a105198400050513a115781c687474703a
2f2f6578616d706c652e636f6d2f66696c65312e62696e582c8613a1051a
00084400050513a115781c687474703a2f2f6578616d706c652e636f6d2f
66696c65322e62696e1502030f0a4382030f
Total size of manifest with COSE authentication object: 299 Total size of Envelope with COSE authentication object: 437
Manifest with COSE authentication object: Envelope with COSE authentication object:
a202587281586fd28443a10126a058248202582056856a72f9ac0ee73b4e a202589281588fd28443a10126a058448202584061653063316561363839
a3a866cf2e5c990e8ed8c6056608bc221efd42172b2758402a9d7573ef6d 633938303061383433353530663338373936623666646264353261306337
cf5653b39027fdf87b81adeb0f03122bef0ecf5af9c7d77323c32827230f 386265356432363031316438653738346461343364343763584010222ddb
6608342b7bf5c125f17148bd67880420ab0d03e235e6ca1d151274990358 ce4e82a85f6ec7b72db34d7c5be8d2e822e4b2d099a4cf1d08aa2174c56c
b2a701010204035865a2024782814100814101045858880c0014a40150fa 2e93bf20c785bca298900208d92d352faf86e6cddc902a726bbc443c21ff
6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51 0359011ba5010102030358aaa202818141000458a18814a20150fa6b4a53
f2ab450358248202582000112233445566778899aabbccddeeff01234567 d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45
89abcdeffedcba98765432100e1987d001f602f6095827880c0013a11578 0f8258368614a105198400050514a2035824820258200011223344556677
1b687474703a2f2f6578616d706c652e636f6d2f66696c652e62696e15f6 8899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0583a
03f60a45840c0003f60b4b880c0113a1160016f603f60c45840c0117f6 8614a1051a00084400050514a2035824820258200123456789abcdeffedc
ba987654321000112233445566778899aabbccddeeff0e1a00012c22010f
020f095861860f82582a8613a105198400050513a115781c687474703a2f
2f6578616d706c652e636f6d2f66696c65312e62696e582c8613a1051a00
084400050513a115781c687474703a2f2f6578616d706c652e636f6d2f66
696c65322e62696e1502030f0a4382030f
B.5. Example 4: Load and Decompress from External Storage B.5. Example 4: Load and Decompress from External Storage
Compatibility test, simultaneous download and installation, load and This example covers the following templates:
decompress from external storage, and secure boot.
- Compatibility Check (Section 7.1)
- Secure Boot (Section 7.2)
- Firmware Download (Section 7.3)
- Install (Section 7.4)
- Load & Decompress (Section 7.7)
{ {
/ authentication-wrapper / 2:h'81586fd28443a10126a058248202582057b / authentication-wrapper / 2:h'81588fd28443a10126a0584482025840346
edc0076919ba83908365faf6d205e95c71268d29a94dc5e82698edd3a48225840e0a4d 2346337633863306664613736633963393539316139646231363039313865326233633
c500266518742802f2364b65f983175f060c1555d3d0b186f447500ba60c66e3231674 93661353862306135653439383466643465386639333539613932385840d7063361f65
1c3b642c68fed73d47542c3375c0ab72e0f4b94ec392ab398599d' / [ 3d57e63691e1bd9c856058c773b94e488bff58d599c45277788e90eb92fbef666f584e
h'd28443a10126a058248202582057bedc0076919ba83908365faf6d205e95 8d35b3b20ceef50a69b94dcff12beee92e426a06ea31320' / [
c71268d29a94dc5e82698edd3a48225840e0a4dc500266518742802f2364b65f983175 h'd28443a10126a05844820258403462346337633863306664613736633963
f060c1555d3d0b186f447500ba60c66e32316741c3b642c68fed73d47542c3375c0ab7 3935393161396462313630393138653262336339366135386230613565343938346664
2e0f4b94ec392ab398599d' / 18([ 3465386639333539613932385840d7063361f653d57e63691e1bd9c856058c773b94e4
88bff58d599c45277788e90eb92fbef666f584e8d35b3b20ceef50a69b94dcff12beee
92e426a06ea31320' / 18([
/ protected / h'a10126' / { / protected / h'a10126' / {
/ alg / 1:-7 / "ES256" /, / alg / 1:-7 / "ES256" /,
} /, } /,
/ unprotected / { / unprotected / {
}, },
/ payload / h'8202582057bedc0076919ba83908365faf6d205e / payload / h'8202584034623463376338633066646137366339
95c71268d29a94dc5e82698edd3a4822' / [ 6339353931613964623136303931386532623363393661353862306135653439383466
64346538663933353961393238' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes / h'3462346337633863306664613736633
h'"57bedc0076919ba83908365faf6d205e95c71268d29a94dc5e82698edd3a4822"' 9633935393161396462313630393138653262336339366135386230613565343938346
664346538663933353961393238'
] /, ] /,
/ signature / h'"e0a4dc500266518742802f2364b65f983175f / signature / h'd7063361f653d57e63691e1bd9c856058c773b
060c1555d3d0b186f447500ba60c66e32316741c3b642c68fed73d47542c3375c0ab72 94e488bff58d599c45277788e90eb92fbef666f584e8d35b3b20ceef50a69b94dcff12
e0f4b94ec392ab398599d"' beee92e426a06ea31320'
]) / ]) /
] /, ] /,
/ manifest / 3:h'a701010205035865a2024782814100814101045858880c001 / manifest / 3:h'a801010204035867a20283814100814102814101045858880
4a40150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f c0014a40150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2
2ab450358248202582000112233445566778899aabbccddeeff0123456789abcdeffed d51f2ab450358248202582000112233445566778899aabbccddeeff0123456789abcde
cba98765432100e1987d001f602f6095827880c0013a115781b687474703a2f2f65786 ffedcba98765432100e1987d0010f020f085827880c0113a115781b687474703a2f2f6
16d706c652e636f6d2f66696c652e62696e15f603f60a45840c0003f60b4d880c0113a 578616d706c652e636f6d2f66696c652e62696e1502030f094b880c0013a1160116020
21301160016f603f60c45840c0117f6' / { 30f0a45840c00030f0b583a880c0213a4035824820258200123456789abcdeffedcba9
87654321000112233445566778899aabbccddeeff0e1a00012c22130116001602030f0
c45840c021702' / {
/ manifest-version / 1:1, / manifest-version / 1:1,
/ manifest-sequence-number / 2:5, / manifest-sequence-number / 2:4,
/ common / 3:h'a2024782814100814101045858880c0014a40150fa6b4a5 / common / 3:h'a20283814100814102814101045858880c0014a40150fa6
3d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45035824820 b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582
2582000112233445566778899aabbccddeeff0123456789abcdeffedcba98765432100 48202582000112233445566778899aabbccddeeff0123456789abcdeffedcba9876543
e1987d001f602f6' / { 2100e1987d0010f020f' / {
/ components / 2:h'82814100814101' / [ / components / 2:[
[h'"00"'] , [h'00'] ,
[h'"01"'] [h'02'] ,
] /, [h'01']
],
/ common-sequence / 4:h'880c0014a40150fa6b4a53d5ad5fdfbe9d / common-sequence / 4:h'880c0014a40150fa6b4a53d5ad5fdfbe9d
e663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112233 e663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112233
445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f602 445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f02
f6' / [ 0f' / [
/ directive-set-component-index / 12,0 , / directive-set-component-index / 12,0 ,
/ directive-override-parameters / 20,{ / directive-override-parameters / 20,{
/ vendor-id / / vendor-id /
1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf- 1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf-
be9d-e663e4d41ffe /, be9d-e663e4d41ffe /,
/ class-id / / class-id /
2:h'"1492af1425695e48bf429b2d51f2ab45"' / 2:h'"1492af1425695e48bf429b2d51f2ab45"' /
1492af14-2569-5e48-bf42-9b2d51f2ab45 /, 1492af14-2569-5e48-bf42-9b2d51f2ab45 /,
/ image-digest / 3:h'8202582000112233445566778899a / image-digest / 3:h'8202582000112233445566778899a
abbccddeeff0123456789abcdeffedcba9876543210' / [ abbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes /
h'"00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210"' h'00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210'
] /, ] /,
/ image-size / 14:34768, / image-size / 14:34768,
} , } ,
/ condition-vendor-identifier / 1,F6 / nil / , / condition-vendor-identifier / 1,15 ,
/ condition-class-identifier / 2,F6 / nil / / condition-class-identifier / 2,15
] /, ] /,
} /, } /,
/ install / 9:h'880c0013a115781b687474703a2f2f6578616d706c652e / payload-fetch / 8:h'880c0113a115781b687474703a2f2f6578616d70
636f6d2f66696c652e62696e15f603f6' / [ 6c652e636f6d2f66696c652e62696e1502030f' / [
/ directive-set-component-index / 12,0 , / directive-set-component-index / 12,1 ,
/ directive-set-parameters / 19,{ / directive-set-parameters / 19,{
/ uri / 21:'http://example.com/file.bin', / uri / 21:'http://example.com/file.bin',
} , } ,
/ directive-fetch / 21,F6 / nil / , / directive-fetch / 21,2 ,
/ condition-image-match / 3,F6 / nil / / condition-image-match / 3,15
] /, ] /,
/ validate / 10:h'840c0003f6' / [ / install / 9:h'880c0013a116011602030f' / [
/ directive-set-component-index / 12,0 , / directive-set-component-index / 12,0 ,
/ condition-image-match / 3,F6 / nil / / directive-set-parameters / 19,{
/ source-component / 22:1 / [h'02'] /,
} ,
/ directive-copy / 22,2 ,
/ condition-image-match / 3,15
] /, ] /,
/ load / 11:h'880c0113a21301160016f603f6' / [ / validate / 10:h'840c00030f' / [
/ directive-set-component-index / 12,1 , / directive-set-component-index / 12,0 ,
/ condition-image-match / 3,15
] /,
/ load / 11:h'880c0213a4035824820258200123456789abcdeffedcba98
7654321000112233445566778899aabbccddeeff0e1a00012c22130116001602030f'
/ [
/ directive-set-component-index / 12,2 ,
/ directive-set-parameters / 19,{ / directive-set-parameters / 19,{
/ source-component / 22:0 / [h'"00"'] /, / image-digest / 3:h'820258200123456789abcdeffedcba987
654321000112233445566778899aabbccddeeff' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'0123456789abcdeffedcba987654321000112233445566778899aabbccddeeff'
] /,
/ image-size / 14:76834,
/ source-component / 22:0 / [h'00'] /,
/ compression-info / 19:1 / "gzip" /, / compression-info / 19:1 / "gzip" /,
} , } ,
/ directive-copy / 22,F6 / nil / , / directive-copy / 22,2 ,
/ condition-image-match / 3,F6 / nil / / condition-image-match / 3,15
] /, ] /,
/ run / 12:h'840c0117f6' / [ / run / 12:h'840c021702' / [
/ directive-set-component-index / 12,1 , / directive-set-component-index / 12,2 ,
/ directive-run / 23,F6 / nil / / directive-run / 23,2
] /, ] /,
} /, } /,
} }
Total size of manifest without COSE authentication object: 184 Total size of Envelope without COSE authentication object: 245
Manifest: Envelope:
a10358b4a701010205035865a2024782814100814101045858880c0014a4 a10358f1a801010204035867a20283814100814102814101045858880c00
0150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf42 14a40150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48
9b2d51f2ab450358248202582000112233445566778899aabbccddeeff01 bf429b2d51f2ab450358248202582000112233445566778899aabbccddee
23456789abcdeffedcba98765432100e1987d001f602f6095827880c0013 ff0123456789abcdeffedcba98765432100e1987d0010f020f085827880c
a115781b687474703a2f2f6578616d706c652e636f6d2f66696c652e6269 0113a115781b687474703a2f2f6578616d706c652e636f6d2f66696c652e
6e15f603f60a45840c0003f60b4d880c0113a21301160016f603f60c4584 62696e1502030f094b880c0013a116011602030f0a45840c00030f0b583a
0c0117f6 880c0213a4035824820258200123456789abcdeffedcba98765432100011
2233445566778899aabbccddeeff0e1a00012c22130116001602030f0c45
840c021702
Total size of manifest with COSE authentication object: 301 Total size of Envelope with COSE authentication object: 394
Manifest with COSE authentication object: Envelope with COSE authentication object:
a202587281586fd28443a10126a058248202582057bedc0076919ba83908 a202589281588fd28443a10126a058448202584034623463376338633066
365faf6d205e95c71268d29a94dc5e82698edd3a48225840e0a4dc500266 646137366339633935393161396462313630393138653262336339366135
518742802f2364b65f983175f060c1555d3d0b186f447500ba60c66e3231 3862306135653439383466643465386639333539613932385840d7063361
6741c3b642c68fed73d47542c3375c0ab72e0f4b94ec392ab398599d0358 f653d57e63691e1bd9c856058c773b94e488bff58d599c45277788e90eb9
b4a701010205035865a2024782814100814101045858880c0014a40150fa 2fbef666f584e8d35b3b20ceef50a69b94dcff12beee92e426a06ea31320
6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51 0358f1a801010204035867a20283814100814102814101045858880c0014
f2ab450358248202582000112233445566778899aabbccddeeff01234567 a40150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf
89abcdeffedcba98765432100e1987d001f602f6095827880c0013a11578 429b2d51f2ab450358248202582000112233445566778899aabbccddeeff
1b687474703a2f2f6578616d706c652e636f6d2f66696c652e62696e15f6 0123456789abcdeffedcba98765432100e1987d0010f020f085827880c01
03f60a45840c0003f60b4d880c0113a21301160016f603f60c45840c0117 13a115781b687474703a2f2f6578616d706c652e636f6d2f66696c652e62
f6 696e1502030f094b880c0013a116011602030f0a45840c00030f0b583a88
0c0213a4035824820258200123456789abcdeffedcba9876543210001122
33445566778899aabbccddeeff0e1a00012c22130116001602030f0c4584
0c021702
B.6. Example 5: Compatibility Test, Download, Installation, and Secure B.6. Example 5: Two Images
Boot
Compatibility test, download, installation, and secure boot. This example covers the following templates:
- Compatibility Check (Section 7.1)
- Secure Boot (Section 7.2)
- Firmware Download (Section 7.3)
Furthermore, it shows using these templates with two images.
{ {
/ authentication-wrapper / 2:h'81586fd28443a10126a0582482025820ecc / authentication-wrapper / 2:h'81588fd28443a10126a0584482025840323
95235f2ab00b9912f8189b213b3e4ade42b792f491644e76004cd2ba87dc8584093952 1306231323835306332333930393164386538326330653965393130363632623638616
6b77d63dac2e138bf074aac757c5f010e8b2cf3ae9fcbba4cafc2d0f81c9ae46bc973c 33834323435386136343138653333663637303165643538333432635840b5b8cb30c2b
c0565410a1cb6bf10d2b3d0a2865392255cc4288d0337af3de837' / [ bb646c4d32426d72768668d6d6af54c26ac46c4020ca37ada47b9468340b4d0b2ddd15
h'd28443a10126a0582482025820ecc95235f2ab00b9912f8189b213b3e4ad db824a7e6b0bc233e753940dfb7131fa145ddc456da3cf6' / [
e42b792f491644e76004cd2ba87dc85840939526b77d63dac2e138bf074aac757c5f01 h'd28443a10126a05844820258403231306231323835306332333930393164
0e8b2cf3ae9fcbba4cafc2d0f81c9ae46bc973cc0565410a1cb6bf10d2b3d0a2865392 3865383263306539653931303636326236386163383432343538613634313865333366
255cc4288d0337af3de837' / 18([ 3637303165643538333432635840b5b8cb30c2bbb646c4d32426d72768668d6d6af54c
26ac46c4020ca37ada47b9468340b4d0b2ddd15db824a7e6b0bc233e753940dfb7131f
a145ddc456da3cf6' / 18([
/ protected / h'a10126' / { / protected / h'a10126' / {
/ alg / 1:-7 / "ES256" /, / alg / 1:-7 / "ES256" /,
} /, } /,
/ unprotected / { / unprotected / {
}, },
/ payload / h'82025820ecc95235f2ab00b9912f8189b213b3e4 / payload / h'8202584032313062313238353063323339303931
ade42b792f491644e76004cd2ba87dc8' / [ 6438653832633065396539313036363262363861633834323435386136343138653333
66363730316564353833343263' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes / h'3231306231323835306332333930393
h'"ecc95235f2ab00b9912f8189b213b3e4ade42b792f491644e76004cd2ba87dc8"'
1643865383263306539653931303636326236386163383432343538613634313865333
366363730316564353833343263'
] /, ] /,
/ signature / h'"939526b77d63dac2e138bf074aac757c5f010 / signature / h'b5b8cb30c2bbb646c4d32426d72768668d6d6a
e8b2cf3ae9fcbba4cafc2d0f81c9ae46bc973cc0565410a1cb6bf10d2b3d0a28653922 f54c26ac46c4020ca37ada47b9468340b4d0b2ddd15db824a7e6b0bc233e753940dfb7
55cc4288d0337af3de837"' 131fa145ddc456da3cf6'
]) / ]) /
] /, ] /,
/ manifest / 3:h'a701010205035865a2024782814100814101045858880c001 / manifest / 3:h'a601010205035895a202828141008141010458898c0c0014a
4a40150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f 40150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2a
2ab450358248202582000112233445566778899aabbccddeeff0123456789abcdeffed b450358248202582000112233445566778899aabbccddeeff0123456789abcdeffedcb
cba98765432100e1987d001f602f6085823840c0113a115781b687474703a2f2f65786 a98765432100e1987d0010f020f0c0114a2035824820258200123456789abcdeffedcb
16d706c652e636f6d2f66696c652e62696e094b880c0013a1160116f603f60a45840c0 a987654321000112233445566778899aabbccddeeff0e1a00012c2209584f900c0013a
003f60c45840c0017f6' / { 115781c687474703a2f2f6578616d706c652e636f6d2f66696c65312e62696e1502030
f0c0113a115781c687474703a2f2f6578616d706c652e636f6d2f66696c65322e62696
e1502030f0a49880c00030f0c01030f0c47860c0017021702' / {
/ manifest-version / 1:1, / manifest-version / 1:1,
/ manifest-sequence-number / 2:5, / manifest-sequence-number / 2:5,
/ common / 3:h'a2024782814100814101045858880c0014a40150fa6b4a5 / common / 3:h'a202828141008141010458898c0c0014a40150fa6b4a53d
3d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab45035824820 5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab4503582482025
2582000112233445566778899aabbccddeeff0123456789abcdeffedcba98765432100 82000112233445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1
e1987d001f602f6' / { 987d0010f020f0c0114a2035824820258200123456789abcdeffedcba9876543210001
/ components / 2:h'82814100814101' / [ 12233445566778899aabbccddeeff0e1a00012c22' / {
[h'"00"'] , / components / 2:[
[h'"01"'] [h'00'] ,
] /, [h'01']
/ common-sequence / 4:h'880c0014a40150fa6b4a53d5ad5fdfbe9d ],
/ common-sequence / 4:h'8c0c0014a40150fa6b4a53d5ad5fdfbe9d
e663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112233 e663e4d41ffe02501492af1425695e48bf429b2d51f2ab450358248202582000112233
445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d001f602 445566778899aabbccddeeff0123456789abcdeffedcba98765432100e1987d0010f02
f6' / [ 0f0c0114a2035824820258200123456789abcdeffedcba987654321000112233445566
778899aabbccddeeff0e1a00012c22' / [
/ directive-set-component-index / 12,0 , / directive-set-component-index / 12,0 ,
/ directive-override-parameters / 20,{ / directive-override-parameters / 20,{
/ vendor-id / / vendor-id /
1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf- 1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf-
be9d-e663e4d41ffe /, be9d-e663e4d41ffe /,
/ class-id / / class-id /
2:h'"1492af1425695e48bf429b2d51f2ab45"' / 2:h'"1492af1425695e48bf429b2d51f2ab45"' /
1492af14-2569-5e48-bf42-9b2d51f2ab45 /, 1492af14-2569-5e48-bf42-9b2d51f2ab45 /,
/ image-digest / 3:h'8202582000112233445566778899a / image-digest / 3:h'8202582000112233445566778899a
abbccddeeff0123456789abcdeffedcba9876543210' / [ abbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /, / algorithm-id / 2 / "sha256" /,
/ digest-bytes / / digest-bytes /
h'"00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210"' h'00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210'
] /, ] /,
/ image-size / 14:34768, / image-size / 14:34768,
} , } ,
/ condition-vendor-identifier / 1,F6 / nil / , / condition-vendor-identifier / 1,15 ,
/ condition-class-identifier / 2,F6 / nil / / condition-class-identifier / 2,15 ,
/ directive-set-component-index / 12,1 ,
/ directive-override-parameters / 20,{
/ image-digest / 3:h'820258200123456789abcdeffedcb
a987654321000112233445566778899aabbccddeeff' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'0123456789abcdeffedcba987654321000112233445566778899aabbccddeeff'
] /,
/ image-size / 14:76834,
}
] /, ] /,
} /, } /,
/ payload-fetch / 8:h'840c0113a115781b687474703a2f2f6578616d70 / install / 9:h'900c0013a115781c687474703a2f2f6578616d706c652e
6c652e636f6d2f66696c652e62696e' / [ 636f6d2f66696c65312e62696e1502030f0c0113a115781c687474703a2f2f6578616d
/ directive-set-component-index / 12,1 , 706c652e636f6d2f66696c65322e62696e1502030f' / [
/ directive-set-parameters / 19,{
/ uri / 21:'http://example.com/file.bin',
}
] /,
/ install / 9:h'880c0013a1160116f603f6' / [
/ directive-set-component-index / 12,0 , / directive-set-component-index / 12,0 ,
/ directive-set-parameters / 19,{ / directive-set-parameters / 19,{
/ source-component / 22:1 / [h'"01"'] /, / uri / 21:'http://example.com/file1.bin',
} , } ,
/ directive-copy / 22,F6 / nil / , / directive-fetch / 21,2 ,
/ condition-image-match / 3,F6 / nil / / condition-image-match / 3,15 ,
/ directive-set-component-index / 12,1 ,
/ directive-set-parameters / 19,{
/ uri / 21:'http://example.com/file2.bin',
} ,
/ directive-fetch / 21,2 ,
/ condition-image-match / 3,15
] /, ] /,
/ validate / 10:h'840c0003f6' / [ / validate / 10:h'880c00030f0c01030f' / [
/ directive-set-component-index / 12,0 , / directive-set-component-index / 12,0 ,
/ condition-image-match / 3,F6 / nil / / condition-image-match / 3,15 ,
/ directive-set-component-index / 12,1 ,
/ condition-image-match / 3,15
] /, ] /,
/ run / 12:h'840c0017f6' / [ / run / 12:h'860c0017021702' / [
/ directive-set-component-index / 12,0 , / directive-set-component-index / 12,0 ,
/ directive-run / 23,F6 / nil / / directive-run / 23,2 ,
/ directive-run / 23,2
] /, ] /,
} /, } /,
} }
Total size of manifest without COSE authentication object: 178 Total size of Envelope without COSE authentication object: 264
Manifest: Envelope:
a10358aea701010205035865a2024782814100814101045858880c0014a4 a103590103a601010205035895a202828141008141010458898c0c0014a4
0150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf42 0150fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf42
9b2d51f2ab450358248202582000112233445566778899aabbccddeeff01 9b2d51f2ab450358248202582000112233445566778899aabbccddeeff01
23456789abcdeffedcba98765432100e1987d001f602f6085823840c0113 23456789abcdeffedcba98765432100e1987d0010f020f0c0114a2035824
a115781b687474703a2f2f6578616d706c652e636f6d2f66696c652e6269 820258200123456789abcdeffedcba987654321000112233445566778899
6e094b880c0013a1160116f603f60a45840c0003f60c45840c0017f6 aabbccddeeff0e1a00012c2209584f900c0013a115781c687474703a2f2f
6578616d706c652e636f6d2f66696c65312e62696e1502030f0c0113a115
Total size of manifest with COSE authentication object: 295 781c687474703a2f2f6578616d706c652e636f6d2f66696c65322e62696e
1502030f0a49880c00030f0c01030f0c47860c0017021702
Manifest with COSE authentication object:
a202587281586fd28443a10126a0582482025820ecc95235f2ab00b9912f
8189b213b3e4ade42b792f491644e76004cd2ba87dc85840939526b77d63
dac2e138bf074aac757c5f010e8b2cf3ae9fcbba4cafc2d0f81c9ae46bc9
73cc0565410a1cb6bf10d2b3d0a2865392255cc4288d0337af3de8370358
aea701010205035865a2024782814100814101045858880c0014a40150fa
6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51
f2ab450358248202582000112233445566778899aabbccddeeff01234567
89abcdeffedcba98765432100e1987d001f602f6085823840c0113a11578
1b687474703a2f2f6578616d706c652e636f6d2f66696c652e62696e094b
880c0013a1160116f603f60a45840c0003f60c45840c0017f6
B.7. Example 6: Two Images
Compatibility test, 2 images, simultaneous download and installation,
and secure boot.
{
/ authentication-wrapper / 2:h'81586fd28443a10126a0582482025820732
5a7d3acf130d161810c4874f275f658970b7bc5a63cda56e9920a4aaba3a3584088cb9
6211bcc4cdb59cb0022cb213017b2d117bac1a5460ae92903acc196282f7888368bf0a
065756e43f53cdbeee367e9523312063e8eaad0889a7cee371859' / [
h'd28443a10126a05824820258207325a7d3acf130d161810c4874f275f658
970b7bc5a63cda56e9920a4aaba3a3584088cb96211bcc4cdb59cb0022cb213017b2d1
17bac1a5460ae92903acc196282f7888368bf0a065756e43f53cdbeee367e952331206
3e8eaad0889a7cee371859' / 18([
/ protected / h'a10126' / {
/ alg / 1:-7 / "ES256" /,
} /,
/ unprotected / {
},
/ payload / h'820258207325a7d3acf130d161810c4874f275f6
58970b7bc5a63cda56e9920a4aaba3a3' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'"7325a7d3acf130d161810c4874f275f658970b7bc5a63cda56e9920a4aaba3a3"'
] /,
/ signature / h'"88cb96211bcc4cdb59cb0022cb213017b2d11
7bac1a5460ae92903acc196282f7888368bf0a065756e43f53cdbeee367e9523312063
e8eaad0889a7cee371859"'
]) /
] /,
/ manifest / 3:h'a50101020303589da20244818141000458938814a20150fa6
b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450f825
8308405f614a20358248202582000112233445566778899aabbccddeeff0123456789a
bcdeffedcba98765432100e1987d058328405f614a2035824820258200123456789abc
deffedcba987654321000112233445566778899aabbccddeeff0e1a00012c2201f602f
6095853860f8258248405f613a115781c687474703a2f2f6578616d706c652e636f6d2
f66696c65312e62696e58248405f613a115781c687474703a2f2f6578616d706c652e6
36f6d2f66696c65322e62696e15f603f60a438203f6' / {
/ manifest-version / 1:1,
/ manifest-sequence-number / 2:3,
/ common / 3:h'a20244818141000458938814a20150fa6b4a53d5ad5fdfb
e9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450f8258308405f614a20
358248202582000112233445566778899aabbccddeeff0123456789abcdeffedcba987
65432100e1987d058328405f614a2035824820258200123456789abcdeffedcba98765
4321000112233445566778899aabbccddeeff0e1a00012c2201f602f6' / {
/ components / 2:h'81814100' / [
[h'"00"']
] /,
/ common-sequence / 4:h'8814a20150fa6b4a53d5ad5fdfbe9de663
e4d41ffe02501492af1425695e48bf429b2d51f2ab450f8258308405f614a203582482
02582000112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210
0e1987d058328405f614a2035824820258200123456789abcdeffedcba987654321000
112233445566778899aabbccddeeff0e1a00012c2201f602f6' / [
/ directive-override-parameters / 20,{
/ vendor-id /
1:h'"fa6b4a53d5ad5fdfbe9de663e4d41ffe"' / fa6b4a53-d5ad-5fdf-
be9d-e663e4d41ffe /,
/ class-id /
2:h'"1492af1425695e48bf429b2d51f2ab45"' /
1492af14-2569-5e48-bf42-9b2d51f2ab45 /,
} ,
/ directive-try-each / 15,[
h'8405f614a20358248202582000112233445566778899aabb
ccddeeff0123456789abcdeffedcba98765432100e1987d0' / [
/ condition-component-offset / 5,F6 / nil / ,
/ directive-override-parameters / 20,{
/ image-digest / 3:h'820258200011223344556
6778899aabbccddeeff0123456789abcdeffedcba9876543210' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'"00112233445566778899aabbccddeeff0123456789abcdeffedcba9876543210"'
] /,
/ image-size / 14:34768,
}
] / ,
h'8405f614a2035824820258200123456789abcdeffedcba98
7654321000112233445566778899aabbccddeeff0e1a00012c22' / [
/ condition-component-offset / 5,F6 / nil / ,
/ directive-override-parameters / 20,{
/ image-digest / 3:h'820258200123456789abc
deffedcba987654321000112233445566778899aabbccddeeff' / [
/ algorithm-id / 2 / "sha256" /,
/ digest-bytes /
h'"0123456789abcdeffedcba987654321000112233445566778899aabbccddeeff"'
] /,
/ image-size / 14:76834,
}
] /
] ,
/ condition-vendor-identifier / 1,F6 / nil / ,
/ condition-class-identifier / 2,F6 / nil /
] /,
} /,
/ install / 9:h'860f8258248405f613a115781c687474703a2f2f657861
6d706c652e636f6d2f66696c65312e62696e58248405f613a115781c687474703a2f2f
6578616d706c652e636f6d2f66696c65322e62696e15f603f6' / [
/ directive-try-each / 15,[
h'8405f613a115781c687474703a2f2f6578616d706c652e636f6d
2f66696c65312e62696e' / [
/ condition-component-offset / 5,F6 / nil / ,
/ directive-set-parameters / 19,{
/ uri / 21:'http://example.com/file1.bin',
}
] / ,
h'8405f613a115781c687474703a2f2f6578616d706c652e636f6d
2f66696c65322e62696e' / [
/ condition-component-offset / 5,F6 / nil / ,
/ directive-set-parameters / 19,{
/ uri / 21:'http://example.com/file2.bin',
}
] /
] ,
/ directive-fetch / 21,F6 / nil / ,
/ condition-image-match / 3,F6 / nil /
] /,
/ validate / 10:h'8203f6' / [
/ condition-image-match / 3,F6 / nil /
] /,
} /,
}
Total size of manifest without COSE authentication object: 261
Manifest:
a103590100a50101020303589da20244818141000458938814a20150fa6b
4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2
ab450f8258308405f614a20358248202582000112233445566778899aabb
ccddeeff0123456789abcdeffedcba98765432100e1987d058328405f614
a2035824820258200123456789abcdeffedcba9876543210001122334455
66778899aabbccddeeff0e1a00012c2201f602f6095853860f8258248405
f613a115781c687474703a2f2f6578616d706c652e636f6d2f66696c6531
2e62696e58248405f613a115781c687474703a2f2f6578616d706c652e63
6f6d2f66696c65322e62696e15f603f60a438203f6
Total size of manifest with COSE authentication object: 378 Total size of Envelope with COSE authentication object: 413
Manifest with COSE authentication object: Envelope with COSE authentication object:
a202587281586fd28443a10126a05824820258207325a7d3acf130d16181 a202589281588fd28443a10126a058448202584032313062313238353063
0c4874f275f658970b7bc5a63cda56e9920a4aaba3a3584088cb96211bcc 323339303931643865383263306539653931303636326236386163383432
4cdb59cb0022cb213017b2d117bac1a5460ae92903acc196282f7888368b 3435386136343138653333663637303165643538333432635840b5b8cb30
f0a065756e43f53cdbeee367e9523312063e8eaad0889a7cee3718590359 c2bbb646c4d32426d72768668d6d6af54c26ac46c4020ca37ada47b94683
0100a50101020303589da20244818141000458938814a20150fa6b4a53d5 40b4d0b2ddd15db824a7e6b0bc233e753940dfb7131fa145ddc456da3cf6
ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b2d51f2ab450f 03590103a601010205035895a202828141008141010458898c0c0014a401
8258308405f614a20358248202582000112233445566778899aabbccddee 50fa6b4a53d5ad5fdfbe9de663e4d41ffe02501492af1425695e48bf429b
ff0123456789abcdeffedcba98765432100e1987d058328405f614a20358 2d51f2ab450358248202582000112233445566778899aabbccddeeff0123
24820258200123456789abcdeffedcba9876543210001122334455667788 456789abcdeffedcba98765432100e1987d0010f020f0c0114a203582482
99aabbccddeeff0e1a00012c2201f602f6095853860f8258248405f613a1 0258200123456789abcdeffedcba987654321000112233445566778899aa
15781c687474703a2f2f6578616d706c652e636f6d2f66696c65312e6269 bbccddeeff0e1a00012c2209584f900c0013a115781c687474703a2f2f65
6e58248405f613a115781c687474703a2f2f6578616d706c652e636f6d2f 78616d706c652e636f6d2f66696c65312e62696e1502030f0c0113a11578
66696c65322e62696e15f603f60a438203f6 1c687474703a2f2f6578616d706c652e636f6d2f66696c65322e62696e15
02030f0a49880c00030f0c01030f0c47860c0017021702
C. Design Rational C. Design Rational
In order to provide flexible behavior to constrained devices, while In order to provide flexible behavior to constrained devices, while
still allowing more powerful devices to use their full capabilities, still allowing more powerful devices to use their full capabilities,
the SUIT manifest encodes the required behavior of a Recipient the SUIT manifest encodes the required behavior of a Recipient
device. Behavior is encoded as a specialized byte code, contained in device. Behavior is encoded as a specialized byte code, contained in
a CBOR list. This promotes a flat encoding, which simplifies the a CBOR list. This promotes a flat encoding, which simplifies the
parser. The information encoded by this byte code closely matches parser. The information encoded by this byte code closely matches
the operations that a device will perform, which promotes ease of the operations that a device will perform, which promotes ease of
skipping to change at page 80, line 42 skipping to change at page 103, line 42
Capability reporting is similarly simplified. A Recipient can report Capability reporting is similarly simplified. A Recipient can report
the Commands, Parameters, Algorithms, and Component Identifiers that the Commands, Parameters, Algorithms, and Component Identifiers that
it supports. This is sufficiently precise for a manifest author to it supports. This is sufficiently precise for a manifest author to
create a manifest that the Recipient can accept. create a manifest that the Recipient can accept.
The simplicity of design in the Recipient due to all of these The simplicity of design in the Recipient due to all of these
benefits allows even a highly constrained platform to use advanced benefits allows even a highly constrained platform to use advanced
update capabilities. update capabilities.
C.1. C.1 Design Rationale: Envelope
The Envelope is used instead of a COSE structure for several reasons:
1. This enables the use of Severable Elements (Section 8.8)
2. This enables modular processing of manifests, particularly with
large signatures.
3. This enables multiple authentication schemes.
4. This allows integrity verification by a dependent to be
unaffected by adding or removing authentication structures.
Modular processing is important because it allows a Manifest
Processor to iterate forward over an Envelope, processing Delegation
Chains and Authentication Blocks, retaining only intermediate values,
without any need to seek forward and backwards in a stream until it
gets to the Manifest itself. This allows the use of large, Post-
Quantum signatures without requiring retention of the signature
itself, or seeking forward and back.
Four authentication objects are supported by the Envelope:
- COSE_Sign_Tagged
- COSE_Sign1_Tagged
- COSE_Mac_Tagged
- COSE_Mac0_Tagged
The SUIT Envelope allows an Update Authority or intermediary to mix
and match any number of different authentication blocks it wants
without any concern for modifying the integrity of another
authentication block. This also allows the addition or removal of an
authentication blocks without changing the integrity check of the
Manifest, which is important for dependency handling. See
Section 6.2
C.2. C.2 Byte String Wrappers
Byte string wrappers are used in several places in the suit manifest.
The primary reason for wrappers it to limit the parser extent when
invoked at different times, with a possible loss of context.
The elements of the suit envelope are wrapped both to set the extents
used by the parser and to simplify integrity checks by clearly
defining the length of each element.
The common block is re-parsed in order to find components identifiers
from their indices, to find dependency prefixes and digests from
their identifiers, and to find the common sequence. The common
sequence is wrapped so that it matches other sequences, simplifying
the code path.
A severed SUIT command sequence will appear in the envelope, so it
must be wrapped as with all envelope elements. For consistency,
command sequences are also wrapped in the manifest. This also allows
the parser to discern the difference between a command sequence and a
SUIT_Digest.
Parameters that are structured types (arrays and maps) are also
wrapped in a bstr. This is so that parser extents can be set
correctly using only a reference to the beginning of the parameter.
This enables a parser to store a simple list of references to
parameters that can be retrieved when needed.
D. Implementation Conformance Matrix D. Implementation Conformance Matrix
This section summarizes the functionality a minimal implementation This section summarizes the functionality a minimal implementation
needs to offer to claim conformance to this specification, in the needs to offer to claim conformance to this specification, in the
absence of an application profile standard specifying otherwise. absence of an application profile standard specifying otherwise.
The subsequent table shows the conditions. The subsequent table shows the conditions.
+-------------------+-----------------+----------------+ +-------------------+-----------------+----------------+
| Name | Reference | Implementation | | Name | Reference | Implementation |
+-------------------+-----------------+----------------+ +-------------------+-----------------+----------------+
| Vendor Identifier | Section 9.8.3.1 | REQUIRED | | Vendor Identifier | Section 8.7.5.1 | REQUIRED |
| | | | | | | |
| Class Identifier | Section 9.8.3.1 | REQUIRED | | Class Identifier | Section 8.7.5.1 | REQUIRED |
| | | | | | | |
| Device Identifier | Section 9.8.3.1 | OPTIONAL | | Device Identifier | Section 8.7.5.1 | OPTIONAL |
| | | | | | | |
| Image Match | Section 9.8.3.2 | REQUIRED | | Image Match | Section 8.7.6.2 | REQUIRED |
| | | | | | | |
| Image Not Match | Section 9.8.3.3 | OPTIONAL | | Image Not Match | Section 8.7.6.3 | OPTIONAL |
| | | | | | | |
| Use Before | Section 9.8.3.4 | OPTIONAL | | Use Before | Section 8.7.6.4 | OPTIONAL |
| | | | | | | |
| Component Offset | Section 9.8.3.5 | OPTIONAL | | Component Offset | Section 8.7.6.5 | OPTIONAL |
| | | | | | | |
| Minimum Battery | Section 9.8.3.6 | OPTIONAL | | Minimum Battery | Section 8.7.6.6 | OPTIONAL |
| | | | | | | |
| Update Authorized | Section 9.8.3.7 | OPTIONAL | | Update Authorized | Section 8.7.6.7 | OPTIONAL |
| | | | | | | |
| Version | Section 9.8.3.8 | OPTIONAL | | Version | Section 8.7.6.8 | OPTIONAL |
| | | | | | | |
| Custom Condition | Section 9.8.3.9 | OPTIONAL | | Custom Condition | Section 8.7.6.9 | OPTIONAL |
+-------------------+-----------------+----------------+ +-------------------+-----------------+----------------+
The subsequent table shows the directives. The subsequent table shows the directives.
+-------------------+----------------+------------------------------+ +-------------------+----------------+------------------------------+
| Name | Reference | Implementation | | Name | Reference | Implementation |
+-------------------+----------------+------------------------------+ +-------------------+----------------+------------------------------+
| Set Component | Section | REQUIRED if more than one | | Set Component | Section 8.7.7. | REQUIRED if more than one |
| Index | 9.8.4.1 | component | | Index | 1 | component |
| | | | | | | |
| Set Dependency | Section | REQUIRED if dependencies | | Set Dependency | Section 8.7.7. | REQUIRED if dependencies |
| Index | 9.8.4.2 | used | | Index | 2 | used |
| | | | | | | |
| Abort | Section | OPTIONAL | | Abort | Section 8.7.7. | OPTIONAL |
| | 9.8.4.3 | | | | 3 | |
| | | | | | | |
| Try Each | Section | OPTIONAL | | Try Each | Section 8.7.7. | OPTIONAL |
| | 9.8.4.4 | | | | 4 | |
| | | | | | | |
| Process | Section | OPTIONAL | | Process | Section 8.7.7. | OPTIONAL |
| Dependency | 9.8.4.5 | | | Dependency | 5 | |
| | | | | | | |
| Set Parameters | Section | OPTIONAL | | Set Parameters | Section 8.7.7. | OPTIONAL |
| | 9.8.4.6 | | | | 6 | |
| | | | | | | |
| Override | Section | REQUIRED | | Override | Section 8.7.7. | REQUIRED |
| Parameters | 9.8.4.7 | | | Parameters | 7 | |
| | | | | | | |
| Fetch | Section | REQUIRED for Updater | | Fetch | Section 8.7.7. | REQUIRED for Updater |
| | 9.8.4.8 | | | | 8 | |
| | | | | | | |
| Copy | Section | OPTIONAL | | Copy | Section 8.7.7. | OPTIONAL |
| | 9.8.4.9 | | | | 10 | |
| | | | | | | |
| Run | Section | REQUIRED for Bootloader | | Run | Section 8.7.7. | REQUIRED for Bootloader |
| | 9.8.4.10 | | | | 11 | |
| | | | | | | |
| Wait For Event | Section | OPTIONAL | | Wait For Event | Section 8.7.7. | OPTIONAL |
| | 9.8.4.11 | | | | 12 | |
| | | | | | | |
| Run Sequence | Section | OPTIONAL | | Run Sequence | Section 8.7.7. | OPTIONAL |
| | 9.8.4.12 | | | | 13 | |
| | | | | | | |
| Swap | Section | OPTIONAL | | Swap | Section 8.7.7. | OPTIONAL |
| | 9.8.4.13 | | | | 14 | |
| | | |
| Fetch URI List | Section 8.7.7. | OPTIONAL |
| | 9 | |
+-------------------+----------------+------------------------------+ +-------------------+----------------+------------------------------+
The subsequent table shows the parameters. The subsequent table shows the parameters.
+------------------+------------------+----------------+ +------------------+------------------+----------------------+
| Name | Reference | Implementation | | Name | Reference | Implementation |
+------------------+------------------+----------------+ +------------------+------------------+----------------------+
| Vendor ID | Section 9.8.2.1 | REQUIRED | | Vendor ID | Section 8.7.5.2 | REQUIRED |
| | | | | | | |
| Class ID | Section 9.8.2.2 | REQUIRED | | Class ID | Section 8.7.5.3 | REQUIRED |
| | | | | | | |
| Image Digest | Section 9.8.2.3 | REQUIRED | | Image Digest | Section 8.7.5.5 | REQUIRED |
| | | | | | | |
| Image Size | Section 9.8.2.4 | REQUIRED | | Image Size | Section 8.7.5.6 | REQUIRED |
| | | | | | | |
| Use Before | Section 9.8.2.5 | OPTIONAL | | Use Before | Section 8.7.5.7 | RECOMMENDED |
| | | | | | | |
| Component Offset | Section 9.8.2.6 | OPTIONAL | | Component Offset | Section 8.7.5.8 | OPTIONAL |
| | | | | | | |
| Encryption Info | Section 9.8.2.7 | OPTIONAL | | Encryption Info | Section 8.7.5.9 | RECOMMENDED |
| | | | | | | |
| Compression Info | Section 9.8.2.8 | OPTIONAL | | Compression Info | Section 8.7.5.10 | RECOMMENDED |
| | | | | | | |
| Unpack Info | Section 9.8.2.9 | OPTIONAL | | Unpack Info | Section 8.7.5.11 | RECOMMENDED |
| | | | | | | |
| URI | Section 9.8.2.10 | OPTIONAL | | URI | Section 8.7.5.12 | REQUIRED for Updater |
| | | | | | | |
| Source Component | Section 9.8.2.11 | OPTIONAL | | Source Component | Section 8.7.5.13 | OPTIONAL |
| | | | | | | |
| Run Args | Section 9.8.2.12 | OPTIONAL | | Run Args | Section 8.7.5.14 | OPTIONAL |
| | | | | | | |
| Device ID | Section 9.8.2.13 | OPTIONAL | | Device ID | Section 8.7.5.4 | OPTIONAL |
| | | | | | | |
| Minimum Battery | Section 9.8.2.14 | OPTIONAL | | Minimum Battery | Section 8.7.5.15 | OPTIONAL |
| | | | | | | |
| Update Priority | Section 9.8.2.15 | OPTIONAL | | Update Priority | Section 8.7.5.16 | OPTIONAL |
| | | | | | | |
| Version | Section 9.8.2.16 | OPTIONAL | | Version Match | Section 8.7.5.17 | OPTIONAL |
| | | | | | | |
| Wait Info | Section 9.8.2.17 | OPTIONAL | | Wait Info | Section 8.7.5.18 | OPTIONAL |
| | | | | | | |
| URI List | Section 9.8.2.18 | OPTIONAL | | URI List | Section 8.7.5.19 | OPTIONAL |
| | | | | | | |
| Strict Order | Section 9.8.2.19 | OPTIONAL | | Strict Order | Section 8.7.5.21 | OPTIONAL |
| | | | | | | |
| Soft Failure | Section 9.8.2.20 | OPTIONAL | | Soft Failure | Section 8.7.5.22 | OPTIONAL |
| | | | | | | |
| Custom | Section 9.8.2.21 | OPTIONAL | | Custom | Section 8.7.5.23 | OPTIONAL |
+------------------+------------------+----------------+ +------------------+------------------+----------------------+
Authors' Addresses Authors' Addresses
Brendan Moran Brendan Moran
Arm Limited Arm Limited
EMail: Brendan.Moran@arm.com EMail: Brendan.Moran@arm.com
Hannes Tschofenig Hannes Tschofenig
Arm Limited Arm Limited
 End of changes. 488 change blocks. 
1737 lines changed or deleted 2860 lines changed or added

This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/