✨ Add platform PURLs (#4785)

Add the asset platform in package URL format.

Signed-off-by: Christian Zunker <[email protected]>

providers/os/resources/asset_purl.go

@@ -0,0 +1,23 @@
+// Copyright (c) Mondoo, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package resources
+
+import (
+	"go.mondoo.com/cnquery/v11/providers/os/connection/shared"
+	"go.mondoo.com/cnquery/v11/providers/os/resources/purl"
+)
+
+func (a *mqlAsset) purl() (string, error) {
+	// use platform and version to generate the purl
+	conn, ok := a.MqlRuntime.Connection.(shared.Connection)
+	if ok && conn.Asset() != nil && conn.Asset().Platform != nil {
+		purlString, err := purl.NewPlatformPurl(conn.Asset().Platform)
+		if err != nil {
+			return "", err
+		}
+		return purlString, nil
+	}
+
+	return "", nil
+}

providers/os/resources/os.lr

@@ -23,6 +23,9 @@ extend asset {
   // Deprecated; will be removed in version 12.0
   // use vulnmgmt instead
   vulnerabilityReport() dict
+  // Platform URL in the Package URL format
+  // That's a URL as alternative to the CPE format
+  purl() string
 }
 
 asset.eol @defaults("date") {

providers/os/resources/os.lr.manifest.yaml

@@ -6,6 +6,8 @@ resources:
     fields:
       cpe: {}
       cpes: {}
+      purl:
+        min_mondoo_version: 9.0.0
       vulnerabilityReport: {}
     min_mondoo_version: latest
   asset.eol:

providers/os/resources/purl/platform_purl.go

@@ -0,0 +1,42 @@
+// Copyright (c) Mondoo, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package purl
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/package-url/packageurl-go"
+	"go.mondoo.com/cnquery/v11/providers-sdk/v1/inventory"
+)
+
+func NewPlatformPurl(platform *inventory.Platform) (string, error) {
+	if platform == nil {
+		return "", fmt.Errorf("platform is required")
+	}
+
+	qualifiers := map[string]string{}
+	if platform.Arch != "" {
+		qualifiers[QualifierArch] = platform.Arch
+	}
+
+	// generate distro qualifier
+	distroQualifiers := []string{}
+	distroQualifiers = append(distroQualifiers, platform.Name)
+	if platform.Version != "" {
+		distroQualifiers = append(distroQualifiers, platform.Version)
+	} else if platform.Build != "" {
+		distroQualifiers = append(distroQualifiers, platform.Build)
+	}
+	qualifiers[QualifierDistro] = strings.Join(distroQualifiers, "-")
+
+	return packageurl.NewPackageURL(
+		"platform",
+		platform.Name,
+		"",
+		platform.Version,
+		NewQualifiers(qualifiers),
+		"",
+	).ToString(), nil
+}

providers/os/resources/purl/platform_purl_test.go

@@ -0,0 +1,178 @@
+// Copyright (c) Mondoo, Inc.
+// SPDX-License-Identifier: BUSL-1.1
+
+package purl
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"go.mondoo.com/cnquery/v11/providers-sdk/v1/inventory"
+)
+
+func TestNewPlatformPurl(t *testing.T) {
+	tests := []struct {
+		name     string
+		platform *inventory.Platform
+		want     string
+		wantErr  string
+	}{
+		{
+			name: "valid ubuntu platform",
+			platform: &inventory.Platform{
+				Name:    "ubuntu",
+				Version: "22.04",
+			},
+			want:    "pkg:platform/ubuntu/@22.04?distro=ubuntu-22.04",
+			wantErr: "",
+		},
+		{
+			name: "valid windows platform",
+			platform: &inventory.Platform{
+				Name:    "windows",
+				Version: "19045",
+			},
+			want:    "pkg:platform/windows/@19045?distro=windows-19045",
+			wantErr: "",
+		},
+		{
+			name: "platform with arch",
+			platform: &inventory.Platform{
+				Name:    "ubuntu",
+				Version: "22.04",
+				Arch:    "amd64",
+			},
+			want:    "pkg:platform/ubuntu/@22.04?arch=amd64&distro=ubuntu-22.04",
+			wantErr: "",
+		},
+		{
+			name: "platform with x86_64 arch",
+			platform: &inventory.Platform{
+				Name:    "ubuntu",
+				Version: "22.04",
+				Arch:    "x86_64",
+			},
+			want:    "pkg:platform/ubuntu/@22.04?arch=x86_64&distro=ubuntu-22.04",
+			wantErr: "",
+		},
+		{
+			name: "platform with arm64 arch",
+			platform: &inventory.Platform{
+				Name:    "ubuntu",
+				Version: "22.04",
+				Arch:    "arm64",
+			},
+			want:    "pkg:platform/ubuntu/@22.04?arch=arm64&distro=ubuntu-22.04",
+			wantErr: "",
+		},
+		{
+			name: "macplatform with apple silicon",
+			platform: &inventory.Platform{
+				Name:    "macplatform",
+				Version: "14.5.1",
+				Arch:    "arm64",
+			},
+			want:    "pkg:platform/macplatform/@14.5.1?arch=arm64&distro=macplatform-14.5.1",
+			wantErr: "",
+		},
+		{
+			name: "windows with x86 arch",
+			platform: &inventory.Platform{
+				Name:    "windows",
+				Version: "19045",
+				Arch:    "x86",
+			},
+			want:    "pkg:platform/windows/@19045?arch=x86&distro=windows-19045",
+			wantErr: "",
+		},
+		{
+			name: "vsphere platform",
+			platform: &inventory.Platform{
+				Name:    "vsphere",
+				Version: "7.0.3",
+			},
+			want:    "pkg:platform/vsphere/@7.0.3?distro=vsphere-7.0.3",
+			wantErr: "",
+		},
+		{
+			name: "esxi platform",
+			platform: &inventory.Platform{
+				Name:    "esxi",
+				Version: "7.0.3",
+				Arch:    "x86_64",
+			},
+			want:    "pkg:platform/esxi/@7.0.3?arch=x86_64&distro=esxi-7.0.3",
+			wantErr: "",
+		},
+		{
+			name: "kubernetes deployment",
+			platform: &inventory.Platform{
+				Name:    "k8s-deployment",
+				Version: "1.27",
+			},
+			want:    "pkg:platform/k8s-deployment/@1.27?distro=k8s-deployment-1.27",
+			wantErr: "",
+		},
+		{
+			name: "aws platform",
+			platform: &inventory.Platform{
+				Name: "aws",
+			},
+			want:    "pkg:platform/aws/?distro=aws",
+			wantErr: "",
+		},
+		{
+			name: "gcp platform",
+			platform: &inventory.Platform{
+				Name: "gcp",
+			},
+			want:    "pkg:platform/gcp/?distro=gcp",
+			wantErr: "",
+		},
+		{
+			name: "azure platform",
+			platform: &inventory.Platform{
+				Name: "azure",
+			},
+			want:    "pkg:platform/azure/?distro=azure",
+			wantErr: "",
+		},
+		{
+			name: "platform with build instead of version",
+			platform: &inventory.Platform{
+				Name:  "centplatform",
+				Build: "8.5",
+			},
+			want:    "pkg:platform/centplatform/?distro=centplatform-8.5",
+			wantErr: "",
+		},
+		{
+			name:     "nil platform",
+			platform: nil,
+			want:     "",
+			wantErr:  "platform is required",
+		},
+		{
+			name: "debian bookworm platform",
+			platform: &inventory.Platform{
+				Name:    "debian",
+				Version: "12",
+				Title:   "Debian GNU/Linux 12 (bookworm)",
+			},
+			want:    "pkg:platform/debian/@12?distro=debian-12",
+			wantErr: "",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := NewPlatformPurl(tt.platform)
+			if tt.wantErr != "" {
+				assert.EqualError(t, err, tt.wantErr)
+				return
+			}
+			assert.NoError(t, err)
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}