Skip to content
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

Jump to bottom

Add CCA Realm Reference Values #109

Merged
merged 2 commits into from
Mar 7, 2024
Merged

Add CCA Realm Reference Values #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7862a1b
Realm Reference Values
yogeshbdeshpande Feb 20, 2024
c9b9c6d
Incorporated Review Comments
yogeshbdeshpande Mar 7, 2024
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
75 changes: 75 additions & 0 deletions cocli/data/comid/templates/comid-cca-realm-refval.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
{
"lang": "en-GB",
"tag-identity": {
"id": "43BBE37F-2E61-4B33-AED3-53CFF1428B16",
"version": 0
},
"entities": [
{
"name": "Workload Client Ltd.",
"regid": "https://workloadclient.example",
"roles": [
"tagCreator",
"creator",
"maintainer"
]
}
],
"triples": {
"reference-values": [
{
"environment": {
"class": {
"id": {
"type": "uuid",
"value": "CD1F0E55-26F9-460D-B9D8-F7FDE171787C"
},
"vendor": "Workload Client Ltd"
},
"instance": {
"type": "bytes",
"value": "QoS1aUymwNLPR4mguVrIAlyBjeUjBDZL580pgbLS7caFsyInfsJYGZYkE9jJssH1"
}
},
"measurements": [
{
"value": {
"integrity-registers": {
"rim": {
"key-type": "text",
"value": [
"sha-384;QoS1aUymwNLPR4mguVrIAlyBjeUjBDZL580pgbLS7caFsyInfsJYGZYkE9jJssH1"
]
},
"rem0": {
"key-type": "text",
"value": [
"sha-384;IQe752H8pS2VE2oTVNt6TdV7Gya+DT2nHZ6yOYazS6YVq/ZRTPNeWp6lWgMtBop4"
]
},
"rem1": {
"key-type": "text",
"value": [
"sha-384;JQe752H8pS2VE2oTVNt6TdV7Gya+DT2nHZ6yOYazS6YVq/ZRTPNeWp6lWgMtBop4"
]
},
"rem2": {
"key-type": "text",
"value": [
"sha-384;MQe752H8pS2VE2oTVNt6TdV7Gya+DT2nHZ6yOYazS6YVq/ZRTPNeWp6lWgMtBop4"
]
},
"rem3": {
"key-type": "text",
"value": [
"sha-384;NQe752H8pS2VE2oTVNt6TdV7Gya+DT2nHZ6yOYazS6YVq/ZRTPNeWp6lWgMtBop4"
]
}
}
}
}
]
}
]
}
}
19 changes: 19 additions & 0 deletions cocli/data/corim/templates/corim-cca-realm.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"corim-id": "5c57e8f4-46cd-421b-91c9-08cf93e13cfc",
"profiles": [
"http://arm.com/cca/realm/1"
yogeshbdeshpande marked this conversation as resolved.
Show resolved Hide resolved
],
"validity": {
"not-before": "2021-12-31T00:00:00Z",
"not-after": "2025-12-31T00:00:00Z"
},
"entities": [
{
"name": "ACME Ltd.",
"regid": "acme.example",
"roles": [
"manifestCreator"
]
}
]
}
6 changes: 0 additions & 6 deletions cocli/data/corim/templates/corim-cca.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
{
"corim-id": "5c57e8f4-46cd-421b-91c9-08cf93e13cfc",
"dependent-rims": [
{
"href": "https://parent.example/rims/ccb3aa85-61b4-40f1-848e-02ad6e8a254b",
"thumbprint": "sha-256:5Fty9cDAtXLbTY06t+l/No/3TmI0eoJN7LZ6hOUiTXU="
}
],
"profiles": [
"http://arm.com/cca/ssd/1"
],
Expand Down
207 changes: 207 additions & 0 deletions comid/example_cca_realm_refval_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
// Copyright 2024 Contributors to the Veraison project.
// SPDX-License-Identifier: Apache-2.0

package comid

import (
"fmt"
"strings"
)

func Example_cca_realm_refval() {
comid := Comid{}

if err := comid.FromJSON([]byte(CCARealmRefValJSONTemplate)); err != nil {
panic(err)
}

if err := comid.Valid(); err != nil {
panic(err)
}

if err := extractRealmRefVals(&comid); err != nil {
panic(err)
}
// output:
// Vendor: Workload Client Ltd
// ClassID: cd1f0e5526f9460db9d8f7fde171787c
// InstanceID: 4284b5694ca6c0d2cf4789a0b95ac8025c818de52304364be7cd2981b2d2edc685b322277ec25819962413d8c9b2c1f5
// Index: rim
// Alg: sha-384
// Digest: 4284b5694ca6c0d2cf4789a0b95ac8025c818de52304364be7cd2981b2d2edc685b322277ec25819962413d8c9b2c1f5
// Index: rem0
// Alg: sha-384
// Digest: 2107bbe761fca52d95136a1354db7a4dd57b1b26be0d3da71d9eb23986b34ba615abf6514cf35e5a9ea55a032d068a78
// Index: rem1
// Alg: sha-384
// Digest: 2507bbe761fca52d95136a1354db7a4dd57b1b26be0d3da71d9eb23986b34ba615abf6514cf35e5a9ea55a032d068a78
// Index: rem2
// Alg: sha-384
// Digest: 3107bbe761fca52d95136a1354db7a4dd57b1b26be0d3da71d9eb23986b34ba615abf6514cf35e5a9ea55a032d068a78
// Index: rem3
// Alg: sha-384
// Digest: 3507bbe761fca52d95136a1354db7a4dd57b1b26be0d3da71d9eb23986b34ba615abf6514cf35e5a9ea55a032d068a78

}

func extractRealmRefVals(c *Comid) error {
if c.Triples.ReferenceValues == nil {
return fmt.Errorf("no reference values triples")
}

for i, rv := range *c.Triples.ReferenceValues {
if err := extractRealmRefVal(rv); err != nil {
return fmt.Errorf("bad Realm reference value at index %d: %w", i, err)
}
}

return nil
}

func extractRealmRefVal(rv ReferenceValue) error {
class := rv.Environment.Class
instance := rv.Environment.Instance

if err := extractRealmClass(class); err != nil {
return fmt.Errorf("extracting class: %w", err)
}

if err := extractRealmInstanceID(instance); err != nil {
return fmt.Errorf("extracting realm instanceID: %w", err)
}

measurements := rv.Measurements

if err := extractMeasurements(measurements); err != nil {
return fmt.Errorf("extracting measurements: %w", err)
}

return nil
}

func extractMeasurements(m Measurements) error {
if len(m) == 0 {
return fmt.Errorf("no measurements")
}

for i, m := range m {

Check failure on line 87 in comid/example_cca_realm_refval_test.go

View workflow job for this annotation

GitHub Actions / Lint 

rangeValCopy: each iteration copies 128 bytes (consider pointers or indexing) (gocritic)

Check failure on line 87 in comid/example_cca_realm_refval_test.go

View workflow job for this annotation

GitHub Actions / Lint 

rangeValCopy: each iteration copies 128 bytes (consider pointers or indexing) (gocritic)
if err := extractMeasurement(m); err != nil {
return fmt.Errorf("extracting measurement at index %d: %w", i, err)
}
}

return nil
}

func extractMeasurement(m Measurement) error {

Check failure on line 96 in comid/example_cca_realm_refval_test.go

View workflow job for this annotation

GitHub Actions / Lint 

hugeParam: m is heavy (128 bytes); consider passing it by pointer (gocritic)

Check failure on line 96 in comid/example_cca_realm_refval_test.go

View workflow job for this annotation

GitHub Actions / Lint 

hugeParam: m is heavy (128 bytes); consider passing it by pointer (gocritic)
if err := extractIntegrityRegisters(m.Val.IntegrityRegisters); err != nil {
return fmt.Errorf("extracting digest: %w", err)
}

return nil
}

func extractRealmClass(c *Class) error {
if c == nil {
fmt.Println("class not present")
return nil
}

if c.Vendor != nil {
fmt.Printf("Vendor: %s\n", c.GetVendor())
}

classID := c.ClassID
if classID == nil {
fmt.Println("class-id not present")
return nil
}

if classID.Type() != "uuid" {
return fmt.Errorf("class id is not a uuid")
}
if err := classID.Valid(); err != nil {
return fmt.Errorf("invalid uuid: %v", err)
}
fmt.Printf("ClassID: %x\n", classID.Bytes())

return nil
}

func extractRealmInstanceID(i *Instance) error {
if i == nil {
return fmt.Errorf("no instance")
}

if i.Type() != "bytes" {
return fmt.Errorf("instance id is not bytes")
}

fmt.Printf("InstanceID: %x\n", i.Bytes())

return nil
}

func extractIntegrityRegisters(r *IntegrityRegisters) error {
if r == nil {
return fmt.Errorf("no integrity registers")
}

keys, err := extractRegisterIndexes(r)
if err != nil {
return fmt.Errorf("unable to extract register index: %v", err)
}

for _, k := range keys {
d, ok := r.m[k]
if !ok {
return fmt.Errorf("unable to locate register index for: %s", k)
}
fmt.Printf("Index: %s\n", k)
if err := extractRealmDigests(d); err != nil {
return fmt.Errorf("invalid Digests for key: %s, %v", k, err)
}
}

return nil
}

func extractRealmDigests(digests Digests) error {

if err := digests.Valid(); err != nil {
return fmt.Errorf("invalid digest: %v", err)
}
for _, d := range digests {
fmt.Printf("Alg: %s\n", d.AlgIDToString())
fmt.Printf("Digest: %x\n", d.HashValue)
}

return nil
}

func extractRegisterIndexes(r *IntegrityRegisters) ([]string, error) {
var keys [5]string
for k := range r.m {
switch t := k.(type) {
case string:
key := strings.ToLower(t)
switch key {
case "rim":
keys[0] = key
case "rem0":
keys[1] = key
case "rem1":
keys[2] = key
case "rem2":
keys[3] = key
case "rem3":
keys[4] = key
default:
return nil, fmt.Errorf("unexpected register index: %s", key)
}
default:
return nil, fmt.Errorf("unexpected type for index: %T", t)
}
}
return keys[:], nil
}
4 changes: 2 additions & 2 deletions comid/integrityregisters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ func (i *IntegrityRegisters) UnmarshalCBOR(data []byte) error {
}

type keyTypeandVal struct {
KeyType string `json:"key_type"`
Value json.RawMessage
KeyType string `json:"key-type"`
Value json.RawMessage `json:"value"`
}

func (i IntegrityRegisters) MarshalJSON() ([]byte, error) {
Expand Down
Loading
Loading