signature

Documentation

Index

• Constants
• func Blob(sig Signature) ([]byte, error)
• func UnsupportedFormatError(sig Signature) error
• type FormatID
• type Signature
  • func FromBlob(blob []byte) (Signature, error)
• type Sigstore
  • func SigstoreFromBlobChunk(blobChunk []byte) (Sigstore, error)
  • func SigstoreFromComponents(untrustedMimeType string, untrustedPayload []byte, ...) Sigstore
  • func (s Sigstore) FormatID() FormatID
  • func (s Sigstore) UntrustedAnnotations() map[string]string
  • func (s Sigstore) UntrustedMIMEType() string
  • func (s Sigstore) UntrustedPayload() []byte
• type SimpleSigning
  • func SimpleSigningFromBlob(blobChunk []byte) SimpleSigning
  • func (s SimpleSigning) FormatID() FormatID
  • func (s SimpleSigning) UntrustedSignature() []byte

Constants

const (
	// from sigstore/cosign/pkg/types.SimpleSigningMediaType
	SigstoreSignatureMIMEType = "application/vnd.dev.cosign.simplesigning.v1+json"
	// from sigstore/cosign/pkg/oci/static.SignatureAnnotationKey
	SigstoreSignatureAnnotationKey = "dev.cosignproject.cosign/signature"
)

Functions

func Blob

func Blob(sig Signature) ([]byte, error)

BlobChunk returns a representation of sig as a []byte, suitable for long-term storage.

func UnsupportedFormatError

func UnsupportedFormatError(sig Signature) error

UnsupportedFormatError returns an error complaining about sig having an unsupported format.

Types

type FormatID

type FormatID string

FIXME FIXME: MIME type? Int? String? An interface with a name, parse methods?

const (
	SimpleSigningFormat FormatID = "simple-signing"
	SigstoreFormat      FormatID = "sigstore-json"
)

type Signature

type Signature interface {
	FormatID() FormatID
	// contains filtered or unexported methods
}

Signature is an image signature of some kind.

func FromBlob

func FromBlob(blob []byte) (Signature, error)

FromBlob returns a signature from parsing a blob created by signature.Blob.

type Sigstore

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

Sigstore is a github.com/cosign/cosign signature. For the persistent-storage format used for blobChunk(), we want a degree of forward compatibility against unexpected field changes (as has happened before), which is why this data type contains just a payload + annotations (including annotations that we don’t recognize or support), instead of individual fields for the known annotations.

func SigstoreFromBlobChunk

func SigstoreFromBlobChunk(blobChunk []byte) (Sigstore, error)

SigstoreFromBlobChunk converts a Sigstore signature, as returned by Sigstore.blobChunk, into a Sigstore object.

func SigstoreFromComponents

func SigstoreFromComponents(untrustedMimeType string, untrustedPayload []byte, untrustedAnnotations map[string]string) Sigstore

SigstoreFromComponents returns a Sigstore object from its components.

func (Sigstore) FormatID

func (s Sigstore) FormatID() FormatID

func (Sigstore) UntrustedAnnotations

func (s Sigstore) UntrustedAnnotations() map[string]string

func (Sigstore) UntrustedMIMEType

func (s Sigstore) UntrustedMIMEType() string

func (Sigstore) UntrustedPayload

func (s Sigstore) UntrustedPayload() []byte

type SimpleSigning

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

SimpleSigning is a “simple signing” signature.

func SimpleSigningFromBlob

func SimpleSigningFromBlob(blobChunk []byte) SimpleSigning

SimpleSigningFromBlob converts a “simple signing” signature into a SimpleSigning object.

func (SimpleSigning) FormatID

func (s SimpleSigning) FormatID() FormatID

func (SimpleSigning) UntrustedSignature

func (s SimpleSigning) UntrustedSignature() []byte