types

Documentation

Index

• Constants
• Variables
• func GetSigstoreFormatNames() []string
• func GetSourceFormatNames() []string
• type AttestationOptions
  • func (o *AttestationOptions) Validate() error
• type NoteOccurrences
• type NoteOccurrencesMap
• type Options
• type SigstoreFormat
  • func GetSigstoreFormats() []SigstoreFormat
  • func ParseSigstoreFormat(s string) (SigstoreFormat, error)
  • func (f SigstoreFormat) String() string
• type SourceFormat
  • func GetSourceFormats() []SourceFormat
  • func ParseSourceFormat(s string) (SourceFormat, error)
  • func (f SourceFormat) String() string
• type VulnerabilityOptions
  • func (o *VulnerabilityOptions) Validate() error

Constants

const (
	SigstoreFormatUnknown    SigstoreFormat = iota
	SigstoreFormatProvenance                // SLSA Provenance format

	SigstoreFormatUnknownName    = "unknown"
	SigstoreFormatProvenanceName = "provenance"
)

const (
	SourceFormatUnknown   SourceFormat = iota
	SourceFormatGrypeJSON              // grype JSON format
	SourceFormatTrivyJSON              // trivy JSON format
	SourceFormatSnykJSON               // snyk JSON format

	SourceFormatUnknownName   = "unknown"
	SourceFormatGrypeJSONName = "grype"
	SourceFormatTrivyJSONName = "trivy"
	SourceFormatSnykJSONName  = "snyk"
)

const (
	TestProjectID = "test"
)

Variables

var (
	ErrorNotSupported        = errors.New("not supported")
	ErrMissingRequiredFields = errors.New("missing required fields")
	ErrMissingProject        = errors.New("missing project")
	ErrInvalidFormat         = errors.New("invalid format")
	ErrMissingPath           = errors.New("missing path")
	ErrMissingSource         = errors.New("missing source")
	ErrInvalidSource         = errors.New("invalid source")
	ErrInternal              = errors.New("internal error")
)

Functions

func GetSigstoreFormatNames

func GetSigstoreFormatNames() []string

GetSigstoreFormatNames returns the names of the supported formats.

func GetSourceFormatNames

func GetSourceFormatNames() []string

GetSourceFormatNames returns the names of the supported source formats.

Types

type AttestationOptions

type AttestationOptions struct {
	// Project is the ID of the project to import the report into.
	Project string

	// Source is the URI of the image from which the report was generated.
	Source string

	// Quiet suppresses output
	Quiet bool
}

AttestationOptions are the options for importing an attestation.

func (*AttestationOptions) Validate

func (o *AttestationOptions) Validate() error

Validate validates the options.

type NoteOccurrences

type NoteOccurrences struct {
	// Note that the list of Occurrences points to.
	Note *g.Note

	// Occurrences that belong to the Note.
	Occurrences []*g.Occurrence
}

NoteOccurrences is a helper struct to hold Note and Occurrences.

type NoteOccurrencesMap

type NoteOccurrencesMap map[string]NoteOccurrences

type Options

type Options interface {
	Validate() error
}

type SigstoreFormat

type SigstoreFormat int64

SigstoreFormat represents the metatdata format.

func GetSigstoreFormats

func GetSigstoreFormats() []SigstoreFormat

GetSigstoreFormats returns the supported formats.

func ParseSigstoreFormat

func ParseSigstoreFormat(s string) (SigstoreFormat, error)

ParseSigstoreFormat parses the format.

func (SigstoreFormat) String

func (f SigstoreFormat) String() string

String returns the string representation of the format.

type SourceFormat

type SourceFormat int64

SourceFormat represents the source format.

func GetSourceFormats

func GetSourceFormats() []SourceFormat

GetSourceFormats returns the supported source formats.

func ParseSourceFormat

func ParseSourceFormat(s string) (SourceFormat, error)

ParseSourceFormat parses the source format.

func (SourceFormat) String

func (f SourceFormat) String() string

String returns the string representation of the source format.

type VulnerabilityOptions

type VulnerabilityOptions struct {
	// Project is the ID of the project to import the report into.
	Project string

	// Source is the URI of the image from which the report was generated.
	Source string

	// File path to the vulnerability report to import.
	File string

	// Quiet suppresses output
	Quiet bool
}

func (*VulnerabilityOptions) Validate

func (o *VulnerabilityOptions) Validate() error