secretsource

Documentation

Overview

Package secretsource is a package to provide secret source interface and common functionality This functionality is to be used to provide k6 with a way to get secrets and help it handle them correctly. Predominantly by redacting them from logs.

Index

• Constants
• func RegisterExtension(name string, c Constructor)
• type Constructor
• type Manager
  • func NewManager(sources map[string]Source) (*Manager, logrus.Hook, error)
  • func (sm *Manager) Get(sourceName, key string) (string, error)
• type Params
• type Source
• type UnknownSourceError
  • func (u UnknownSourceError) Error() string

Constants

const DefaultSourceName = "default"

DefaultSourceName is the name for the default secret source

Functions

func RegisterExtension

func RegisterExtension(name string, c Constructor)

RegisterExtension registers the given secret source extension constructor. This function panics if a module with the same name is already registered.

Types

type Constructor

type Constructor func(Params) (Source, error)

Constructor returns an instance of a secret source extension module. This should return an instance of Source given the parameters. The Secret Source should not log its secrets and any returned secret will be cached and redacted by the Manager. No additional work needs to be done by the Secret source apart from retrieving the secret.

type Manager

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

Manager manages secrets making certain for them to be redacted from logs

func NewManager

func NewManager(sources map[string]Source) (*Manager, logrus.Hook, error)

NewManager returns a new NewManager with the provided secretsHook and will redact secrets from the hook

func (*Manager) Get

func (sm *Manager) Get(sourceName, key string) (string, error)

Get is the way to get a secret for the provided source name and key of the secret. It can be used with the DefaultSourceName. This automatically starts redacting the secret before returning it.

type Params

type Params struct {
	ConfigArgument string // the string on the cli

	Logger      logrus.FieldLogger
	Environment map[string]string
	FS          fsext.Fs
	Usage       *usage.Usage
}

Params contains all possible constructor parameters an output may need.

type Source

type Source interface {
	// Human readable description to be printed on the cli
	Description() string
	// Get retrives the value for a given key and returns it.
	// Logging the value before it is returned is going to lead to it being leaked.
	// The error might lead to an exception visible to users.
	Get(key string) (value string, err error)
}

Source is the interface a secret source needs to implement

type UnknownSourceError

type UnknownSourceError string

UnknownSourceError is returned when a unknown source is requested

func (UnknownSourceError) Error

func (u UnknownSourceError) Error() string