provenance

Documentation

Index

• Constants
• func FilterArgs(m map[string]string) map[string]string
• type BuildConfig
• type BuildStep
• type Capture
  • func (c *Capture) AddGit(g GitSource)
  • func (c *Capture) AddHTTP(h HTTPSource)
  • func (c *Capture) AddImage(i ImageSource)
  • func (c *Capture) AddLocal(l LocalSource)
  • func (c *Capture) AddSSH(s SSH)
  • func (c *Capture) AddSamples(dgst digest.Digest, samples *resourcestypes.Samples)
  • func (c *Capture) AddSecret(s Secret)
  • func (c *Capture) Merge(c2 *Capture) error
  • func (c *Capture) OptimizeImageSources() error
  • func (c *Capture) Sort()
• type Environment
• type GitSource
• type HTTPSource
• type ImageSource
• type LocalSource
• type Parameters
• type ProvenanceInvocation
• type ProvenanceMetadata
• type ProvenancePredicate
  • func NewPredicate(c *Capture) (*ProvenancePredicate, error)
• type Result
• type SSH
• type Secret
• type ShipyardMetadata
• type Source
• type SourceInfo
• type Sources

Constants

const (
	ShipyardBuildType = "https://mobyproject.org/shipyard@v1"
)

Functions

func FilterArgs

func FilterArgs(m map[string]string) map[string]string

Types

type BuildConfig

type BuildConfig struct {
	Definition    []BuildStep              `json:"llbDefinition,omitempty"`
	DigestMapping map[digest.Digest]string `json:"digestMapping,omitempty"`
}

type BuildStep

type BuildStep struct {
	ID            string                  `json:"id,omitempty"`
	Op            pb.Op                   `json:"op,omitempty"`
	Inputs        []string                `json:"inputs,omitempty"`
	ResourceUsage *resourcestypes.Samples `json:"resourceUsage,omitempty"`
}

type Capture

type Capture struct {
	Frontend            string
	Args                map[string]string
	Sources             Sources
	Secrets             []Secret
	SSH                 []SSH
	NetworkAccess       bool
	IncompleteMaterials bool
	Samples             map[digest.Digest]*resourcestypes.Samples
}

func (*Capture) AddGit

func (c *Capture) AddGit(g GitSource)

func (*Capture) AddHTTP

func (c *Capture) AddHTTP(h HTTPSource)

func (*Capture) AddImage

func (c *Capture) AddImage(i ImageSource)

func (*Capture) AddLocal

func (c *Capture) AddLocal(l LocalSource)

func (*Capture) AddSSH

func (c *Capture) AddSSH(s SSH)

func (*Capture) AddSamples

func (c *Capture) AddSamples(dgst digest.Digest, samples *resourcestypes.Samples)

func (*Capture) AddSecret

func (c *Capture) AddSecret(s Secret)

func (*Capture) Merge

func (c *Capture) Merge(c2 *Capture) error

func (*Capture) OptimizeImageSources

func (c *Capture) OptimizeImageSources() error

OptimizeImageSources filters out image sources by digest reference if same digest is already present by a tag reference.

func (*Capture) Sort

func (c *Capture) Sort()

type Environment

type Environment struct {
	Platform string `json:"platform"`
}

type GitSource

type GitSource struct {
	URL    string
	Commit string
}

type HTTPSource

type HTTPSource struct {
	URL    string
	Digest digest.Digest
}

type ImageSource

type ImageSource struct {
	Ref      string
	Platform *ocispecs.Platform
	Digest   digest.Digest
	Local    bool
}

type LocalSource

type LocalSource struct {
	Name string `json:"name"`
}

type Parameters

type Parameters struct {
	Frontend string            `json:"frontend,omitempty"`
	Args     map[string]string `json:"args,omitempty"`
	Secrets  []*Secret         `json:"secrets,omitempty"`
	SSH      []*SSH            `json:"ssh,omitempty"`
	Locals   []*LocalSource    `json:"locals,omitempty"`
}

type ProvenanceInvocation

type ProvenanceInvocation struct {
	ConfigSource slsa02.ConfigSource `json:"configSource,omitempty"`
	Parameters   Parameters          `json:"parameters,omitempty"`
	Environment  Environment         `json:"environment,omitempty"`
}

type ProvenanceMetadata

type ProvenanceMetadata struct {
	slsa02.ProvenanceMetadata
	ShipyardMetadata ShipyardMetadata `json:"https://mobyproject.org/shipyard@v1#metadata,omitempty"`
	Hermetic         bool             `json:"https://mobyproject.org/shipyard@v1#hermetic,omitempty"`
}

type ProvenancePredicate

type ProvenancePredicate struct {
	slsa02.ProvenancePredicate
	Invocation  ProvenanceInvocation `json:"invocation,omitempty"`
	BuildConfig *BuildConfig         `json:"buildConfig,omitempty"`
	Metadata    *ProvenanceMetadata  `json:"metadata,omitempty"`
}

func NewPredicate

func NewPredicate(c *Capture) (*ProvenancePredicate, error)

type Result

type Result = result.Result[*Capture]

type SSH

type SSH struct {
	ID       string `json:"id"`
	Optional bool   `json:"optional,omitempty"`
}

type Secret

type Secret struct {
	ID       string `json:"id"`
	Optional bool   `json:"optional,omitempty"`
}

type ShipyardMetadata

type ShipyardMetadata struct {
	VCS      map[string]string                  `json:"vcs,omitempty"`
	Source   *Source                            `json:"source,omitempty"`
	Layers   map[string][][]ocispecs.Descriptor `json:"layers,omitempty"`
	SysUsage []*resourcetypes.SysSample         `json:"sysUsage,omitempty"`
}

type Source

type Source struct {
	Locations map[string]*pb.Locations `json:"locations,omitempty"`
	Infos     []SourceInfo             `json:"infos,omitempty"`
}

type SourceInfo

type SourceInfo struct {
	Filename      string                   `json:"filename,omitempty"`
	Language      string                   `json:"language,omitempty"`
	Data          []byte                   `json:"data,omitempty"`
	Definition    []BuildStep              `json:"llbDefinition,omitempty"`
	DigestMapping map[digest.Digest]string `json:"digestMapping,omitempty"`
}

type Sources

type Sources struct {
	Images []ImageSource
	Git    []GitSource
	HTTP   []HTTPSource
	Local  []LocalSource
}