notary

README

notary

A collection of libraries for supporting notary v2 sign, verify, push, pull of oci artifacts

Documentation

Index

• type SignatureRegistry
• type SignatureRepository
• type SigningService

Types

type SignatureRegistry

type SignatureRegistry interface {
	Repository(ctx context.Context, name string) SignatureRepository
}

SignatureRegistry provides signature repositories

type SignatureRepository

type SignatureRepository interface {
	// Lookup finds all signatures for the specified manifest
	Lookup(ctx context.Context, manifestDigest digest.Digest) ([]digest.Digest, error)

	// Get downloads the signature by the specified digest
	Get(ctx context.Context, signatureDigest digest.Digest) ([]byte, error)

	// Put uploads the signature to the registry
	Put(ctx context.Context, signature []byte) (oci.Descriptor, error)

	// Link creates an signature artifact linking the manifest and the signature
	Link(ctx context.Context, manifest, signature oci.Descriptor) (oci.Descriptor, error)
}

SignatureRepository provides a storage for signatures

type SigningService

type SigningService interface {
	Sign(ctx context.Context, desc oci.Descriptor, references ...string) ([]byte, error)
	Verify(ctx context.Context, desc oci.Descriptor, signature []byte) ([]string, error)
}

SigningService provides signature signing and verification services.