attestation

Documentation

Index

• type Attestation
  • func Reduce(atts []Attestation, filter string) ([]Attestation, error)
  • func (a Attestation) IsAttestationType(t string) bool
  • func (a Attestation) IsRegistry(registryURL string) bool
• type DefaultPrinter
  • func NewDefaultPrinter(w io.Writer) *DefaultPrinter
  • func (p *DefaultPrinter) Print(atts []Attestation) error
  • func (p *DefaultPrinter) PrintAttestation(a Attestation) error
• type Discoverer
• type File
  • func ParseFileRef(fileRef string) (File, error)
• type FilteredEnv
• type Printer
• type PublishResult
  • func Publish(ctx context.Context, repository, tagPrefix string, version string, ...) (*PublishResult, error)
• type Resolver
• type Type
  • func TypeFromString(text string) Type
  • func (i Type) String() string
  • func (t *Type) UnmarshalText(text []byte) error

Types

type Attestation

type Attestation struct {
	PURL packageurl.PackageURL
	Type Type
}

Attestation an attestation url

func Reduce

func Reduce(atts []Attestation, filter string) ([]Attestation, error)

Reduce filters the Attestations based on the given filter

func (Attestation) IsAttestationType

func (a Attestation) IsAttestationType(t string) bool

IsAttestationType indicates if a PURL has the given attestation type.

func (Attestation) IsRegistry

func (a Attestation) IsRegistry(registryURL string) bool

IsRegistry filters on a specific repository_url qualifier of the package.

type DefaultPrinter

type DefaultPrinter struct {
	// contains filtered or unexported fields
}

DefaultPrinter prints the attestation purls

func NewDefaultPrinter

func NewDefaultPrinter(w io.Writer) *DefaultPrinter

NewDefaultPrinter creates a new DefaultPrinter instance utilizing the given io.Writer

func (*DefaultPrinter) Print

func (p *DefaultPrinter) Print(atts []Attestation) error

Print prints the attestations to the io.Writer

func (*DefaultPrinter) PrintAttestation

func (p *DefaultPrinter) PrintAttestation(a Attestation) error

PrintAttestation prints a single attestation to the io.Writer

type Discoverer

type Discoverer interface {
	Discover(string) (io.Reader, error)
}

Discoverer allows to discover attestations

type File

type File interface {
	cremote.File
	Scheme() string
}

File extends cremote.File by adding Scheme

func ParseFileRef

func ParseFileRef(fileRef string) (File, error)

ParseFileRef parses a file reference as a AttestationFile

type FilteredEnv

type FilteredEnv struct {
	Attestations []Attestation
}

FilteredEnv holds the context to apply filter expressions.

type Printer

type Printer interface {
	Print(atts []Attestation) error
}

Printer allows to print results

type PublishResult

type PublishResult struct {
	OCIRef name.Reference
	PURL   *packageurl.PackageURL
}

PublishResult captures the result after publishing the attestations

func Publish

func Publish(ctx context.Context, repository, tagPrefix string, version string, att cremote.File) (*PublishResult, error)

Publish publishes the attestations to an oci repository

type Resolver

type Resolver interface {
	Resolve(io.Reader) ([]Attestation, error)
}

Resolver allows to resolve attestations

type Type

type Type int

Type enumeration of attestation types

const (
	// Unknown unknown attestation
	Unknown Type = iota
	// SBOM an sbom attestation
	SBOM
	// Provenance a provenance attestation
	Provenance
)

func TypeFromString

func TypeFromString(text string) Type

TypeFromString takes an attestation type as string and return the Type

func (Type) String

func (i Type) String() string

func (*Type) UnmarshalText

func (t *Type) UnmarshalText(text []byte) error

UnmarshalText unmarshals the type from a text form