Merge pull request #14 from ravjot07/Update_Display_cmd

Enhance corim display Command to Support Unsigned CoRIMs
veraison · Dec 24, 2024 · 0d8fae8 · 0d8fae8
2 parents 21c26de + c7b831b
commit 0d8fae8
Show file tree

Hide file tree

Showing 2 changed files with 102 additions and 53 deletions.
diff --git a/cmd/corimDisplay.go b/cmd/corimDisplay.go
@@ -47,7 +47,7 @@ func NewCorimDisplayCmd() *cobra.Command {
 		},
 	}
 
-	corimDisplayCorimFile = cmd.Flags().StringP("file", "f", "", "a signed CoRIM file (in CBOR format)")
+	corimDisplayCorimFile = cmd.Flags().StringP("file", "f", "", "a CoRIM file (in CBOR format)")
 	corimDisplayShowTags = cmd.Flags().BoolP("show-tags", "v", false, "display embedded tags")
 
 	return cmd
@@ -61,70 +61,106 @@ func checkCorimDisplayArgs() error {
 	return nil
 }
 
-func display(signedCorimFile string, showTags bool) error {
-	var (
-		signedCorimCBOR []byte
-		metaJSON        []byte
-		corimJSON       []byte
-		err             error
-		s               corim.SignedCorim
-	)
-
-	if signedCorimCBOR, err = afero.ReadFile(fs, signedCorimFile); err != nil {
-		return fmt.Errorf("error loading signed CoRIM from %s: %w", signedCorimFile, err)
+func displaySignedCorim(s corim.SignedCorim, corimFile string, showTags bool) error {
+	metaJSON, err := json.MarshalIndent(&s.Meta, "", "  ")
+	if err != nil {
+		return fmt.Errorf("error encoding CoRIM Meta from %s: %w", corimFile, err)
 	}
 
-	if err = s.FromCOSE(signedCorimCBOR); err != nil {
-		return fmt.Errorf("error decoding signed CoRIM from %s: %w", signedCorimFile, err)
+	fmt.Println("Meta:")
+	fmt.Println(string(metaJSON))
+
+	corimJSON, err := json.MarshalIndent(&s.UnsignedCorim, "", "  ")
+	if err != nil {
+		return fmt.Errorf("error encoding unsigned CoRIM from %s: %w", corimFile, err)
 	}
 
-	if metaJSON, err = json.MarshalIndent(&s.Meta, "", "  "); err != nil {
-		return fmt.Errorf("error decoding CoRIM Meta from %s: %w", signedCorimFile, err)
+	fmt.Println("CoRIM:")
+	fmt.Println(string(corimJSON))
+
+	if showTags {
+		fmt.Println("Tags:")
+		displayTags(s.UnsignedCorim.Tags)
 	}
 
-	fmt.Println("Meta:")
-	fmt.Println(string(metaJSON))
+	return nil
+}
 
-	if corimJSON, err = json.MarshalIndent(&s.UnsignedCorim, "", "  "); err != nil {
-		return fmt.Errorf("error decoding unsigned CoRIM from %s: %w", signedCorimFile, err)
+func displayUnsignedCorim(u corim.UnsignedCorim, corimFile string, showTags bool) error {
+	corimJSON, err := json.MarshalIndent(&u, "", "  ")
+	if err != nil {
+		return fmt.Errorf("error encoding unsigned CoRIM from %s: %w", corimFile, err)
 	}
 
 	fmt.Println("Corim:")
 	fmt.Println(string(corimJSON))
 
 	if showTags {
 		fmt.Println("Tags:")
-		for i, e := range s.UnsignedCorim.Tags {
-			// need at least 3 bytes for the tag and 1 for the smallest bstr
-			if len(e) < 3+1 {
-				fmt.Printf(">> skipping malformed tag at index %d\n", i)
-				continue
-			}
+		displayTags(u.Tags)
+	}
+
+	return nil
+}
 
-			// split tag from data
-			cborTag, cborData := e[:3], e[3:]
-
-			hdr := fmt.Sprintf(">> [ %d ]", i)
-
-			if bytes.Equal(cborTag, corim.ComidTag) {
-				if err = printComid(cborData, hdr); err != nil {
-					fmt.Printf(">> skipping malformed CoMID tag at index %d: %v\n", i, err)
-				}
-			} else if bytes.Equal(cborTag, corim.CoswidTag) {
-				if err = printCoswid(cborData, hdr); err != nil {
-					fmt.Printf(">> skipping malformed CoSWID tag at index %d: %v\n", i, err)
-				}
-			} else if bytes.Equal(cborTag, cots.CotsTag) {
-				if err = printCots(cborData, hdr); err != nil {
-					fmt.Printf(">> skipping malformed CoTS tag at index %d: %v\n", i, err)
-				}
-			} else {
-				fmt.Printf(">> unmatched CBOR tag: %x\n", cborTag)
+func display(corimFile string, showTags bool) error {
+	var (
+		corimCBOR []byte
+		err       error
+	)
+
+	// read the CoRIM file
+	if corimCBOR, err = afero.ReadFile(fs, corimFile); err != nil {
+		return fmt.Errorf("error loading CoRIM from %s: %w", corimFile, err)
+	}
+
+	// try to decode as a signed CoRIM
+	var s corim.SignedCorim
+	if err = s.FromCOSE(corimCBOR); err == nil {
+		// successfully decoded as signed CoRIM
+		return displaySignedCorim(s, corimFile, showTags)
+	}
+
+	// if decoding as signed CoRIM failed, attempt to decode as unsigned CoRIM
+	var u corim.UnsignedCorim
+	if err = u.FromCBOR(corimCBOR); err != nil {
+		return fmt.Errorf("error decoding CoRIM (signed or unsigned) from %s: %w", corimFile, err)
+	}
+
+	// successfully decoded as unsigned CoRIM
+	return displayUnsignedCorim(u, corimFile, showTags)
+}
+
+// displayTags processes and displays embedded tags within a CoRIM.
+func displayTags(tags []corim.Tag) {
+	for i, t := range tags {
+		if len(t) < 4 {
+			fmt.Printf(">> skipping malformed tag at index %d\n", i)
+			continue
+		}
+
+		// Split tag identifier from data
+		cborTag, cborData := t[:3], t[3:]
+
+		hdr := fmt.Sprintf(">> [ %d ]", i)
+
+		switch {
+		case bytes.Equal(cborTag, corim.ComidTag):
+			if err := printComid(cborData, hdr); err != nil {
+				fmt.Printf(">> skipping malformed CoMID tag at index %d: %v\n", i, err)
 			}
+		case bytes.Equal(cborTag, corim.CoswidTag):
+			if err := printCoswid(cborData, hdr); err != nil {
+				fmt.Printf(">> skipping malformed CoSWID tag at index %d: %v\n", i, err)
+			}
+		case bytes.Equal(cborTag, cots.CotsTag):
+			if err := printCots(cborData, hdr); err != nil {
+				fmt.Printf(">> skipping malformed CoTS tag at index %d: %v\n", i, err)
+			}
+		default:
+			fmt.Printf(">> unmatched CBOR tag: %x\n", cborTag)
 		}
 	}
-
-	return nil
 }
 
 func init() {

diff --git a/cmd/corimDisplay_test.go b/cmd/corimDisplay_test.go
@@ -11,6 +11,14 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+// Define your truncated CBOR payload
+var truncatedCorim = []byte{
+	0xA1,               // CBOR map with 1 key
+	0x01,               // Key = 1
+	0x65,               // Value: string of length 5
+	'h', 'e', 'l', 'l', // Incomplete string value (missing one byte)
+}
+
 func Test_CorimDisplayCmd_unknown_argument(t *testing.T) {
 	cmd := NewCorimDisplayCmd()
 
@@ -44,7 +52,7 @@ func Test_CorimDisplayCmd_non_existent_corim_file(t *testing.T) {
 	fs = afero.NewMemMapFs()
 
 	err := cmd.Execute()
-	assert.EqualError(t, err, "error loading signed CoRIM from nonexistent.cbor: open nonexistent.cbor: file does not exist")
+	assert.EqualError(t, err, "error loading CoRIM from nonexistent.cbor: open nonexistent.cbor: file does not exist")
 }
 
 func Test_CorimDisplayCmd_bad_signed_corim(t *testing.T) {
@@ -60,23 +68,28 @@ func Test_CorimDisplayCmd_bad_signed_corim(t *testing.T) {
 	require.NoError(t, err)
 
 	err = cmd.Execute()
-	assert.EqualError(t, err, "error decoding signed CoRIM from bad.txt: failed CBOR decoding for COSE-Sign1 signed CoRIM: cbor: invalid COSE_Sign1_Tagged object")
+	assert.EqualError(t, err, "error decoding CoRIM (signed or unsigned) from bad.txt: expected map (CBOR Major Type 5), found Major Type 3")
 }
 
-func Test_CorimDisplayCmd_invalid_signed_corim(t *testing.T) {
+func Test_CorimDisplayCmd_invalid_signed_corim_Truncated(t *testing.T) {
 	cmd := NewCorimDisplayCmd()
 
 	args := []string{
-		"--file=invalid.cbor",
+		"--file=truncated.cbor",
 	}
 	cmd.SetArgs(args)
 
 	fs = afero.NewMemMapFs()
-	err := afero.WriteFile(fs, "invalid.cbor", testSignedCorimInvalid, 0644)
+	// Use truncatedCorim to force "unexpected EOF" error
+	err := afero.WriteFile(fs, "truncated.cbor", truncatedCorim, 0644)
 	require.NoError(t, err)
 
 	err = cmd.Execute()
-	assert.EqualError(t, err, `error decoding signed CoRIM from invalid.cbor: failed CBOR decoding of unsigned CoRIM: unexpected EOF`)
+	assert.EqualError(
+		t,
+		err,
+		"error decoding CoRIM (signed or unsigned) from truncated.cbor: map item 0: could not unmarshal value: unexpected EOF",
+	)
 }
 
 func Test_CorimDisplayCmd_ok_top_level_view(t *testing.T) {