forked from suit-wg/suit-multiple-trust-domains
-
Notifications
You must be signed in to change notification settings - Fork 0
/
draft-ietf-suit-trust-domains.xml
1699 lines (1417 loc) · 92.4 KB
/
draft-ietf-suit-trust-domains.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
<!-- generated by https://github.com/cabo/kramdown-rfc version 1.6.31 (Ruby 3.2.2) -->
<!DOCTYPE rfc [
<!ENTITY nbsp " ">
<!ENTITY zwsp "​">
<!ENTITY nbhy "‑">
<!ENTITY wj "⁠">
]>
<?rfc rfcedstyle="yes"?>
<?rfc tocindent="yes"?>
<?rfc strict="yes"?>
<?rfc comments="yes"?>
<?rfc inline="yes"?>
<?rfc text-list-symbols="-o*+"?>
<?rfc docmapping="yes"?>
<?rfc toc_levels="4"?>
<rfc ipr="trust200902" docName="draft-ietf-suit-trust-domains-09" category="std" consensus="true" tocInclude="true" sortRefs="true" symRefs="true">
<front>
<title abbrev="SUIT Trust Domains">SUIT Manifest Extensions for Multiple Trust Domains</title>
<author initials="B." surname="Moran" fullname="Brendan Moran">
<organization>Arm Limited</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<author initials="K." surname="Takayama" fullname="Ken Takayama">
<organization>SECOM CO., LTD.</organization>
<address>
<email>[email protected]</email>
</address>
</author>
<date year="2024" month="December" day="04"/>
<area>Security</area>
<workgroup>SUIT</workgroup>
<keyword>Internet-Draft</keyword>
<abstract>
<t>This specification describes extensions to the SUIT Manifest format for
use in deployments with multiple trust domains. A device has more than
one trust domain when it enables delegation of different rights to
mutually distrusting entities for use for different purposes or
Components in the context of firmware or software update.</t>
</abstract>
</front>
<middle>
<section anchor="Introduction"><name>Introduction</name>
<t>Devices that go beyond single-signer update require more complex rules for deploying software updates. For example, devices may require:</t>
<t><list style="symbols">
<t>software Components from multiple software signing authorities.</t>
<t>a mechanism to remove an unneeded Component</t>
<t>single-object Dependencies</t>
<t>a partly encrypted Manifest so that distribution does not reveal private information</t>
<t>installation performed by a different execution mode than payload fetch</t>
</list></t>
<t>Dependency Manifests enable several additional use cases. In particular, they enable two or more entities who are trusted for different privileges to coordinate. This can be used in many scenarios. For example:</t>
<t><list style="symbols">
<t>A device may contain a processor in its radio in addition to the primary processor. These two processors may have separate Software with separate signing authorities. Dependencies allow the Software for the primary processor to reference a Manifest signed by a different authority.</t>
<t>A network operator may wish to provide local caching of Update Payloads. The network operator overrides the URI of a Payload by providing a dependent Manifest that references the original Manifest, but replaces its URI.</t>
<t>A device operator provides a device with some additional configuration. The device operator wants to test their configuration with each new Software version before releasing it. The configuration is delivered as a binary in the same way as a Software Image. The device operator references the Software Manifest from the Software author in their own Manifest which also defines the configuration.</t>
<t>An Author wants to entrust a Distributor to provide devices with firmware decryption keys, but not permit the Distributor to sign code. Dependencies allow the Distributor to deliver a device's decryption information without also granting code signing authority.</t>
<t>A Trusted Application Manager (TAM) wants to distribute personalisation information to a Trusted Execution Environment in addition to a Trusted Application (TA), but does not have code signing authority. Dependencies enable the TAM to construct an update containing the personalisation information and a dependency on the TA, but leaves the TA signed by the TA's Author.</t>
</list></t>
<t>By using Dependencies, Components such as Software, configuration, and other Resource data authenticated by different Trust Anchors can be delivered to devices.</t>
<t>These mechanisms are not part of the core Manifest specification, but they are needed for more advanced use cases, such as the architecture described in <xref target="I-D.ietf-teep-architecture"/>.</t>
<t>This specification extends the SUIT Manifest specification (<xref target="I-D.ietf-suit-manifest"/>).</t>
</section>
<section anchor="conventions-and-terminology"><name>Conventions and Terminology</name>
<t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",
"MAY", and "OPTIONAL" in this document are to be interpreted as
described in BCP 14 <xref target="RFC2119"/> <xref target="RFC8174"/> when, and only when, they
appear in all capitals, as shown here.</t>
<t>Additionally, the following terminology is used throughout this document:</t>
<t><list style="symbols">
<t>SUIT: Software Update for the Internet of Things, also the IETF working group for this standard.</t>
<t>Payload: A piece of information to be delivered. Typically Firmware/Software, configuration, or Resource data such as text or images.</t>
<t>Resource: A piece of information that is used to construct a Payload.</t>
<t>Manifest: A Manifest is a bundle of metadata about one or more Components for a device, where to
find them, and the devices to which they apply.</t>
<t>Envelope: A container with the Manifest, an authentication wrapper with cryptographic information protecting the Manifest, authorization information, and severable elements (see Section 5.1 of <xref target="I-D.ietf-suit-manifest"/>).</t>
<t>Update: One or more Manifests that describe one or more Payloads.</t>
<t>Update Authority: The owner of a cryptographic key used to sign Updates, trusted by Recipients.</t>
<t>Recipient: The system that receives and processes a Manifest.</t>
<t>Manifest Processor: A component of the Recipient that consumes Manifests and executes the Commands in the Manifest.</t>
<t>Component: An updatable logical block of the Firmware, Software, configuration, or data of the Recipient.</t>
<t>Component Set: A group of interdependent Components that must be updated simultaneously.</t>
<t>Command: A Condition or a Directive.</t>
<t>Condition: A test for a property of the Recipient or its Components.</t>
<t>Directive: An action for the Recipient to perform.</t>
<t>Trusted Invocation: A process by which a system ensures that only trusted code is executed, for example secure boot or launching a Trusted Application.</t>
<t>A/B Images: Dividing a Recipient's storage into two or more bootable Images, at different offsets, such that the active Image can write to the inactive Image(s).</t>
<t>Record: The result of a Command and any metadata about it.</t>
<t>Report: A list of Records.</t>
<t>Procedure: The process of invoking one or more sequences of Commands.</t>
<t>Update Procedure: A superset of Staging Procedure and Installation Procedure.</t>
<t>Staging Procedure: A procedure that fetches dependencies and images referenced by an Update and stores them to a Staging Area.</t>
<t>Installation Procedure: A procedure that installs dependencies and images stored in a Staging Area; copying (and optionally, transforming them) into an active Image storage location.</t>
<t>Invocation Procedure: A Procedure in which a Recipient verifies Dependencies and Images, loading Images, and invokes one or more Image.</t>
<t>Staging Area: A Component or group of Components that are used for transient storage of Images between fetch and installation. Images in this area are opaque, except for use by the Installation Procedure.</t>
<t>Software: Instructions and data that allow a Recipient to perform a useful function.</t>
<t>Firmware: Software that is typically changed infrequently, stored in nonvolatile memory, and small enough to apply to <xref target="RFC7228"/> Class 0-2 devices.</t>
<t>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.</t>
<t>Slot: One of several possible storage locations for a given Component, typically used in A/B Image systems</t>
<t>Abort: An event in which the Manifest Processor immediately halts execution of the current Procedure. It creates a Record of an error Condition.</t>
<t>Trust Anchor: A Trust Anchor, as defined in <xref target="RFC6024"/>, represents an
authoritative entity via a public key and associated data. The
public key is used to verify digital signatures, and the
associated data is used to constrain the types of information for
which the Trust Anchor is authoritative.</t>
</list></t>
</section>
<section anchor="changes-to-suit-workflow-model"><name>Changes to SUIT Workflow Model</name>
<t>The use of the features presented for use with multiple trust domains requires some augmentation of the workflow presented in the SUIT Manifest specification (<xref target="I-D.ietf-suit-manifest"/>):</t>
<t>One additional assumption is added for the Update Procedure:</t>
<t><list style="symbols">
<t>All Dependency Manifests must be present before any Payload is fetched.</t>
</list></t>
<t>One additional assumption is added to the Invocation Procedure:</t>
<t><list style="symbols">
<t>All Dependencies must be validated prior to loading.</t>
</list></t>
<t>Steps 3 and 5 are added to the expected installation workflow of a Recipient:</t>
<t><list style="numbers">
<t>Verify the signature of the Manifest.</t>
<t>Verify the applicability of the Manifest.</t>
<t>Resolve Dependencies.</t>
<t>Fetch Payload(s).</t>
<t>Verify Candidate.</t>
<t>Install Payload(s).</t>
</list></t>
<t>In addition, when multiple Manifests are used for an Update, each Manifest's steps occur in a lockstep fashion; all Manifests have Dependency resolution performed before any Manifest performs a Payload fetch, etc.</t>
</section>
<section anchor="metadata-structure-overview"><name>Changes to Manifest Metadata Structure</name>
<t>To accommodate the additional metadata needed to enable these features, the Envelope and Manifest have several new elements added.</t>
<t>The Envelope gains one more elements: Integrated Dependencies. The Common metadata section in the Manifest also gains a list of Dependencies.</t>
<t>The new metadata structure is shown below.</t>
<figure><artwork><![CDATA[
+-------------------------+
| Envelope |
+-------------------------+
| Authentication Block |
| Manifest --------------> +------------------------------+
| Severable Elements | | Manifest |
| Human-Readable Text | +------------------------------+
| CoSWID | | Structure Version |
| Integrated Dependencies | | Sequence Number |
| Integrated Payloads | | Reference to Full Manifest |
+-------------------------+ +------ Common Structure |
| +---- Command Sequences |
+-------------------------+ | | | Digests of Envelope Elements |
| Common Structure | <--+ | +------------------------------+
+-------------------------+ |
| Dependency Indices | +-> +-----------------------+
| Component IDs | | Command Sequence |
| Common Command Sequence ---------> +-----------------------+
+-------------------------+ | List of ( pairs of ( |
| * command code |
| * argument / |
| reporting policy |
| )) |
+-----------------------+
]]></artwork></figure>
</section>
<section anchor="dependencies"><name>Dependencies</name>
<t>A Dependency is another SUIT_Envelope that describes additional Components.</t>
<t>As described in <xref target="Introduction"/>, Dependencies enable several common use cases.</t>
<section anchor="required-checks"><name> Changes to Required Checks</name>
<t>This section augments the definitions in Required Checks (Section 6.2) of <xref target="I-D.ietf-suit-manifest"/>.</t>
<t>More checks are required when handling Dependencies. By default, any signature of a Dependency MUST be verified. However, there are some exceptions to this rule: where a device supports only one level of access (no ACLs defining which authorities have access to different Components/Commands/Parameters), it MAY choose to skip signature verification of Dependencies, since they are verified by digest. Where a device differentiates between trust levels, such as with an ACL, it MAY choose to defer the verification of signatures of Dependencies until the list of affected Components is known so that it can skip redundant signature verifications. For example, if a dependent's signer has access rights to all Components specified in a Dependency, then that Dependency does not require a signature verification. Similarly, if the signer of the dependent has full rights to the device, according to the ACL, then no signature verification is necessary on the Dependency.</t>
<t>Components that should be treated as Dependency Manifests are identified in the suit-common metadata. See <xref target="structure-change"/> for details.</t>
<t>If the Manifest contains more than one Component and/or Dependency, each Command sequence MUST begin with a Set Component Index Command.</t>
<t>If a Dependency is specified, then the Manifest processor MUST perform the following checks:</t>
<t><list style="numbers">
<t>The dependent MUST populate all Command sequences for the current Procedure (Update or Invoke).</t>
<t>At the end of each section in the dependent: The corresponding section in each Dependency has been executed.</t>
</list></t>
<t>If the interpreter does not support Dependencies and a Manifest specifies a Dependency, then the interpreter MUST Abort.</t>
<t>If a Recipient supports groups of interdependent Components (a Component Set), then it SHOULD verify that all Components in the Component Set are specified by a single Manifest and all its Dependencies that together:</t>
<t><list style="numbers">
<t>have sufficient permissions imparted by their signatures</t>
<t>specify a digest and a Payload for every Component in the Component Set.</t>
</list></t>
<t>The single dependent Manifest is sometimes called a Root Manifest.</t>
</section>
<section anchor="structure-change"><name>Changes to Manifest Structure</name>
<t>This section augments the Manifest Structure (Section 8.4) in <xref target="I-D.ietf-suit-manifest"/>.</t>
<section anchor="manifest-id"><name>Manifest Component ID</name>
<t>In complex systems, it may not always be clear where the Root Manifest should be stored; this is particularly complex when a system has multiple, independent Root Manifests. The Manifest Component ID resolves this contention. The manifest-component-id is intended to be used by the Root Manifest. When a Dependency Manifest also declares a Component ID, the Dependency Manifest's Component ID is overridden by the Component ID declared by the dependent.</t>
<t>The following CDDL describes the Manifest Component ID:</t>
<figure><sourcecode type="CDDL"><![CDATA[
$$SUIT_Manifest_Extensions //=
(suit-manifest-component-id => SUIT_Component_Identifier)
]]></sourcecode></figure>
</section>
<section anchor="SUIT_Dependencies"><name>SUIT_Dependencies Manifest Element</name>
<t>The suit-common section, as described in <xref target="I-D.ietf-suit-manifest"/>, Section 8.4.5 is extended with a map of Component indices that indicate a Dependency Manifest. The keys of the map are the Component indices and the values of the map are any extra metadata needed to describe those Dependency Manifests.</t>
<t>Because some operations treat Dependency Manifests differently from other Components, it is necessary to identify them. SUIT_Dependencies identifies which Components from suit-components (see Section 8.4.5 of <xref target="I-D.ietf-suit-manifest"/>) are to be treated as Dependency Manifest Envelopes. SUIT_Dependencies is a map of Components, referenced by Component Index. Optionally, a Component prefix or other metadata may be delivered with the Component index. The CDDL for suit-dependencies is shown below:</t>
<figure><sourcecode type="CDDL"><![CDATA[
$$SUIT_Common-extensions //= (
suit-dependencies => SUIT_Dependencies
)
SUIT_Dependencies = {
+ uint => SUIT_Dependency_Metadata
}
SUIT_Dependency_Metadata = {
? suit-dependency-prefix => SUIT_Component_Identifier
* $$SUIT_Dependency_Extensions
}
]]></sourcecode></figure>
<t>If no extended metadata is needed for an extension, SUIT_Dependency_Metadata is an empty map (this is the same encoding size as a null). SUIT_Dependencies MUST be sorted according to CBOR canonical encoding.</t>
<t>The Components specified by SUIT_Dependency will contain a Manifest Envelope that describes a Dependency of the current Manifest. The Manifest is identified, but 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.</t>
<t>When executing suit-condition-image-match over a Component that is designated in SUIT_Dependency, the digest MUST be computed over just the bstr-wrapped SUIT_Manifest contained in the Manifest Envelope designated by the Component Index. This enables a Dependency reference to uniquely identify a particular Manifest structure. This is identical to the digest that is present as the first element of the suit-authentication-block in the Dependency's Envelope. The digest is calculated over the Manifest structure to ensure that removing a signature from a Manifest does not break Dependencies due to missing signature elements. This is also necessary to support the trusted intermediary use case, where an intermediary re-signs the Manifest, removing the original signature, potentially with a different algorithm, or trading COSE_Sign for COSE_Mac.</t>
<t>The suit-dependency-prefix element contains a SUIT_Component_Identifier (see Section 8.4.5.1 of <xref target="I-D.ietf-suit-manifest"/>). This specifies the scope at which the Dependency operates. This allows the Dependency to be forwarded on to a Component that is capable of parsing its own Manifests. It also allows one Manifest to be deployed to multiple dependent Recipients without those Recipients needing consistent Component hierarchy. This element is OPTIONAL for Recipients to implement.</t>
<t>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.</t>
<t>A Dependency prefix can also be used to indicate when a Dependency Manifest needs to be processed by a secondary Manifest processor, as described in <xref target="hierarchical-interpreters"/>.</t>
</section>
</section>
<section anchor="changes-to-abstract-machine-description"><name>Changes to Abstract Machine Description</name>
<t>This section augments the Abstract Machine Description (Section 6.4) in <xref target="I-D.ietf-suit-manifest"/>.
With the addition of Dependencies, some changes are necessary to the abstract machine, outside the typical scope of added Commands. These changes alter the behaviour of an existing Command and way that the parser processes Manifests:</t>
<t><list style="symbols">
<t>Five new Commands are introduced: <list style="symbols">
<t>Set Parameters</t>
<t>Process Dependency</t>
<t>Is Dependency</t>
<t>Dependency Integrity</t>
<t>Unlink</t>
</list></t>
<t>Dependency Manifests are also Components. All Commands may target Dependency Manifests as well as Components, with one exception: process Dependency. Commands defined outside of this draft and <xref target="I-D.ietf-suit-manifest"/> MAY have additional restrictions.</t>
<t>Dependencies are processed in lockstep with the Root Manifest. This means that every Dependency's current Command sequence must be executed before a dependent's later Command sequence may be executed. For example, every Dependency's Dependency Resolution step MUST be executed before any dependent's Payload fetch step.</t>
<t>When a Manifest Processor supports multiple independent Components, they MAY have shared Dependencies.</t>
<t>When a Manifest Processor supports shared Dependencies, it MUST support reference counting of those Dependencies.</t>
<t>When reference counting is used, Components MUST NOT be overwritten. The Manifest Uninstall section must be called, then the component MUST be Unlinked.</t>
</list></t>
</section>
<section anchor="processing-dependencies"><name>Processing Dependencies</name>
<t>As described in <xref target="required-checks"/>, each Manifest must invoke each of its Dependencies' sections from the corresponding section of the dependent. Any changes made to Parameters by the Dependency persist in the dependent.</t>
<t>When a Process Dependency Command is encountered, the Manifest processor:</t>
<t><list style="numbers">
<t>Checks whether the map of Dependencies contains an entry for the current Component Index. If not present, it causes an immediate Abort.</t>
<t>Checks whether the Dependency has been the target of a Dependency integrity check. If not, it causes an immediate Abort.</t>
<t>Loads the specified Component as a Dependency Manifest Envelope.</t>
<t>Authenticates the Dependency Manifest.</t>
<t>Executes the common-sequence section of the Dependency Manifest.</t>
<t>Executes the section of the Dependency Manifest that corresponds to the currently executing section of the dependent.</t>
</list></t>
<t>If the specified Dependency does not contain the current section, Process Dependency succeeds immediately.</t>
<t>The interpreter also performs the checks described in <xref target="required-checks"/> to ensure that the dependent is processing the Dependency correctly.</t>
<section anchor="hierarchical-interpreters"><name>Multiple Manifest Processors</name>
<t>When a system has multiple trust domains, each domain might require independent verification of authenticity or security policies. Trust domains might be divided by separation technology such as Arm TrustZone, Intel SGX, or another Trusted Execution Environment (TEE) technology. Trust domains might also be divided into separate processors and memory spaces, with a communication interface between them.</t>
<t>For example, an application processor may have an attached communications module that contains a processor. The communications module might require metadata signed by a specific Trust Authority for regulatory approval. This may be a different Trust Authority than the application processor.</t>
<t>When there are two or more trust domains, a Manifest processor might be required in each. The first Manifest processor is the normal Manifest processor as described for the Recipient in Section 6 of <xref target="I-D.ietf-suit-manifest"/>. 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, and 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.</t>
<t>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.</t>
<t>This mechanism ensures that the two or more Manifest processors do not need to trust each other, except in a very limited case. When Parameter setting across trust domains is used, it must be very carefully considered. Only Parameters that do not have an effect on security properties should be allowed. The Dependency Manifest MAY control which Parameters are allowed to be set by using the Override Parameters Directive. The second Manifest processor MAY also control which Parameters may be set by the first Manifest processor by means of an ACL that lists the allowed Parameters. For example, a URI may be set by a dependent without a substantial impact on the security properties of the Manifest.</t>
</section>
</section>
<section anchor="suit-dependency-resolution"><name>Dependency Resolution</name>
<t>The Dependency Resolution Command Sequence is a container for the Commands needed to acquire and process the Dependencies of the current Manifest. All Dependency Manifests SHOULD be fetched before any Payload is fetched to ensure that all Manifests are available and authenticated before any of the (larger) Payloads are acquired.</t>
</section>
<section anchor="added-and-modified-commands"><name>Added and Modified Commands</name>
<t>All Commands are modified in that they can also target Dependencies. However, Set Component Index has a larger modification.</t>
<texttable>
<ttcol align='left'>Command Name</ttcol>
<ttcol align='left'>Semantic of the Operation</ttcol>
<c>Set Parameters</c>
<c>current.params[k] := v if not k in current.params for-each k,v in arg</c>
<c>Process Dependency</c>
<c>exec(current[common]); exec(current[current-segment])</c>
<c>Dependency Integrity</c>
<c>verify(current, current.params[image-digest])</c>
<c>Is Dependency</c>
<c>assert(current exists in Dependencies)</c>
<c>Unlink</c>
<c>unlink(current)</c>
</texttable>
<section anchor="suit-directive-set-parameters"><name>suit-directive-set-parameters</name>
<t>Similar to suit-directive-override-parameters, suit-directive-set-parameters allows the Manifest to configure behavior of future Directives by changing Parameters that are read by those Directives. Set Parameters is for use when Dependencies are used because it allows a Manifest to modify the behavior of its Dependencies.</t>
<t>Available Parameters are defined in <xref target="I-D.ietf-suit-manifest"/>, section 8.4.8.</t>
<t>If a Parameter is already set, suit-directive-set-parameters will skip setting the Parameter to its argument. This allows dependent Manifests to change the behavior of a Manifest, a Dependency that wishes to enforce a specific value of a Parameter MAY use suit-directive-override-parameters instead.</t>
<t>suit-directive-set-parameters does not specify a reporting policy.</t>
</section>
<section anchor="suit-directive-process-dependency"><name>suit-directive-process-dependency</name>
<t>Execute the Commands in the common section of the current Dependency, followed by the Commands in the equivalent section of the current Dependency. For example, if the current section is "Payload Fetch," this will execute "Common metadata" in the current Dependency, then "Payload Fetch" in the current Dependency. Once this is complete, the Command following suit-directive-process-dependency will be processed.</t>
<t>If the current Component index does not have an entry in the suit-dependencies map, then this Command MUST Abort.</t>
<t>If the current Component index has not been the target of a suit-condition-dependency-integrity, then this Command MUST Abort.</t>
<t>If the current Component is True, then this Directive applies to all Dependencies. If the current section is "Common metadata," then the Command sequence MUST Abort.</t>
<t>When SUIT_Process_Dependency completes, it forwards the last status code that occurred in the Dependency.</t>
</section>
<section anchor="suit-condition-is-dependency"><name>suit-condition-is-dependency</name>
<t>Check whether the current Component index is present in the Dependency list. If the current Component is in the Dependency list, suit-condition-is-dependency succeeds. Otherwise, it fails. This can be used along with component-id = True to act on all Dependencies or on all non-Dependency Components. See <xref target="creating-manifests"/> for more details.</t>
</section>
<section anchor="suit-condition-dependency-integrity"><name>suit-condition-dependency-integrity</name>
<t>Verify the integrity of a Dependency Manifest. When a Manifest Processor executes suit-condition-dependency-integrity, it performs the following operations:</t>
<t><list style="numbers">
<t>Verify the signature of the Dependency's suit-authentication-wrapper.</t>
<t>Compare the Dependency's suit-authentication-wrapper digest to the dependent's suit-parameter-image-digest</t>
<t>Verify the Dependency Manifest against the Depedency's suit-authentication-wrapper digest</t>
</list></t>
<t>If any of these steps fails, the Manifest Process MUST immediately Abort.</t>
<t>The Manifest Processor MAY cache the results of these operations for later use from the context of the current Manifest. The Manifest Processor MUST NOT use cached results from any other Manifest context. If the Manifest Processor caches the results of these checks, it MUST eliminate this cache if any Fetch, or Copy operation targets the Dependency Manifest's Component ID.</t>
</section>
<section anchor="suit-directive-unlink"><name>suit-directive-unlink</name>
<t>A manifest processor that supports multiple independent root manifests
MUST support suit-directive-unlink. When a Component is no longer
needed, the Manifest processor unlinks the Component to inform the
Manifest processor that it is no longer needed.</t>
<t>If a Manifest is no longer needed, the Manifest Processor unlinks it.
This causes the Manifest Processor to execute the suit-uninstall section
of the unlinked Manifest, after which it decrements the reference count
of the unlinked Manifest. The suit-uninstall section of a manifest
typically contains an unlink of all its dependencies and components.</t>
<t>All components, including Manifests must be unlinked before deletion
or overwrite. If the
reference count of a component is non-zero, any command that alters
that component MUST cause an immediate ABORT. Affected commands are:</t>
<t><list style="symbols">
<t>suit-directive-copy</t>
<t>suit-directive-fetch</t>
<t>suit-directive-write</t>
</list></t>
<t>The unlink Command decrements an implementation-defined reference counter. This reference counter MUST persist across restarts. The reference counter MUST NOT be decremented by a given Manifest more than once, and the Manifest processor must enforce this. The Manifest processor MAY choose to ignore an Unlink Directive depending on device policy.</t>
<t>When the reference counter of a Manifest reaches zero, the suit-uninstall Command sequence is invoked (see <xref target="suit-uninstall"/>).</t>
<t>suit-directive-unlink is OPTIONAL to implement in Manifest processors,
but Manifest processors that support multiple independent Root Manifests
MUST support suit-directive-unlink.</t>
</section>
</section>
</section>
<section anchor="suit-uninstall"><name>Uninstall</name>
<t>In some systems, particularly with multiple, independent, optional Components, it may be that there is a need to uninstall the Components that have been installed by a Manifest. Where this is expected, the uninstall Command sequence can provide the sequence needed to cleanly remove the Components defined by the Manifest and its Dependencies. In general, the suit-uninstall Command Sequence will contain primarily unlink Directives.</t>
<t>WARNING: This can cause faults where there are loose Dependencies (e.g., version range matching, see <xref target="I-D.ietf-suit-update-management"/>), since a Component can be removed while it is depended upon by another Component. To avoid Dependency faults, a Manifest author MAY use explicit Dependencies where possible, or a Manifest processor MAY track references to loose Dependencies via reference counting in the same way as explicit Dependencies, as described in <xref target="suit-directive-unlink"/>.</t>
<t>The suit-uninstall Command Sequence is not severable, since it must always be available to enable uninstalling.</t>
</section>
<section anchor="staging-and-installation"><name>Staging and Installation</name>
<t>In order to coordinate between download and installation in different trust domains, the Update Procedure defined in <xref target="I-D.ietf-suit-manifest"/>, Section 8.4.6 is divided into two sub-procedures:</t>
<t><list style="symbols">
<t>The Staging Procedure: This procedure is responsible for dependency resolution and acquiring all payloads required for the Update to proceed. It is composed of two command sequences <list style="symbols">
<t>suit-dependency-resolution</t>
<t>suit-payload-fetch</t>
</list></t>
<t>The Installation Procedure: This procedure is responsible for verifying staged components and installing them. It is composed of: <list style="symbols">
<t>suit-candidate-verification</t>
<t>suit-install</t>
</list></t>
</list></t>
<t>This extension is backwards compatible when used with a Manifest Processor that supports the Update Procedure but = does not support the Staging Procedure and Installation Procedure: the payload-fetch command sequence already contains suit-condition-image tests for each payload (see <xref target="I-D.ietf-suit-manifest"/>, section 7.3) which means that images are already validated when suit-install is invoked. This makes suit-candidate-verification OPTIONAL to implement and OPTIONAL to parse.</t>
<t>The Staging and Installation Procedures are only required when Staging occurs in a different trust domain to Installation.</t>
<section anchor="suit-candidate-verification"><name>suit-candidate-verification</name>
<t>This command sequence is responsible for verifying that all elements of an update are present and correct prior to installation. This is only required when Installation occurs in a trust domain different from Staging, such as an installer invoked by the bootloader.</t>
</section>
</section>
<section anchor="creating-manifests"><name>Creating Manifests</name>
<t>This section details a set of templates for creating Manifests. These templates explain which Parameters, Commands, and orders of Commands are necessary to achieve a stated goal.</t>
<section anchor="template-dependency"><name>Dependency Template</name>
<t>The goal of the Dependency template is to obtain, verify, and process a Dependency Manifest as appropriate.</t>
<t>The following Commands are added to the shared sequence:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for digest (see Section 8.4.8.6 of <xref target="I-D.ietf-suit-manifest"/>). Note that the digest MUST match the SUIT_Digest in the Dependency's suit-authentication-block (see Section 8.3 of <xref target="I-D.ietf-suit-manifest"/>).</t>
</list></t>
<t>The following Commands are placed into the Dependency resolution sequence:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for a URI (see Section 8.4.8.10 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Fetch Directive (see Section 8.4.10.4 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Dependency Integrity Condition (see <xref target="suit-condition-dependency-integrity"/>)</t>
<t>Process Dependency Directive (see <xref target="suit-directive-process-dependency"/>)</t>
</list></t>
<t>Then, the validate sequence contains the following operations:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Dependency Integrity Condition (see <xref target="suit-condition-dependency-integrity"/>)</t>
<t>Process Dependency Directive (see <xref target="suit-directive-process-dependency"/>)</t>
</list></t>
<t>If any Dependency is declared, the dependent MUST populate all Command sequences for the current Procedure (Update or Invoke).</t>
<t>NOTE: Any changes made to Parameters in a Dependency persist in the dependent.</t>
<section anchor="integrated-dependencies"><name>Integrated Dependencies</name>
<t>An implementer MAY choose to place a Dependency's Envelope in the Envelope of its dependent. The dependent Envelope key for the Dependency Envelope MUST be a text string. The URI for the Dependency MUST match the text string key of the dependent's Envelope key. It is RECOMMENDED to make the text string key a resolvable URI so that a Dependency Manifest that is removed from the Envelope can still be fetched.</t>
</section>
</section>
<section anchor="template-encrypted-manifest"><name>Encrypted Manifest Template</name>
<t>The goal of the Encrypted Manifest template is to fetch and decrypt a Manifest so that it can be used as a Dependency. To use an encrypted Manifest, create a plaintext dependent, and add the encrypted Manifest as a Dependency. The dependent can include very little information.</t>
<t>NOTE: This template also requires the extensions defined in <xref target="I-D.ietf-suit-firmware-encryption"/>.</t>
<t>The following Commands are added to the shared sequence:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for digest (see Section 8.4.8.6 of <xref target="I-D.ietf-suit-manifest"/>). Note that the digest MUST match the SUIT_Digest in the Dependency's suit-authentication-block (see Section 8.3 of <xref target="I-D.ietf-suit-manifest"/>).</t>
</list></t>
<t>The following operations are placed into the Dependency resolution block:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for
<list style="symbols">
<t>URI (see Section 8.4.8.9 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Encryption Info (See <xref target="I-D.ietf-suit-firmware-encryption"/>)</t>
</list></t>
<t>Fetch Directive (see Section 8.4.10.4 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Dependency Integrity Condition (see <xref target="suit-condition-dependency-integrity"/>)</t>
<t>Process Dependency Directive (see <xref target="suit-directive-process-dependency"/>)</t>
</list></t>
<t>Then, the validate block contains the following operations:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Check Image Match Condition (see Section 8.4.9.2 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Process Dependency Directive (see <xref target="suit-directive-process-dependency"/>)</t>
</list></t>
<t>A plaintext Manifest and its encrypted Dependency may also form a composite Manifest (<xref target="integrated-dependencies"/>).</t>
</section>
<section anchor="template-override-encryption-info"><name>Overriding Encryption Info Template</name>
<t>The goal of overriding the Encryption Info template is to separate the role of generating encrypted Payload and Encryption Info with Key-Encryption Key addressing Section 3 of <xref target="I-D.ietf-suit-firmware-encryption"/>.</t>
<t>As an example, this template describes two manifests:
- The dependent Manifest created by the Distribution System contains Encryption Info, allowing the Device to generate the Content-Encryption Key.
- The dependency Manifest created by the Author contains Commands to decrypt the encrypted Payload using Encryption Info above and to validate the plaintext Payload with SUIT_Digest.</t>
<t>NOTE: This template also requires the extensions defined in <xref target="I-D.ietf-suit-firmware-encryption"/>.</t>
<t>The following operations are placed into the Dependency resolution block of dependent Manifest:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>) pointing at dependency Manifest</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for
<list style="symbols">
<t>Image Digest (see Section 8.4.8.6 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>URI (see Section 8.4.8.9 of <xref target="I-D.ietf-suit-manifest"/>) of dependency Manifest</t>
</list></t>
<t>Fetch Directive (see Section 8.4.10.4 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Dependency Integrity Condition (see <xref target="suit-condition-dependency-integrity"/>)</t>
</list></t>
<t>The following Commands are placed into the Fetch/Install block of dependent Manifest</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>) pointing at encrypted Payload</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for
<list style="symbols">
<t>URI (see Section 8.4.8.9 of <xref target="I-D.ietf-suit-manifest"/>)</t>
</list></t>
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>) pointing at dependency Manifest</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for
<list style="symbols">
<t>Encryption Info (See <xref target="I-D.ietf-suit-firmware-encryption"/>)</t>
</list></t>
<t>Process Dependency Directive (see <xref target="suit-directive-process-dependency"/>)</t>
</list></t>
<t>The following Commands are placed into the same block of dependency Manifest:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>) pointing at encrypted Payload</t>
<t>Fetch Directive (see Section 8.4.10.4 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>) pointing at to be decrypted Payload</t>
<t>Override Parameters Directive (see Section 8.4.10.3 of <xref target="I-D.ietf-suit-manifest"/>) for
<list style="symbols">
<t>Source Component (see Section 8.4.8.11 of <xref target="I-D.ietf-suit-manifest"/>) pointing at encrypted Payload</t>
</list></t>
<t>Copy Directive (see Section 8.4.10.5 of <xref target="I-D.ietf-suit-manifest"/>) consuming the Encryption Info above</t>
</list></t>
<t>The Distribution System can Set the Parameter URI in the Fetch/Install block of dependent Manifest if it wants to overwrite the URI of encrypted Payload.</t>
<t>Because the Author and the Distribution System have different roles and MAY be separate entities, it is highly RECOMMENDED to leverage permissions (see Section 9 of <xref target="I-D.ietf-suit-manifest"/>).
For example, The Device can protect itself from attacker who breaches the Distribution System by allowing only the Author's Manifest to modify the Component of (to be) decrypted Payload.</t>
</section>
<section anchor="operating-on-multiple-components"><name>Operating on Multiple Components</name>
<t>In order to produce compact encoding, it is efficient to perform operations on multiple Components simultaneously. Because Dependency Manifests and Component Images are processed at different times, there is a mechanism to distinguish between these elements: suit-condition-is-dependency. This can be used with suit-directive-try-each to perform operations just on Dependency Manifests or just on Component Images.</t>
<t>For example, to fetch all Dependency Manifests, the following Commands are added to the Dependency resolution block:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for a URI (see Section 8.4.8.9 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Component Index Directive, with argument "True" (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Try Each Directive
<list style="symbols">
<t>Sequence 0
<list style="symbols">
<t>Condition Is Dependency Manifest</t>
<t>Fetch</t>
<t>Dependency Integrity Condition (see <xref target="suit-condition-dependency-integrity"/>)</t>
<t>Process Dependency</t>
</list></t>
<t>Sequence 1 (Empty; no Commands, succeeds immediately)</t>
</list></t>
</list></t>
<t>Another example is to fetch and validate all Component Images. The Image fetch sequence contains the following Commands:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for a URI (see Section 8.4.8.9 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Component Index Directive, with argument "True" (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Try Each Directive
<list style="symbols">
<t>Sequence 0
<list style="symbols">
<t>Condition Is Dependency Manifest</t>
<t>Process Dependency</t>
</list></t>
<t>Sequence 1
<list style="symbols">
<t>Fetch</t>
<t>Condition Image Match</t>
</list></t>
</list></t>
</list></t>
<t>When some Components are "installed" or "loaded" it is more productive to use lists of Component indices rather than Component Index = True. For example, to install several Components, the following Commands should be placed in the Image Install Sequence:</t>
<t><list style="symbols">
<t>Set Component Index Directive (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Parameters Directive (see <xref target="suit-directive-set-parameters"/>) for the Source Component (see Section 8.4.8.11 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Set Component Index Directive, with argument containing list of destination Component indices (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Copy</t>
<t>Set Component Index Directive, with argument containing list Dependency Component indices (see Section 8.4.10.1 of <xref target="I-D.ietf-suit-manifest"/>)</t>
<t>Process Dependency</t>
</list></t>
</section>
</section>
<section anchor="iana"><name>IANA Considerations</name>
<t>IANA is requested to allocate the following numbers in the listed registries created by draft-ietf-suit-manifest:</t>
<section anchor="suit-envelope-elements"><name>SUIT Envelope Elements</name>
<texttable>
<ttcol align='left'>Label</ttcol>
<ttcol align='left'>Name</ttcol>
<ttcol align='left'>Reference</ttcol>
<c>15</c>
<c>Dependency Resolution</c>
<c><xref target="suit-dependency-resolution"/></c>
<c>18</c>
<c>Candidate Verification</c>
<c><xref target="suit-candidate-verification"/></c>
</texttable>
</section>
<section anchor="suit-manifest-elements"><name>SUIT Manifest Elements</name>
<texttable>
<ttcol align='left'>Label</ttcol>
<ttcol align='left'>Name</ttcol>
<ttcol align='left'>Reference</ttcol>
<c>5</c>
<c>Manifest Component ID</c>
<c><xref target="manifest-id"/></c>
<c>15</c>
<c>Dependency Resolution</c>
<c><xref target="suit-dependency-resolution"/></c>
<c>24</c>
<c>Uninstall</c>
<c><xref target="suit-uninstall"/></c>
</texttable>
</section>
<section anchor="suit-common-elements"><name>SUIT Common Elements</name>
<texttable>
<ttcol align='left'>Label</ttcol>
<ttcol align='left'>Name</ttcol>
<ttcol align='left'>Reference</ttcol>
<c>1</c>
<c>Dependencies</c>
<c><xref target="SUIT_Dependencies"/></c>
</texttable>
</section>
<section anchor="suit-commands"><name>SUIT Commands</name>
<texttable>
<ttcol align='left'>Label</ttcol>
<ttcol align='left'>Name</ttcol>
<ttcol align='left'>Reference</ttcol>
<c>7</c>
<c>Dependency Integrity</c>
<c><xref target="suit-condition-dependency-integrity"/></c>
<c>8</c>
<c>Is Dependency</c>
<c><xref target="suit-condition-is-dependency"/></c>
<c>11</c>
<c>Process Dependency</c>
<c><xref target="suit-directive-process-dependency"/></c>
<c>19</c>
<c>Set Parameters</c>
<c><xref target="suit-directive-set-parameters"/></c>
<c>33</c>
<c>Unlink</c>
<c><xref target="suit-directive-unlink"/></c>
</texttable>
</section>
</section>
<section anchor="security-considerations"><name>Security Considerations</name>
<t>This document is about a Manifest format protecting and describing how to retrieve, install, and invoke Images and as such it is part of a larger solution for delivering software updates to devices. A detailed security treatment can be found in the architecture <xref target="RFC9019"/> and in the information model <xref target="RFC9124"/> documents.</t>
</section>
</middle>
<back>
<references title='Normative References'>
<reference anchor='I-D.ietf-suit-manifest'>
<front>
<title>A Concise Binary Object Representation (CBOR)-based Serialization Format for the Software Updates for Internet of Things (SUIT) Manifest</title>
<author fullname='Brendan Moran' initials='B.' surname='Moran'>
<organization>Arm Limited</organization>
</author>
<author fullname='Hannes Tschofenig' initials='H.' surname='Tschofenig'>
</author>
<author fullname='Henk Birkholz' initials='H.' surname='Birkholz'>
<organization>Fraunhofer SIT</organization>
</author>
<author fullname='Koen Zandberg' initials='K.' surname='Zandberg'>
<organization>Inria</organization>
</author>
<author fullname='Øyvind Rønningstad' initials='O.' surname='Rønningstad'>
<organization>Nordic Semiconductor</organization>
</author>
<date day='3' month='December' year='2024'/>
<abstract>
<t> This specification describes the format of a manifest. A manifest is
a bundle of metadata about code/data obtained by a recipient (chiefly
the firmware for an Internet of Things (IoT) device), where to find
the code/data, the devices to which it applies, and cryptographic
information protecting the manifest. Software updates and Trusted
Invocation both tend to use sequences of common operations, so the
manifest encodes those sequences of operations, rather than declaring
the metadata.
</t>
</abstract>
</front>
<seriesInfo name='Internet-Draft' value='draft-ietf-suit-manifest-30'/>
</reference>
<reference anchor='I-D.ietf-suit-firmware-encryption'>
<front>
<title>Encrypted Payloads in SUIT Manifests</title>
<author fullname='Hannes Tschofenig' initials='H.' surname='Tschofenig'>
<organization>University of Applied Sciences Bonn-Rhein-Sieg</organization>
</author>
<author fullname='Russ Housley' initials='R.' surname='Housley'>
<organization>Vigil Security, LLC</organization>
</author>
<author fullname='Brendan Moran' initials='B.' surname='Moran'>
<organization>Arm Limited</organization>
</author>
<author fullname='David Brown' initials='D.' surname='Brown'>
<organization>Linaro</organization>
</author>
<author fullname='Ken Takayama' initials='K.' surname='Takayama'>
<organization>SECOM CO., LTD.</organization>
</author>
<date day='21' month='October' year='2024'/>
<abstract>
<t> This document specifies techniques for encrypting software, firmware,
machine learning models, and personalization data by utilizing the
IETF SUIT manifest. Key agreement is provided by ephemeral-static
(ES) Diffie-Hellman (DH) and AES Key Wrap (AES-KW). ES-DH uses
public key cryptography while AES-KW uses a pre-shared key.
Encryption of the plaintext is accomplished with conventional
symmetric key cryptography.
</t>
</abstract>
</front>
<seriesInfo name='Internet-Draft' value='draft-ietf-suit-firmware-encryption-21'/>
</reference>
<reference anchor='RFC2119'>
<front>
<title>Key words for use in RFCs to Indicate Requirement Levels</title>
<author fullname='S. Bradner' initials='S.' surname='Bradner'/>
<date month='March' year='1997'/>
<abstract>
<t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
</abstract>
</front>
<seriesInfo name='BCP' value='14'/>
<seriesInfo name='RFC' value='2119'/>
<seriesInfo name='DOI' value='10.17487/RFC2119'/>
</reference>
<reference anchor='RFC8174'>
<front>
<title>Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words</title>
<author fullname='B. Leiba' initials='B.' surname='Leiba'/>
<date month='May' year='2017'/>
<abstract>
<t>RFC 2119 specifies common key words that may be used in protocol specifications. This document aims to reduce the ambiguity by clarifying that only UPPERCASE usage of the key words have the defined special meanings.</t>
</abstract>
</front>
<seriesInfo name='BCP' value='14'/>
<seriesInfo name='RFC' value='8174'/>
<seriesInfo name='DOI' value='10.17487/RFC8174'/>
</reference>
</references>
<references title='Informative References'>
<reference anchor='I-D.ietf-suit-update-management'>
<front>
<title>Update Management Extensions for Software Updates for Internet of Things (SUIT) Manifests</title>
<author fullname='Brendan Moran' initials='B.' surname='Moran'>
<organization>Arm Limited</organization>
</author>
<author fullname='Ken Takayama' initials='K.' surname='Takayama'>
<organization>SECOM CO., LTD.</organization>
</author>
<date day='8' month='July' year='2024'/>
<abstract>
<t> This specification describes extensions to the SUIT manifest format
defined in [I-D.ietf-suit-manifest]. These extensions allow an
update author, update distributor or device operator to more
precisely control the distribution and installation of updates to
devices. These extensions also provide a mechanism to inform a
management system of Software Identifier and Software Bill Of
Materials information about an updated device.
</t>
</abstract>
</front>
<seriesInfo name='Internet-Draft' value='draft-ietf-suit-update-management-07'/>
</reference>
<reference anchor='I-D.ietf-teep-architecture'>
<front>
<title>Trusted Execution Environment Provisioning (TEEP) Architecture</title>
<author fullname='Mingliang Pei' initials='M.' surname='Pei'>
<organization>Broadcom</organization>
</author>
<author fullname='Hannes Tschofenig' initials='H.' surname='Tschofenig'>
<organization>Arm Limited</organization>
</author>
<author fullname='Dave Thaler' initials='D.' surname='Thaler'>
<organization>Microsoft</organization>
</author>
<author fullname='Dave Wheeler' initials='D. M.' surname='Wheeler'>
<organization>Amazon</organization>
</author>
<date day='24' month='October' year='2022'/>
<abstract>
<t>A Trusted Execution Environment (TEE) is an environment that enforces the following: any code within the environment cannot be tampered with, and any data used by such code cannot be read or tampered with by any code outside the environment. This architecture document discusses the motivation for designing and standardizing a protocol for managing the lifecycle of Trusted Applications running inside such a TEE.
</t>
</abstract>
</front>
<seriesInfo name='Internet-Draft' value='draft-ietf-teep-architecture-19'/>
</reference>
<reference anchor='RFC6024'>
<front>
<title>Trust Anchor Management Requirements</title>
<author fullname='R. Reddy' initials='R.' surname='Reddy'/>
<author fullname='C. Wallace' initials='C.' surname='Wallace'/>
<date month='October' year='2010'/>
<abstract>
<t>A trust anchor represents an authoritative entity via a public key and associated data. The public key is used to verify digital signatures, and the associated data is used to constrain the types of information for which the trust anchor is authoritative. A relying party uses trust anchors to determine if a digitally signed object is valid by verifying a digital signature using the trust anchor's public key, and by enforcing the constraints expressed in the associated data for the trust anchor. This document describes some of the problems associated with the lack of a standard trust anchor management mechanism and defines requirements for data formats and push-based protocols designed to address these problems. This document is not an Internet Standards Track specification; it is published for informational purposes.</t>
</abstract>
</front>
<seriesInfo name='RFC' value='6024'/>
<seriesInfo name='DOI' value='10.17487/RFC6024'/>
</reference>
<reference anchor='RFC7228'>
<front>
<title>Terminology for Constrained-Node Networks</title>
<author fullname='C. Bormann' initials='C.' surname='Bormann'/>
<author fullname='M. Ersue' initials='M.' surname='Ersue'/>
<author fullname='A. Keranen' initials='A.' surname='Keranen'/>
<date month='May' year='2014'/>
<abstract>
<t>The Internet Protocol Suite is increasingly used on small devices with severe constraints on power, memory, and processing resources, creating constrained-node networks. This document provides a number of basic terms that have been useful in the standardization work for constrained-node networks.</t>
</abstract>
</front>
<seriesInfo name='RFC' value='7228'/>
<seriesInfo name='DOI' value='10.17487/RFC7228'/>
</reference>
<reference anchor='RFC9019'>
<front>
<title>A Firmware Update Architecture for Internet of Things</title>
<author fullname='B. Moran' initials='B.' surname='Moran'/>
<author fullname='H. Tschofenig' initials='H.' surname='Tschofenig'/>
<author fullname='D. Brown' initials='D.' surname='Brown'/>
<author fullname='M. Meriac' initials='M.' surname='Meriac'/>
<date month='April' year='2021'/>
<abstract>
<t>Vulnerabilities in Internet of Things (IoT) devices have raised the need for a reliable and secure firmware update mechanism suitable for devices with resource constraints. Incorporating such an update mechanism is a fundamental requirement for fixing vulnerabilities, but it also enables other important capabilities such as updating configuration settings and adding new functionality.</t>
<t>In addition to the definition of terminology and an architecture, this document provides the motivation for the standardization of a manifest format as a transport-agnostic means for describing and protecting firmware updates.</t>
</abstract>
</front>
<seriesInfo name='RFC' value='9019'/>
<seriesInfo name='DOI' value='10.17487/RFC9019'/>
</reference>
<reference anchor='RFC9124'>
<front>
<title>A Manifest Information Model for Firmware Updates in Internet of Things (IoT) Devices</title>
<author fullname='B. Moran' initials='B.' surname='Moran'/>
<author fullname='H. Tschofenig' initials='H.' surname='Tschofenig'/>
<author fullname='H. Birkholz' initials='H.' surname='Birkholz'/>
<date month='January' year='2022'/>
<abstract>
<t>Vulnerabilities with Internet of Things (IoT) devices have raised the need for a reliable and secure firmware update mechanism that is also suitable for constrained devices. Ensuring that devices function and remain secure over their service lifetime requires such an update mechanism to fix vulnerabilities, update configuration settings, and add new functionality.</t>
<t>One component of such a firmware update is a concise and machine-processable metadata document, or manifest, that describes the firmware image(s) and offers appropriate protection. This document describes the information that must be present in the manifest.</t>
</abstract>
</front>
<seriesInfo name='RFC' value='9124'/>
<seriesInfo name='DOI' value='10.17487/RFC9124'/>
</reference>
</references>