api

Documentation

Index

• type ComponentSigningVerifier
  • func (c *ComponentSigningVerifier) Sign(componentVersion ocm.ComponentVersionAccess, opts ...OptionFunc) (*metav1.DigestSpec, error)
  • func (c *ComponentSigningVerifier) Verify(componentVersion ocm.ComponentVersionAccess, opts ...OptionFunc) (*metav1.DigestSpec, error)
• type OptionFunc
  • func WithPrinter(printer common.Printer) OptionFunc
  • func WithSignerOptions(ctx ocm.Context, sopts *signing.Options) OptionFunc
  • func WithState(state signing.WalkingState) OptionFunc
• type Options
• type Signer
• type SigningVerifier
• type Verifier

Types

type ComponentSigningVerifier

type ComponentSigningVerifier struct{}

ComponentSigningVerifier can sign a component version.

func (*ComponentSigningVerifier) Sign

func (c *ComponentSigningVerifier) Sign(componentVersion ocm.ComponentVersionAccess, opts ...OptionFunc) (*metav1.DigestSpec, error)

Sign takes a context and a component and sign it using some default values and various options passed in.

func (*ComponentSigningVerifier) Verify

func (c *ComponentSigningVerifier) Verify(componentVersion ocm.ComponentVersionAccess, opts ...OptionFunc) (*metav1.DigestSpec, error)

Verify takes a context and a component and verifies its signature.

type OptionFunc

type OptionFunc func(opts *Options) error

func WithPrinter

func WithPrinter(printer common.Printer) OptionFunc

WithPrinter allows for passing in a printer option.

func WithSignerOptions

func WithSignerOptions(ctx ocm.Context, sopts *signing.Options) OptionFunc

WithSignerOptions allows for fine-tuning the signing options.

func WithState

func WithState(state signing.WalkingState) OptionFunc

WithState allows fine-tuning the walking state. In reality, the default is sufficient in most cases.

type Options

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

Options defines high level options that can be configured for signing a component.

type Signer

type Signer interface {
	Sign(componentVersion ocm.ComponentVersionAccess, opts ...OptionFunc) (*metav1.DigestSpec, error)
}

Signer can sign objects using specific algorithm or sensible defaults.

type SigningVerifier

type SigningVerifier interface {
	Signer
	Verifier
}

type Verifier

type Verifier interface {
	Verify(componentVersion ocm.ComponentVersionAccess, opts ...OptionFunc) (*metav1.DigestSpec, error)
}