Skip to content

Add TCG RIM extensions #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thomas-fossati wants to merge 5 commits into
base: main
Choose a base branch
from
+135 −5
Open

Add TCG RIM extensions #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e2ea915
Fix #38
thomas-fossati Jul 22, 2022
c3bf29c
increase coverage threshold
thomas-fossati Jul 22, 2022
f86e667
Add support for TCG RIM extensions
thomas-fossati Jul 20, 2022
ec3a107
Merge branch 'main' into ext-tcg-rim
thomas-fossati Jul 25, 2022
c34b2ba
add reference to spec
thomas-fossati Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion coswid_extension.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@ package swid

// CoSWIDExtension is a placeholder for $$coswid-extension
type CoSWIDExtension struct {
// no coswid-extension defined
TcgRimReferenceMeasurementEntry *TcgRimReferenceMeasurementEntry `cbor:"58,keyasint,omitempty" json:"tcg-rim:reference-measurement-entry,omitempty" xml:"-"`
}
3 changes: 2 additions & 1 deletion directory_extension.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ package swid

// DirectoryExtension is a placeholder for $$directory-extension
type DirectoryExtension struct {
// no directory-extensions defined
// TCG RIM extension
TCGRIMHashEntry *HashEntry `cbor:"7,keyasint,omitempty" json:"tgc-rim:hash-entry,omitempty" xml:"-"`
}
93 changes: 93 additions & 0 deletions example_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,96 @@ func Example_completePrimaryTag() {
// Output:
// <SoftwareIdentity xmlns="http://standards.iso.org/iso/19770/-2/2015/schema.xsd" tagId="com.acme.rrd2013-ce-sp1-v4-1-5-0" name="ACME Roadrunner Detector 2013 Coyote Edition SP1" version="4.1.5"><Meta activationStatus="trial" colloquialVersion="2013" edition="coyote" product="Roadrunner Detector" revision="sp1"></Meta><Entity name="The ACME Corporation" regid="acme.com" role="tagCreator softwareCreator"></Entity><Entity name="Coyote Services, Inc." regid="mycoyote.com" role="distributor"></Entity><Link href="www.gnu.org/licenses/gpl.txt" rel="license"></Link><Payload><Directory name="rrdetector" root="%programdata%"><File name="rrdetector.exe" size="532712" hash="sha-256:oxT8LcZjrnpra8Z4dZQFc5bms/VpzVD9XdtNG7r9K2o="></File></Directory><File name="test.exe" size="532712" hash="sha-256:oxT8LcZjrnpra8Z4dZQFc5bms/VpzVD9XdtNG7r9K2o="></File></Payload></SoftwareIdentity>
}

