Documentation
¶
Index ¶
- Constants
- Variables
- func AttestationTag(ref name.Reference, opts ...Option) (name.Tag, error)
- func Bundle(ref name.Reference, opts ...Option) (*sgbundle.Bundle, error)
- func DigestTag(ref name.Reference, opts ...Option) (name.Tag, error)
- func DockerContentDigest(ref name.Tag, opts ...Option) (name.Tag, error)
- func GetEnvTargetRepository() (name.Repository, error)
- func NewEntityNotFoundError(err error) error
- func Referrers(d name.Digest, artifactType string, opts ...Option) (*v1.IndexManifest, error)
- func ResolveDigest(ref name.Reference, opts ...Option) (name.Digest, error)
- func SBOMTag(ref name.Reference, opts ...Option) (name.Tag, error)
- func SignatureTag(ref name.Reference, opts ...Option) (name.Tag, error)
- func Signatures(ref name.Reference, opts ...Option) (oci.Signatures, error)
- func SignedEntity(ref name.Reference, options ...Option) (oci.SignedEntity, error)
- func SignedImage(ref name.Reference, options ...Option) (oci.SignedImage, error)
- func SignedImageIndex(ref name.Reference, options ...Option) (oci.SignedImageIndex, error)
- func SignedUnknown(digest name.Digest, options ...Option) oci.SignedEntity
- func WriteAttestationNewBundleFormat(d name.Digest, bundleBytes []byte, predicateType string, opts ...Option) error
- func WriteAttestations(repo name.Repository, se oci.SignedEntity, opts ...Option) error
- func WriteAttestationsReferrer(d name.Digest, se oci.SignedEntity, opts ...Option) error
- func WriteReferrer(d name.Digest, artifactType string, layers []v1.Layer, ...) error
- func WriteSignatures(repo name.Repository, se oci.SignedEntity, opts ...Option) error
- func WriteSignaturesExperimentalOCI(d name.Digest, se oci.SignedEntity, opts ...Option) error
- func WriteSignedImageIndexImages(ref name.Reference, sii oci.SignedImageIndex, directory string, opts ...Option) error
- type EntityNotFoundError
- type Option
- func WithAttestationSuffix(suffix string) Option
- func WithMoreRemoteOptions(opts ...remote.Option) Option
- func WithNameOptions(opts ...name.Option) Option
- func WithPrefix(prefix string) Option
- func WithRemoteOptions(opts ...remote.Option) Option
- func WithSBOMSuffix(suffix string) Option
- func WithSignatureSuffix(suffix string) Option
- func WithTargetRepository(repo name.Repository) Option
Constants ¶
const ( SignatureTagSuffix = "sig" SBOMTagSuffix = "sbom" AttestationTagSuffix = "att" CustomTagPrefix = "" RepoOverrideEnvKey = "COSIGN_REPOSITORY" )
const BundlePredicateType string = "dev.sigstore.bundle.predicateType"
Variables ¶
var ErrImageNotFound = errors.New("image not found in registry")
Functions ¶
func AttestationTag ¶
AttestationTag returns the name.Tag that associated attestations with a particular digest.
func DockerContentDigest ¶
DockerContentDigest fetches the Docker-Content-Digest header for the referenced tag, which is required to delete the object in registry API v2.3 and greater. See https://github.com/distribution/distribution/blob/main/docs/content/spec/api.md#deleting-an-image and https://github.com/distribution/distribution/issues/1579
func GetEnvTargetRepository ¶
func GetEnvTargetRepository() (name.Repository, error)
GetEnvTargetRepository returns the Repository specified by `os.Getenv(RepoOverrideEnvKey)`, or the empty value if not set. Returns an error if the value is set but cannot be parsed.
func NewEntityNotFoundError ¶
func ResolveDigest ¶
ResolveDigest returns the digest of the image at the reference.
If the reference is by digest already, it simply extracts the digest. Otherwise, it looks up the digest from the registry.
func SignatureTag ¶
SignatureTag returns the name.Tag that associated signatures with a particular digest.
func Signatures ¶
Signatures fetches the signatures image represented by the named reference. If the tag is not found, this returns an empty oci.Signatures.
func SignedEntity ¶
SignedEntity provides access to a remote reference, and its signatures. The SignedEntity will be one of SignedImage or SignedImageIndex.
func SignedImage ¶
SignedImage provides access to a remote image reference, and its signatures.
func SignedImageIndex ¶
SignedImageIndex provides access to a remote index reference, and its signatures.
func SignedUnknown ¶
func SignedUnknown(digest name.Digest, options ...Option) oci.SignedEntity
SignedUnknown provides access to signed metadata without directly accessing the underlying entity. This can be used to access signature metadata for digests that have not been published (yet).
func WriteAttestations ¶
func WriteAttestations(repo name.Repository, se oci.SignedEntity, opts ...Option) error
WriteAttestations publishes the attestations attached to the given entity into the provided repository.
func WriteAttestationsReferrer ¶
WriteAttestationsReferrer publishes the attestations attached to the given entity into the provided repository using the referrers API.
func WriteReferrer ¶
func WriteReferrer(d name.Digest, artifactType string, layers []v1.Layer, annotations map[string]string, opts ...Option) error
WriteReferrer writes a referrer manifest for a given subject digest. It uploads the provided layers and creates a manifest that refers to the subject.
func WriteSignatures ¶
func WriteSignatures(repo name.Repository, se oci.SignedEntity, opts ...Option) error
WriteSignature publishes the signatures attached to the given entity into the provided repository.
func WriteSignaturesExperimentalOCI ¶
WriteSignaturesExperimentalOCI publishes the signatures attached to the given entity into the provided repository (using OCI 1.1 methods).
func WriteSignedImageIndexImages ¶
func WriteSignedImageIndexImages(ref name.Reference, sii oci.SignedImageIndex, directory string, opts ...Option) error
WriteSignedImageIndexImages writes the images within the image index This includes the signed image and associated signatures in the image index TODO (priyawadhwa@): write the `index.json` itself to the repo as well TODO (priyawadhwa@): write the attestations
Types ¶
type EntityNotFoundError ¶
type EntityNotFoundError struct {
// contains filtered or unexported fields
}
EntityNotFoundError is the error that SignedEntity returns when the provided ref does not exist.
func (*EntityNotFoundError) Error ¶
func (e *EntityNotFoundError) Error() string
type Option ¶
type Option func(*options)
Option is a functional option for remote operations.
func WithAttestationSuffix ¶
WithAttestationSuffix is a functional option for overriding the default attestation tag suffix.
func WithMoreRemoteOptions ¶
WithMoreRemoteOptions is a functional option for adding to the default remote options already specified
func WithNameOptions ¶
WithNameOptions is a functional option for overriding the default name options passed to GGCR.
func WithPrefix ¶
WithPrefix is a functional option for overriding the default tag prefix.
func WithRemoteOptions ¶
WithRemoteOptions is a functional option for overriding the default remote options passed to GGCR.
func WithSBOMSuffix ¶
WithSBOMSuffix is a functional option for overriding the default SBOM tag suffix.
func WithSignatureSuffix ¶
WithSignatureSuffix is a functional option for overriding the default signature tag suffix.
func WithTargetRepository ¶
func WithTargetRepository(repo name.Repository) Option
WithTargetRepository is a functional option for overriding the default target repository hosting the signature and attestation tags.
Source Files