signer

Documentation

Overview

Package signer provides notation signing functionality. It implements the notation.Signer interface by providing builtinSigner for local signing and PluginSigner for remote signing.

Index

• func New(key crypto.PrivateKey, certChain []*x509.Certificate) (notation.Signer, error)
• func NewFromFiles(keyPath, certChainPath string) (notation.Signer, error)
• func NewFromPlugin(plugin plugin.SignPlugin, keyID string, pluginConfig map[string]string) (notation.Signer, error)
• type GenericSigner
  • func NewGenericSigner(key crypto.PrivateKey, certChain []*x509.Certificate) (*GenericSigner, error)
  • func NewGenericSignerFromFiles(keyPath, certChainPath string) (*GenericSigner, error)
  • func (s *GenericSigner) Sign(ctx context.Context, desc ocispec.Descriptor, opts notation.SignerSignOptions) ([]byte, *signature.SignerInfo, error)
• type PluginSigner
  • func NewPluginSigner(plugin plugin.SignPlugin, keyID string, pluginConfig map[string]string) (*PluginSigner, error)
  • func (s *PluginSigner) PluginAnnotations() map[string]string
  • func (s *PluginSigner) Sign(ctx context.Context, desc ocispec.Descriptor, opts notation.SignerSignOptions) ([]byte, *signature.SignerInfo, error)

Functions

func New

func New(key crypto.PrivateKey, certChain []*x509.Certificate) (notation.Signer, error)

New returns a builtinSigner given key and cert chain

Deprecated: New function exists for historical compatibility and should not be used. To create GenericSigner, use NewGenericSigner() function.

func NewFromFiles

func NewFromFiles(keyPath, certChainPath string) (notation.Signer, error)

NewFromFiles returns a builtinSigner given key and certChain paths.

func NewFromPlugin

func NewFromPlugin(plugin plugin.SignPlugin, keyID string, pluginConfig map[string]string) (notation.Signer, error)

NewFromPlugin creates a notation.Signer that signs artifacts and generates signatures by delegating the one or more operations to the named plugin, as defined in https://github.com/notaryproject/notaryproject/blob/main/specs/plugin-extensibility.md#signing-interfaces.

Deprecated: NewFromPlugin function exists for historical compatibility and should not be used. To create PluginSigner, use NewPluginSigner() function.

Types

type GenericSigner

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

GenericSigner implements notation.Signer and embeds signature.Signer

func NewGenericSigner

func NewGenericSigner(key crypto.PrivateKey, certChain []*x509.Certificate) (*GenericSigner, error)

NewGenericSigner returns a builtinSigner given key and cert chain

func NewGenericSignerFromFiles

func NewGenericSignerFromFiles(keyPath, certChainPath string) (*GenericSigner, error)

NewGenericSignerFromFiles returns a builtinSigner given key and certChain paths.

func (*GenericSigner) Sign

func (s *GenericSigner) Sign(ctx context.Context, desc ocispec.Descriptor, opts notation.SignerSignOptions) ([]byte, *signature.SignerInfo, error)

Sign signs the artifact described by its descriptor and returns the marshalled envelope.

type PluginSigner

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

PluginSigner signs artifacts and generates signatures. It implements notation.Signer

func NewPluginSigner

func NewPluginSigner(plugin plugin.SignPlugin, keyID string, pluginConfig map[string]string) (*PluginSigner, error)

NewPluginSigner creates a notation.Signer that signs artifacts and generates signatures by delegating the one or more operations to the named plugin, as defined in https://github.com/notaryproject/notaryproject/blob/main/specs/plugin-extensibility.md#signing-interfaces.

func (*PluginSigner) PluginAnnotations

func (s *PluginSigner) PluginAnnotations() map[string]string

PluginAnnotations returns signature manifest annotations returned from plugin

func (*PluginSigner) Sign

func (s *PluginSigner) Sign(ctx context.Context, desc ocispec.Descriptor, opts notation.SignerSignOptions) ([]byte, *signature.SignerInfo, error)

Sign signs the artifact described by its descriptor and returns the marshalled envelope.