container

Documentation

Overview

Package container exposes Secret Container operations.

Index

• func Dump(w io.Writer, c *containerv1.Container) error
• func IsSealed(container *containerv1.Container) bool
• func Load(r io.Reader) (*containerv1.Container, error)
• func Seal(rand io.Reader, container *containerv1.Container, opts ...Option) (*containerv1.Container, error)
• func Unseal(container *containerv1.Container, identity *memguard.LockedBuffer, ...) (*containerv1.Container, error)
• type Option
  • func WithPeerPublicKeys(peers []string) Option
  • func WithPreSharedKey(psk *memguard.LockedBuffer) Option
• type Options

Functions

func Dump

func Dump(w io.Writer, c *containerv1.Container) error

Dump the marshaled container instance to writer.

func IsSealed

func IsSealed(container *containerv1.Container) bool

IsSealed returns true if the given container is sealed.

func Load

func Load(r io.Reader) (*containerv1.Container, error)

Load a reader to extract as a container.

func Seal

func Seal(rand io.Reader, container *containerv1.Container, opts ...Option) (*containerv1.Container, error)

func Unseal

func Unseal(container *containerv1.Container, identity *memguard.LockedBuffer, opts ...Option) (*containerv1.Container, error)

Unseal a sealed container with the given identity.

Types

type Option

type Option func(opts *Options)

Option describes generate container operation options.

func WithPeerPublicKeys

func WithPeerPublicKeys(peers []string) Option

WithPeerPublicKeys sets the public key which are able to unseal the container.

func WithPreSharedKey

func WithPreSharedKey(psk *memguard.LockedBuffer) Option

WithPreSharedKey sets the pre-sharey used for seal/unseal operations.

type Options

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

Options defines the operation settings.