secrets

Documentation

Index

• Constants
• func IsEnc(str string) bool
• func Retriable(err error) bool
• func SetSecretBackendArgs(args []string)
• func SetSecretBackendCommand(command string)
• type Decryptor
• type DecryptorError
  • func NewDecryptorError(err error, retriable bool) *DecryptorError
  • func (e *DecryptorError) Error() string
  • func (e *DecryptorError) IsRetriable() bool
  • func (e *DecryptorError) Unwrap() error
• type DummyDecryptor
  • func NewDummyDecryptor(maxRetries int) *DummyDecryptor
  • func (d *DummyDecryptor) Decrypt(secrets []string) (map[string]string, error)
• type Secret
• type SecretBackend
  • func NewSecretBackend() *SecretBackend
  • func (sb *SecretBackend) Decrypt(encrypted []string) (map[string]string, error)

Constants

const (

	// PayloadVersion represents the version of the SB API
	PayloadVersion = "1.0"
)

Functions

func IsEnc

func IsEnc(str string) bool

IsEnc returns true if a string respects the ENC[<handle>] format

func Retriable

func Retriable(err error) bool

Retriable can be used to evaluate whether an error should be retried

func SetSecretBackendArgs

func SetSecretBackendArgs(args []string)

SetSecretBackendArgs set the secretBackendArgs var

func SetSecretBackendCommand

func SetSecretBackendCommand(command string)

SetSecretBackendCommand set the secretBackendCommand var

Types

type Decryptor

type Decryptor interface {
	Decrypt([]string) (map[string]string, error)
}

Decryptor is used to decrypt encrypted secrets Decryptor is implemented by SecretBackend

type DecryptorError

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

DecryptorError describes the error returned by a Decryptor

func NewDecryptorError

func NewDecryptorError(err error, retriable bool) *DecryptorError

NewDecryptorError returns a new DecryptorError

func (*DecryptorError) Error

func (e *DecryptorError) Error() string

Error implements the Error interface

func (*DecryptorError) IsRetriable

func (e *DecryptorError) IsRetriable() bool

IsRetriable returns wether the error is retriable

func (*DecryptorError) Unwrap

func (e *DecryptorError) Unwrap() error

Unwrap implements the Error interface

type DummyDecryptor

type DummyDecryptor struct {
	mock.Mock
	// contains filtered or unexported fields
}

DummyDecryptor can be used in other packages to mock the secret backend

func NewDummyDecryptor

func NewDummyDecryptor(maxRetries int) *DummyDecryptor

NewDummyDecryptor returns a dummy decryptor for tests maxRetries is the number of retries before returning a nil error If maxRetries < 0 Decrypt directly returns a permanent error If maxRetries == 0 Decrypt directly returns a a nil error If maxRetries > 0 Decrypt returns a retriable error until it's called maxRetries-times then returns a nil error

func (*DummyDecryptor) Decrypt

func (d *DummyDecryptor) Decrypt(secrets []string) (map[string]string, error)

Decrypt is used for testing

type Secret

type Secret struct {
	Value    string `json:"value,omitempty"`
	ErrorMsg string `json:"error,omitempty"`
}

Secret defines the structure for secrets in JSON output

type SecretBackend

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

SecretBackend retrieves secrets from secret backend binary SecretBackend implements the Decryptor interface

func NewSecretBackend

func NewSecretBackend() *SecretBackend

NewSecretBackend returns a new SecretBackend instance

func (*SecretBackend) Decrypt

func (sb *SecretBackend) Decrypt(encrypted []string) (map[string]string, error)

Decrypt tries to decrypt a given string slice using the secret backend command