content

Documentation

Index

• Variables
• type S3Client
• type S3ReadCloser
• type S3StreamWriter
  • func NewStreamWriter(s3c S3Client, vc VaultClient, vp string) *S3StreamWriter
  • func (s S3StreamWriter) StreamAndWrite(ctx context.Context, filename string, w io.Writer) error
• type VaultClient
• type Writer

Variables

var (
	VaultFilenameEmptyErr = errors.New("vault filename required but was empty")
)

Types

type S3Client

type S3Client interface {
	GetWithPSK(key string, psk []byte) (io.ReadCloser, *int64, error)
}

S3Client is an interface to represent methods called to retrieve from s3

type S3ReadCloser

type S3ReadCloser io.ReadCloser

S3ReadCloser is an io.ReadCloser alias to allow mockgen to create a mock impl for the tests

type S3StreamWriter

type S3StreamWriter struct {
	VaultCli  VaultClient
	VaultPath string
	S3Client  S3Client
}

S3StreamWriter provides functionality for retrieving content from an S3 bucket. The content is streamed/decrypted and and written to the provided io.Writer

func NewStreamWriter

func NewStreamWriter(s3c S3Client, vc VaultClient, vp string) *S3StreamWriter

NewStreamWriter create a new S3StreamWriter instance.

func (S3StreamWriter) StreamAndWrite

func (s S3StreamWriter) StreamAndWrite(ctx context.Context, filename string, w io.Writer) error

StreamAndWrite decrypt and stream the request file writing the content to the provided io.Writer.

type VaultClient

type VaultClient interface {
	ReadKey(path, key string) (string, error)
}

VaultClient is an interface to represent methods called to action upon vault

type Writer

type Writer io.Writer

Writer is an io.Writer alias to allow mockgen to create a mock impl for the tests