slsa-verifier/verifiers/utils/builder.go

package utils

import (
	"fmt"
	"strings"

	serrors "github.com/slsa-framework/slsa-verifier/errors"
)

type BuilderID struct {
	name, version string
}

// BuilderIDNew creates a new BuilderID structure.
func BuilderIDNew(builderID string) (*BuilderID, error) {
	name, version, err := ParseBuilderID(builderID, true)
	if err != nil {
		return nil, err
	}

	return &BuilderID{
		name:    name,
		version: version,
	}, nil
}

// Matches matches the builderID string against the reference builderID.
// If the builderID contains a semver, the full builderID must match.
// Otherwise, only the name needs to match.
func (b *BuilderID) Matches(builderID string) error {
	name, version, err := ParseBuilderID(builderID, false)
	if err != nil {
		return err
	}

	if name != b.name {
		return fmt.Errorf("%w: expected name '%s', got '%s'", serrors.ErrorMismatchBuilderID,
			name, b.name)
	}

	if version != "" && version != b.version {
		return fmt.Errorf("%w: expected version '%s', got '%s'", serrors.ErrorMismatchBuilderID,
			version, b.version)
	}

	return nil
}

func (b *BuilderID) Name() string {
	return b.name
}

func (b *BuilderID) Version() string {
	return b.version
}

func (b *BuilderID) String() string {
	return fmt.Sprintf("%s@%s", b.name, b.version)
}

// TODO: remove this function once GHA is supported.
func (b *BuilderID) SetName(name string) {
	b.name = name
}

func (b *BuilderID) SetVersion(version string) {
	b.version = version
}

func ParseBuilderID(id string, needVersion bool) (string, string, error) {
	parts := strings.Split(id, "@")
	if len(parts) == 2 {
		if parts[1] == "" {
			return "", "", fmt.Errorf("%w: builderID: '%s'",
				serrors.ErrorInvalidFormat, id)
		}
		return parts[0], parts[1], nil
	}

	if len(parts) == 1 && !needVersion {
		return parts[0], "", nil
	}

	return "", "", fmt.Errorf("%w: builderID: '%s'",
		serrors.ErrorInvalidFormat, id)
}