oci

package
v0.74.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 14, 2026 License: Apache-2.0 Imports: 22 Imported by: 14

Documentation

Index

Constants

View Source 
const (
	// Artifact types
	CycloneDXArtifactType = "application/vnd.cyclonedx+json"
	SPDXArtifactType      = "application/spdx+json"

	// Sigstore bundle artifact type for Cosign attestations in "new bundle format" > 2.5.0
	SigstoreBundleArtifactType = "application/vnd.dev.sigstore.bundle.v0.3+json"

	// DSSE envelope artifact type for legacy Cosign attestations (.att tag)
	DSSEEnvelopeArtifactType = "application/vnd.dsse.envelope.v1+json"

	// Generic in-toto artifact type, used by Docker Scout for every attestation.
	// The payload is either a bare in-toto statement or a DSSE envelope.
	InTotoArtifactType = "application/vnd.in-toto+json"

	// Media types
	OCIImageManifest = "application/vnd.oci.image.manifest.v1+json"

	// Optional annotation naming the in-toto predicate type of a referrer
	PredicateTypeAnnotation = "in-toto.io/predicate-type"
)

Variables

View Source 
var SupportedSBOMArtifactTypes = []string{
	CycloneDXArtifactType,
	SPDXArtifactType,
	SigstoreBundleArtifactType,
}

Functions

func Referrers added in v0.73.0 

func Referrers(ctx context.Context, digest name.Digest, opts types.RegistryOptions,
	artifactTypes set.Set[string]) ([]v1.Descriptor, error)

Referrers lists the OCI 1.1 referrers of digest whose ArtifactType is one of artifactTypes, preserving the registry order. It returns an empty slice (not an error) when the registry exposes no matching referrers, so callers decide what "no referrers" means for them.

Types

type Artifact 

type Artifact struct {

	// For OCI registries
	types.RegistryOptions
	// contains filtered or unexported fields
}

Artifact is used to download artifacts such as vulnerability database and policies from OCI registries.

func NewArtifact 

func NewArtifact(repo string, registryOpt types.RegistryOptions, opts ...Option) *Artifact

NewArtifact returns a new artifact

func (*Artifact) Blob added in v0.73.0 

func (a *Artifact) Blob(ctx context.Context) (io.ReadCloser, error)

Blob returns the uncompressed content of a single-layer OCI artifact as a stream. The caller must close it.

func (*Artifact) Digest 

func (a *Artifact) Digest(ctx context.Context) (string, error)

func (*Artifact) Download 

func (a *Artifact) Download(ctx context.Context, dir string, opt DownloadOption) error

func (*Artifact) Manifest added in v0.69.0 

func (a *Artifact) Manifest(ctx context.Context) (*v1.Manifest, error)

type Artifacts added in v0.56.0 

type Artifacts []*Artifact

func NewArtifacts added in v0.56.0 

func NewArtifacts(repos []name.Reference, opt types.RegistryOptions, opts ...Option) Artifacts

NewArtifacts returns a slice of artifacts.

func (Artifacts) Download added in v0.56.0 

func (a Artifacts) Download(ctx context.Context, dst string, opt DownloadOption) error

Download downloads artifacts until one of them succeeds. Attempts to download next artifact if the first one fails due to a temporary error.

type DownloadOption added in v0.39.0 

type DownloadOption struct {
	MediaType string // Accept any media type if not specified
	Filename  string // Use the annotation if not specified
	Quiet     bool
}

type Option 

type Option func(*Artifact)

Option is a functional option

func WithImage 

func WithImage(img v1.Image) Option

WithImage takes an OCI v1 Image

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.