func Example_tcgRimExtension() {
tag, _ := NewTag("94f6b457-9ac9-4d35-9b3f-78804173b65as", "ACME IoTCore", "1.0.0")

entity, _ := NewEntity("ACME Ltd", RoleTagCreator, RoleSoftwareCreator)
_ = entity.SetRegID("acme.example")
_ = tag.AddEntity(*entity)

softwareMeta := SoftwareMeta{
ColloquialVersion: "Firmware_2019",
Edition: "IoT",
Product: "ProductA",
Revision: "r2",
}
_ = tag.AddSoftwareMeta(softwareMeta)

mID, fID := uint64(201234), uint64(213022)
uriLocal := AnyURI("/boot/tcg/manifest/swidtag")
fwVendor := "BIOSVendorA"
tcgRimReferenceMeasurementEntry := &TcgRimReferenceMeasurementEntry{
PlatformConfigurationURILocal: &uriLocal,
BindingSpecName: "IoT RIM",
BindingSpecVersion: "1.2",
PlatformManufacturerID: &mID,
PlatformManufacturerName: "ACME",
PlatformModelName: "ProductA",
FirmwareManufacturerName: &fwVendor,
FirmwareManufacturerID: &fID,
RIMLinkHash: []byte{
0x88, 0xf2, 0x1d, 0x8e, 0x44, 0xd4, 0x27, 0x11, 0x49, 0x29, 0x74,
0x04, 0xdf, 0x91, 0xca, 0xf2, 0x07, 0x13, 0x0b, 0xfa, 0x11, 0x65,
0x82, 0x40, 0x8a, 0xbd, 0x04, 0xed, 0xe6, 0xdb, 0x7f, 0x51,
},
}
tag.TcgRimReferenceMeasurementEntry = tcgRimReferenceMeasurementEntry

fSz1, fSz2 := int64(25400), int64(1024)
dir := Directory{
FileSystemItem: FileSystemItem{
Location: "/boot/iot",
FsName: "iotBase",
},
PathElements: &PathElements{
Files: &Files{
File{
FileSystemItem: FileSystemItem{
FsName: "ACME-iotBase.bin",
},
FileVersion: "01.00",
Size: &fSz1,
Hash: &HashEntry{
HashAlgID: Sha256,
HashValue: []byte{
0xa3, 0x14, 0xfc, 0x2d, 0xc6, 0x63, 0xae, 0x7a,
0x6b, 0x6b, 0xc6, 0x78, 0x75, 0x94, 0x05, 0x73,
0x96, 0xe6, 0xb3, 0xf5, 0x69, 0xcd, 0x50, 0xfd,
0x5d, 0xdb, 0x4d, 0x1b, 0xba, 0xfd, 0x2b, 0x6a,
},
},
},
File{
FileSystemItem: FileSystemItem{
FsName: "iotExec.bin",
},
FileVersion: "01.00",
Size: &fSz2,
Hash: &HashEntry{
HashAlgID: Sha256,
HashValue: []byte{
0x53, 0x2e, 0xaa, 0xbd, 0x95, 0x74, 0x88, 0x0d,
0xbf, 0x76, 0xb9, 0xb8, 0xcc, 0x00, 0x83, 0x2c,
0x20, 0xa6, 0xec, 0x11, 0x3d, 0x68, 0x22, 0x99,
0x55, 0x0d, 0x7a, 0x6e, 0x0f, 0x34, 0x5e, 0x25,
},
},
},
},
},
}
payload := NewPayload()
_ = payload.AddDirectory(dir)
tag.Payload = payload

jdata, _ := tag.ToJSON()
fmt.Printf("%s\n", string(jdata))

cdata, _ := tag.ToCBOR()
fmt.Printf("%x\n", cdata)

// Output:
// {"tag-id":"94f6b457-9ac9-4d35-9b3f-78804173b65as","tag-version":0,"software-name":"ACME IoTCore","software-version":"1.0.0","software-meta":[{"colloquial-version":"Firmware_2019","edition":"IoT","product":"ProductA","revision":"r2"}],"entity":[{"entity-name":"ACME Ltd","reg-id":"acme.example","role":["tagCreator","softwareCreator"]}],"payload":{"directory":[{"location":"/boot/iot","fs-name":"iotBase","path-elements":{"file":[{"fs-name":"ACME-iotBase.bin","size":25400,"file-version":"01.00","hash":"sha-256:oxT8LcZjrnpra8Z4dZQFc5bms/VpzVD9XdtNG7r9K2o="},{"fs-name":"iotExec.bin","size":1024,"file-version":"01.00","hash":"sha-256:Uy6qvZV0iA2/drm4zACDLCCm7BE9aCKZVQ16bg80XiU="}]}}]},"tcg-rim:reference-measurement-entry":{"platform-configuration-uri-local":"/boot/tcg/manifest/swidtag","binding-spec-name":"IoT RIM","binding-spec-version":"1.2","platform-manufacturer-id":201234,"platform-manufacturer-name":"ACME","platform-model-name":"ProductA","firmware-manufacturer-id":213022,"firmware-manufacturer-name":"BIOSVendorA","rim-link-hash":"iPIdjkTUJxFJKXQE35HK8gcTC/oRZYJAir0E7ebbf1E="}}
// a800782539346636623435372d396163392d346433352d396233662d373838303431373362363561730c00016c41434d4520496f54436f72650d65312e302e3005a4182d6d4669726d776172655f32303139182f63496f5418346850726f6475637441183662723202a3181f6841434d45204c746418206c61636d652e6578616d706c65182182010206a110a317692f626f6f742f696f74181867696f7442617365181aa11182a418187041434d452d696f74426173652e62696e14196338156530312e30300782015820a314fc2dc663ae7a6b6bc6787594057396e6b3f569cd50fd5ddb4d1bbafd2b6aa418186b696f74457865632e62696e14190400156530312e30300782015820532eaabd9574880dbf76b9b8cc00832c20a6ec113d682299550d7a6e0f345e25183aa9183d781a2f626f6f742f7463672f6d616e69666573742f73776964746167183e67496f542052494d183f63312e3218401a0003121218416441434d4518426850726f647563744118441a0003401e18456b42494f5356656e646f72411848582088f21d8e44d4271149297404df91caf207130bfa116582408abd04ede6db7f51
}
3 changes: 2 additions & 1 deletion process_extension.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ package swid

// ProcessExtension is a placeholder for $$process-extension
type ProcessExtension struct {
// no process-extension defined
// TCG RIM extension
TCGRIMHashEntry *HashEntry `cbor:"7,keyasint,omitempty" json:"tgc-rim:hash-entry,omitempty" xml:"-"`
}
2 changes: 2 additions & 0 deletions resource_extension.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ package swid

