crafter

Documentation

Index

• Variables
• func LoadSchema(pathOrURI string) (*schemaapi.CraftingSchema, error)
• func NewRunner(t schemaapi.CraftingSchema_Runner_RunnerType) supportedRunner
• type CommitRemote
• type Crafter
  • func NewCrafter(opts ...NewOpt) *Crafter
  • func (c *Crafter) AddMaterial(key, value string, casBackend *casclient.CASBackend, ...) error
  • func (c *Crafter) AlreadyInitialized() bool
  • func (c *Crafter) Init(opts *InitOpts) error
  • func (c *Crafter) LoadCraftingState() error
  • func (c *Crafter) Reset() error
  • func (c *Crafter) ResolveEnvVars(strict bool) error
  • func (c *Crafter) ValidateAttestation() error
• type HeadCommit
• type InitOpts
• type NewOpt
  • func WithLogger(l *zerolog.Logger) NewOpt
  • func WithStatePath(path string) NewOpt
  • func WithWorkingDirPath(path string) NewOpt

Variables

var ErrAttestationStateNotLoaded = errors.New("crafting state not loaded")

var ErrRunnerContextNotFound = errors.New("the runner environment doesn't match the required runner type")

Functions

func LoadSchema

func LoadSchema(pathOrURI string) (*schemaapi.CraftingSchema, error)

func NewRunner

func NewRunner(t schemaapi.CraftingSchema_Runner_RunnerType) supportedRunner

Types

type CommitRemote

type CommitRemote struct {
	Name, URL string
}

type Crafter

type Crafter struct {
	CraftingState *api.CraftingState
	Runner        supportedRunner
	// contains filtered or unexported fields
}

func NewCrafter

func NewCrafter(opts ...NewOpt) *Crafter

Create a completely new crafter

func (*Crafter) AddMaterial

func (c *Crafter) AddMaterial(key, value string, casBackend *casclient.CASBackend, runtimeAnnotations map[string]string) error

Inject material to attestation state

func (*Crafter) AlreadyInitialized

func (c *Crafter) AlreadyInitialized() bool

func (*Crafter) Init

func (c *Crafter) Init(opts *InitOpts) error

Initialize the crafter with a remote or local schema

func (*Crafter) LoadCraftingState

func (c *Crafter) LoadCraftingState() error

func (*Crafter) Reset

func (c *Crafter) Reset() error

Reset removes the current crafting state

func (*Crafter) ResolveEnvVars

func (c *Crafter) ResolveEnvVars(strict bool) error

ResolveEnvVars will iterate on the env vars in the allow list and resolve them from the system context strict indicates if it should fail if any env variable can not be found

func (*Crafter) ValidateAttestation

func (c *Crafter) ValidateAttestation() error

type HeadCommit

type HeadCommit struct {
	// hash of the commit
	Hash string
	// When did the commit happen
	Date time.Time
	// Author of the commit
	AuthorEmail, AuthorName string
	// Commit Message
	Message string
	Remotes []*CommitRemote
}

type InitOpts

type InitOpts struct {
	// Control plane workflow metadata
	WfInfo *api.WorkflowMetadata
	// already marshaled schema
	SchemaV1 *schemaapi.CraftingSchema
	// do not record, upload or push attestation
	DryRun bool
}

type NewOpt

type NewOpt func(c *Crafter)

func WithLogger

func WithLogger(l *zerolog.Logger) NewOpt

func WithStatePath

func WithStatePath(path string) NewOpt

where to store the attestation state file

func WithWorkingDirPath

func WithWorkingDirPath(path string) NewOpt