catalog

type Action struct {
	Repository string          `yaml:"repository,omitempty" json:"repository,omitempty"`
	URI        string          `yaml:"uri" json:"uri"` // URI is a unique absolute identifier for the action
	Type       ActionType      `required:"true" yaml:"type" json:"type"`
	Container  ContainerAction `yaml:"container,omitempty" json:"container,omitempty"` // Container contains the configuration for containerized actions
	Version    string          `yaml:"version,omitempty" json:"version,omitempty"`
	Metadata   ActionMetadata  `yaml:"metadata" json:"metadata"`
}

type ActionAccess struct {
	Environment []ActionAccessEnv        `json:"env,omitempty"`         // Environment variables that the action may access during execution
	Executables []ActionAccessExecutable `json:"executables,omitempty"` // Executables that the action may invoke during execution
	Network     []ActionAccessNetwork    `json:"network,omitempty"`     // Network access that the action may use during execution
}

type ActionAccessEnv struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Pattern     bool   `json:"pattern,omitempty"`
	Required    bool   `json:"required,omitempty"`
	Secret      bool   `json:"secret,omitempty"` // Secret indicates that the environment variable holds a secret and should be redacted
}

type ActionAccessExecutable struct {
	Name       string `json:"name"`
	Constraint string `json:"constraint,omitempty"`
}

type ActionAccessNetwork struct {
	Host string `json:"host"`
}

type ActionArtifactType struct {
	Type          string `json:"type"`             // Type, e.g. "report", "binary"
	Format        string `json:"format,omitempty"` // Format, e.g. "sarif"
	FormatVersion string `json:"format_version,omitempty"`
}

type ActionInput struct {
	Artifacts []ActionArtifactType `json:"artifacts,omitempty"`
}

type ActionMetadata struct {
	Name          string            `json:"name"`
	Description   string            `json:"description"`
	Documentation string            `json:"documentation,omitempty"`
	Category      string            `json:"category"`
	Scope         ActionScope       `json:"scope"`
	Links         map[string]string `json:"links,omitempty"`
	Rules         []WorkflowRule    `json:"rules,omitempty"`        // Rules define conditions that must be met for the action to be executed
	RunIfChanged  []string          `json:"runIfChanged,omitempty"` // RunIfChanged defines files that must be changed for the action to be executed
	Access        ActionAccess      `json:"access,omitempty"`       // Access defines resources that the action may access
	Input         ActionInput       `json:"input,omitempty"`        // Input defines the inputs that the action may consume
	Output        ActionOutput      `json:"output,omitempty"`       // Output defines the outputs that the action may produce
}

type ActionOutput struct {
	Artifacts []ActionArtifactType `json:"artifacts,omitempty"`
}

type ActionScope string

type ActionType string

type Config struct {
	// Actions
	Actions []Action `yaml:"actions,omitempty" json:"actions,omitempty"`

	// Workflows
	Workflows []Workflow `yaml:"workflows,omitempty" json:"workflows,omitempty"`

	// ExecutableDiscovery
	ExecutableDiscovery *ExecutableDiscovery `yaml:"executable-discovery,omitempty" json:"-"`

	// Executables
	Executables []executable.TypedCandidate `yaml:"executables,omitempty" json:"executables,omitempty"`
}

type ContainerAction struct {
	Image   string       `json:"image"`   // Image is the full image reference including the registry
	Command string       `json:"command"` // Command is the command that should be executed in the container image to start the action.
	Certs   []ImageCerts `json:"certs,omitempty"`
}

type ContainerImage struct {
	Repository string           `yaml:"repository,omitempty"`
	Image      string           `yaml:"image"`
	Digest     string           `yaml:"digest,omitempty"`
	Provides   []ProvidedBinary `yaml:"provides"`
	Cache      []ImageCache     `yaml:"cache,omitempty"`
	Security   Security         `yaml:"security,omitempty"`
	User       string           `yaml:"user,omitempty"`
	Entrypoint *string          `yaml:"entrypoint,omitempty"`
	Certs      []ImageCerts     `yaml:"certs,omitempty"`

	Mounts []ContainerMount `yaml:"mounts,omitempty"` // Mounts
	Source ImageSource      `yaml:"source,omitempty"` // Source
}

type ContainerMount struct {
	Src  string `yaml:"src"`
	Dest string `yaml:"dest"`
}

type ExecutableDiscovery struct {
	ContainerDiscovery executable.DiscoverContainerOptions `yaml:"container,omitempty"`
}

type ImageCache struct {
	ID            string `yaml:"id"`
	ContainerPath string `yaml:"dir"`
	MountType     string `yaml:"type,omitempty"`
}

type ImageCerts struct {
	Type          string `yaml:"type"`
	ContainerPath string `yaml:"dir"`
}

type ImageSource struct {
	RegistryURL string `yaml:"registry_url"`
}

type ProvidedBinary struct {
	Binary  string   `yaml:"binary"`
	Version string   `yaml:"version"`
	Alias   []string `yaml:"alias,omitempty"`
}

type Security struct {
	Capabilities []string `yaml:"capabilities,omitempty"`
	Privileged   bool     `yaml:"privileged,omitempty"`
}

type Source struct {
	URI       string   `json:"uri"`
	AddedAt   string   `json:"added_at"`
	UpdatedAt string   `json:"updated_at"`
	SHA256    string   `json:"sha256"`
	Filter    []string `json:"filter"`
}

type Workflow struct {
	Repository  string          `yaml:"repository,omitempty"`
	Name        string          `required:"true" yaml:"name,omitempty"`
	Description string          `yaml:"description,omitempty"`
	Version     string          `yaml:"version,omitempty"`
	Rules       []WorkflowRule  `yaml:"rules,omitempty"`
	Stages      []WorkflowStage `yaml:"stages,omitempty"`
}

type WorkflowAction struct {
	ID     string                     `required:"true" yaml:"id"`
	Rules  []WorkflowRule             `yaml:"rules,omitempty"`
	Config interface{}                `yaml:"config,omitempty"`
	Module *analyzerapi.ProjectModule `yaml:"-"`
	Stage  string                     `yaml:"-"`
}

type WorkflowExpressionType string

type WorkflowRule struct {
	Type       WorkflowExpressionType `default:"cel" yaml:"type,omitempty"`
	Expression string                 `yaml:"expression,omitempty"`
}

type WorkflowStage struct {
	Name    string           `required:"true" yaml:"name,omitempty"`
	Rules   []WorkflowRule   `yaml:"rules,omitempty"`
	Actions []WorkflowAction `yaml:"actions,omitempty"`
}