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.

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

⭐️ includes the platform ids and ec2 instance arn in sbom exports #2892

Merged
merged 1 commit into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion sbom/cnquery_bom_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ package sbom

import (
"bytes"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"testing"
)

func TestSimpleBom(t *testing.T) {
Expand Down
13 changes: 7 additions & 6 deletions sbom/report_collection.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,13 @@ type ReportCollectionJson struct {

// Structures to parse the data from cnquery report
type BomAsset struct {
Name string `json:"name,omitempty"`
Platform string `json:"platform,omitempty"`
Version string `json:"version,omitempty"`
Arch string `json:"arch,omitempty"`
CPEs []string `json:"cpes.map,omitempty"`
IDs []string `json:"ids,omitempty"`
Name string `json:"name,omitempty"`
Platform string `json:"platform,omitempty"`
Version string `json:"version,omitempty"`
Arch string `json:"arch,omitempty"`
CPEs []string `json:"cpes.map,omitempty"`
IDs []string `json:"ids,omitempty"`
Labels map[string]string `json:"labels,omitempty"`
}

type BomPackage struct {
Expand Down
35 changes: 34 additions & 1 deletion sbom/sbom.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,13 @@ import (
_ "embed"
"encoding/json"
"fmt"
"strings"
"time"

"github.com/mitchellh/hashstructure/v2"
"go.mondoo.com/cnquery/v9"
"go.mondoo.com/cnquery/v9/explorer"
"time"
"go.mondoo.com/cnquery/v9/mrn"
)

// SBOMQueryPack is a protobuf message that contains the SBOM query pack
Expand Down Expand Up @@ -72,6 +75,8 @@ func GenerateBom(r *ReportCollectionJson) ([]Sbom, error) {
bom.Asset.Platform.Version = rb.Asset.Version
bom.Asset.Platform.Arch = rb.Asset.Arch
bom.Asset.Platform.Cpes = rb.Asset.CPEs
bom.Asset.Platform.Labels = rb.Asset.Labels
bom.Asset.PlatformIds = enrichPlatformIds(rb.Asset.IDs)
}
if rb.Packages != nil {
for _, pkg := range rb.Packages {
Expand Down Expand Up @@ -109,3 +114,31 @@ func (b *Package) Hash() (string, error) {
}
return fmt.Sprintf("%016x", hash), nil
}

// enrichPlatformIds adds the platform id based on cnquery ids
// - AWS EC2 instance ARN
func enrichPlatformIds(ids []string) []string {
platformIds := []string{}
for i := range ids {
platformIds = append(platformIds, ids[i])

// handle AWS EC2 instance platform identifier and generate AWS ARN as additional identifier
// EC2 arns have the following format arn:aws:ec2:<REGION>:<ACCOUNT_ID>:instance/<instance-id>
// //platformid.api.mondoo.app/runtime/aws/ec2/v1/accounts/12345678910/regions/us-east-1/instances/i-1234567890abcdef0
if strings.HasPrefix(ids[i], "//platformid.api.mondoo.app/runtime/aws/ec2/v1") {
ec2mrn, err := mrn.NewMRN(ids[i])
if err != nil {
continue
}

accountID, _ := ec2mrn.ResourceID("accounts")
region, _ := ec2mrn.ResourceID("regions")
instanceID, _ := ec2mrn.ResourceID("instances")

if accountID != "" && region != "" && instanceID != "" {
platformIds = append(platformIds, fmt.Sprintf("arn:aws:ec2:%s:%s:instance/%s", region, accountID, instanceID))
}
}
}
return platformIds
}
35 changes: 35 additions & 0 deletions sbom/sbom_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Copyright (c) Mondoo, Inc.
// SPDX-License-Identifier: BUSL-1.1

package sbom

import (
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"testing"
)

func TestSbomParsing(t *testing.T) {
r, err := NewReportCollectionJsonFromSingleFile("./testdata/alpine.json")
require.NoError(t, err)

sboms, err := GenerateBom(r)
require.NoError(t, err)

// store bom in different formats
selectedBom := sboms[0]

assert.Equal(t, "alpine:3.18", selectedBom.Asset.Name)
assert.Equal(t, "amd64", selectedBom.Asset.Platform.Arch)
assert.Equal(t, "alpine", selectedBom.Asset.Platform.Name)
assert.Equal(t, "3.18.4", selectedBom.Asset.Platform.Version)
assert.Equal(t, []string{"//platformid.api.mondoo.app/runtime/docker/images/e6b39dab7a69cfea9941378c0dbcc21b314c34eb22f5b9032c2023f6398e97b1"}, selectedBom.Asset.PlatformIds)
}

func TestArnGeneration(t *testing.T) {
platformID := "//platformid.api.mondoo.app/runtime/aws/ec2/v1/accounts/12345678910/regions/us-east-1/instances/i-1234567890abcdef0"
ids := enrichPlatformIds([]string{platformID})
assert.Equal(t, 2, len(ids))
assert.Contains(t, ids, platformID)
assert.Contains(t, ids, "arn:aws:ec2:us-east-1:12345678910:instance/i-1234567890abcdef0")
}
Loading