// ResourceExtension is a placeholder for $$resource-extension
type ResourceExtension struct {
// TCG RIM extension
TCGRIMHashEntry *HashEntry `cbor:"7,keyasint,omitempty" json:"tgc-rim:hash-entry,omitempty" xml:"-"`
}
4 changes: 2 additions & 2 deletions softwareidentity.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ import (
type SoftwareIdentity struct {
XMLName xml.Name `cbor:"-" json:"-"`

CoSWIDExtension

GlobalAttributes

// A 16 byte binary string or textual identifier uniquely referencing a
Expand Down Expand Up @@ -134,6 +132,8 @@ type SoftwareIdentity struct {
// In either case, a CoSWID tag can be created by the tool performing an
// analysis of the software components installed on the endpoint.
Evidence *Evidence `cbor:"3,keyasint,omitempty" json:"evidence,omitempty" xml:"Evidence,omitempty"`

CoSWIDExtension
}

// NewTag instantiates a new SWID tag with the supplied tag identifier and
Expand Down
33 changes: 33 additions & 0 deletions tcg_rim_extensions.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright 2020 Contributors to the Veraison project.
Copy link
Contributor

@yogeshbdeshpande yogeshbdeshpande Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this file go under extensions/ folder ?

Copy link
Contributor Author

@thomas-fossati thomas-fossati Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we need to create another package?

Copy link
Contributor

@yogeshbdeshpande yogeshbdeshpande Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All extensions (for future) can reside there. Is it not much neater rather than residing in the base package ?

Copy link
Contributor Author

@thomas-fossati thomas-fossati Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The separation is not that clear cut: one still needs to put the extension structures inside the base package structures, so it's not like you have two independent packages that you can decide whether to compose (or not), you always have to have both.

// SPDX-License-Identifier: Apache-2.0

package swid

// See https://github.com/sacmwg/draft-ietf-sacm-coswid/blob/master/concise-swid-rim-extension.cddl

type AnyURI string

type TcgRimReferenceMeasurementEntry struct {
Copy link
Contributor

@yogeshbdeshpande yogeshbdeshpande Jul 25, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please refer to the spec where this extension CDDL is defined ?

Copy link
Contributor Author

@thomas-fossati thomas-fossati Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done in c34b2ba

PayloadType *TcgRimPayloadType `cbor:"59,keyasint,omitempty" json:"payload-type,omitempty"`
PlatformConfigurationURIGlobal *AnyURI `cbor:"60,keyasint,omitempty" json:"platform-configuration-uri-global,omitempty"`
PlatformConfigurationURILocal *AnyURI `cbor:"61,keyasint,omitempty" json:"platform-configuration-uri-local,omitempty"`
BindingSpecName string `cbor:"62,keyasint" json:"binding-spec-name"`
BindingSpecVersion string `cbor:"63,keyasint" json:"binding-spec-version"`
PlatformManufacturerID *uint64 `cbor:"64,keyasint,omitempty" json:"platform-manufacturer-id,omitempty"`
PlatformManufacturerName string `cbor:"65,keyasint" json:"platform-manufacturer-name"`
PlatformModelName string `cbor:"66,keyasint" json:"platform-model-name"`
PlatformVersion *uint64 `cbor:"67,keyasint,omitempty" json:"platform-version,omitempty"`
FirmwareManufacturerID *uint64 `cbor:"68,keyasint,omitempty" json:"firmware-manufacturer-id,omitempty"`
FirmwareManufacturerName *string `cbor:"69,keyasint,omitempty" json:"firmware-manufacturer-name,omitempty"`
FirmwareModelName *string `cbor:"70,keyasint,omitempty" json:"firmware-model-name,omitempty"`
FirmwareVersion *uint64 `cbor:"71,keyasint,omitempty" json:"firmware-version,omitempty"`
Copy link
Contributor

@yogeshbdeshpande yogeshbdeshpande Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason why ? boot-events => [ * boot-event-entry ],
is skipped?

Copy link
Contributor

@yogeshbdeshpande yogeshbdeshpande Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be I am referring to this: https://datatracker.ietf.org/doc/html/draft-birkholz-rats-coswid-rim-02

This is out of sync to the reference you mentioned above...

Copy link
Contributor Author

@thomas-fossati thomas-fossati Jul 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is definitely a question for @henkbirkholz

RIMLinkHash []byte `cbor:"72,keyasint" json:"rim-link-hash"`
}

type TcgRimPayloadType uint64

const (
TcgRimPayloadTypeDirect = TcgRimPayloadType(iota)
TcgRimPayloadTypeIndirect
TcgRimPayloadTypeHybrid
)