Merge pull request #393 from oasisprotocol/kostko/feature/rofl-metadata

feat(cmd/rofl): Add repository/author/license and other app metadata

Author: kostko

.golangci.yml

@@ -74,6 +74,7 @@ linters-settings:
           - golang.org/x/text
           - gopkg.in/yaml.v3
           - github.com/compose-spec/compose-go/v2
+          - github.com/github/go-spdx/v2
   exhaustive:
     # Switch statements are to be considered exhaustive if a 'default' case is
     # present, even if all enum members aren't listed in the switch.

build/rofl/manifest.go

@@ -3,12 +3,16 @@ package rofl
 import (
 	"errors"
 	"fmt"
+	"maps"
+	"net/mail"
+	"net/url"
 	"os"
 	"path/filepath"
 	"strings"
 
 	"gopkg.in/yaml.v3"
 
+	"github.com/github/go-spdx/v2/spdxexp"
 	"github.com/oasisprotocol/oasis-core/go/common/version"
 
 	"github.com/oasisprotocol/oasis-sdk/client-sdk/go/modules/rofl"
@@ -45,6 +49,16 @@ type Manifest struct {
 	Name string `yaml:"name" json:"name"`
 	// Version is the ROFL app version.
 	Version string `yaml:"version" json:"version"`
+	// Repository is the ROFL app repository URL.
+	Repository string `yaml:"repository,omitempty" json:"repository,omitempty"`
+	// Author is the ROFL app author full name and e-mail.
+	Author string `yaml:"author,omitempty" json:"author,omitempty"`
+	// License is the ROFL app SPDX license expression.
+	License string `yaml:"license,omitempty" json:"license,omitempty"`
+	// Homepage is the ROFL app homepage.
+	Homepage string `yaml:"homepage,omitempty" json:"homepage,omitempty"`
+	// Description is the ROFL app description.
+	Description string `yaml:"description,omitempty" json:"description,omitempty"`
 	// TEE is the type of TEE to build for.
 	TEE string `yaml:"tee" json:"tee"`
 	// Kind is the kind of ROFL app to build.
@@ -122,6 +136,19 @@ func (m *Manifest) Validate() error {
 		return fmt.Errorf("malformed version: %w", err)
 	}
 
+	if _, err := url.Parse(m.Repository); err != nil && m.Repository != "" {
+		return fmt.Errorf("malformed repository URL: %w", err)
+	}
+	if _, err := mail.ParseAddress(m.Author); err != nil && m.Author != "" {
+		return fmt.Errorf("malformed author: %w", err)
+	}
+	if _, err := spdxexp.ExtractLicenses(m.License); err != nil && m.License != "" {
+		return fmt.Errorf("malformed license: %w", err)
+	}
+	if _, err := url.Parse(m.Homepage); err != nil && m.Homepage != "" {
+		return fmt.Errorf("malformed homepage URL: %w", err)
+	}
+
 	switch m.TEE {
 	case TEETypeSGX, TEETypeTDX:
 	default:
@@ -154,6 +181,38 @@ func (m *Manifest) Validate() error {
 	return nil
 }
 
+// globalMetadataPrefix is the prefix used for all global metadata.
+const globalMetadataPrefix = "net.oasis.rofl."
+
+// GetMetadata derives metadata from the attributes defined in the manifest and combines it with
+// the metadata for the specified deployment.
+func (m *Manifest) GetMetadata(deployment string) map[string]string {
+	meta := make(map[string]string)
+	for _, md := range []struct {
+		name  string
+		value string
+	}{
+		{"name", m.Name},
+		{"version", m.Version},
+		{"repository", m.Repository},
+		{"author", m.Author},
+		{"license", m.License},
+		{"homepage", m.Homepage},
+		{"description", m.Description},
+	} {
+		if md.value == "" {
+			continue
+		}
+		meta[globalMetadataPrefix+md.name] = md.value
+	}
+
+	d, ok := m.Deployments[deployment]
+	if ok {
+		maps.Copy(meta, d.Metadata)
+	}
+	return meta
+}
+
 // SourceFileName returns the filename of the manifest file from which the manifest was loaded or
 // an empty string in case the filename is not available.
 func (m *Manifest) SourceFileName() string {

cmd/rofl/mgmt.go

@@ -66,6 +66,7 @@ var (
 			}
 
 			// Create a default manifest without any deployments.
+			// TODO: Extract author and repository from Git configuration if available.
 			manifest := buildRofl.Manifest{
 				Name:    appName,
 				Version: "0.1.0",
@@ -225,8 +226,9 @@ var (
 
 			// Prepare transaction.
 			tx := rofl.NewCreateTx(nil, &rofl.Create{
-				Policy: *deployment.Policy,
-				Scheme: idScheme,
+				Policy:   *deployment.Policy,
+				Scheme:   idScheme,
+				Metadata: manifest.GetMetadata(deploymentName),
 			})
 
 			acc := common.LoadAccount(cfg, npa.AccountName)
@@ -260,7 +262,7 @@ var (
 			npa := common.GetNPASelection(cfg)
 			txCfg := common.GetTransactionConfig()
 
-			_, deployment := roflCommon.LoadManifestAndSetNPA(cfg, npa, deploymentName, &roflCommon.ManifestOptions{
+			manifest, deployment := roflCommon.LoadManifestAndSetNPA(cfg, npa, deploymentName, &roflCommon.ManifestOptions{
 				NeedAppID: true,
 				NeedAdmin: true,
 			})
@@ -303,7 +305,7 @@ var (
 			updateBody := rofl.Update{
 				ID:       appID,
 				Policy:   *deployment.Policy,
-				Metadata: deployment.Metadata,
+				Metadata: manifest.GetMetadata(deploymentName),
 				Secrets:  secrets,
 			}
 

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/compose-spec/compose-go/v2 v2.4.8
 	github.com/ethereum/go-ethereum v1.15.0
 	github.com/foxboron/go-uefi v0.0.0-20241017190036-fab4fdf2f2f3
+	github.com/github/go-spdx/v2 v2.3.2
 	github.com/miguelmota/go-ethereum-hdwallet v0.1.2
 	github.com/mitchellh/mapstructure v1.5.0
 	github.com/oasisprotocol/curve25519-voi v0.0.0-20230904125328-1f23a7beb09a

go.sum

@@ -177,6 +177,8 @@ github.com/fsnotify/fsnotify v1.7.0 h1:8JEhPFa5W2WU7YfeZzPNqzMP6Lwt7L2715Ggo0nos
 github.com/fsnotify/fsnotify v1.7.0/go.mod h1:40Bi/Hjc2AVfZrqy+aj+yEI+/bRxZnMJyTJwOpGvigM=
 github.com/fxamacker/cbor/v2 v2.4.0 h1:ri0ArlOR+5XunOP8CRUowT0pSJOwhW098ZCUyskZD88=
 github.com/fxamacker/cbor/v2 v2.4.0/go.mod h1:TA1xS00nchWmaBnEIxPSE5oHLuJBAVvqrtAnWBwBCVo=
+github.com/github/go-spdx/v2 v2.3.2 h1:IfdyNHTqzs4zAJjXdVQfRnxt1XMfycXoHBE2Vsm1bjs=
+github.com/github/go-spdx/v2 v2.3.2/go.mod h1:2ZxKsOhvBp+OYBDlsGnUMcchLeo2mrpEBn2L1C+U3IQ=
 github.com/gliderlabs/ssh v0.3.5 h1:OcaySEmAQJgyYcArR+gGGTHCyE7nvhEMTlYY+Dp8CpY=
 github.com/gliderlabs/ssh v0.3.5/go.mod h1:8XB4KraRrX39qHhT6yxPsHedjA08I/uBVwj4xC+/+z4=
 github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 h1:+zs/tPmkDkHx3U66DAb0lQFJrpS6731Oaa12ikc+DiI=