secrets

README

Secrets Manager

Provides a generic interface to obtain secrets from different sources.

Sources

Following sources are available:

• Static managed secrets, e.g. for testing
• Secrets read from environment variables
• Secrets read from mounted secret files in Docker or K8s

Documentation

Overview

Package secrets provides a generic interface to obtain secrets from different sources.

Index

• Constants
• func ExportToEnvironment(keys []string, manager SecretsManager)
• type Base64DecodeError
  • func (e *Base64DecodeError) Error() string
• type DockerSecretsManager
  • func (s *DockerSecretsManager) Obtain(key string) (*string, error)
• type EnvironmentSecretsManager
  • func (s *EnvironmentSecretsManager) Obtain(key string) (*string, error)
• type FileSecretsManager
  • func (s *FileSecretsManager) Obtain(key string) (*string, error)
• type SecretNotFoundError
  • func (e *SecretNotFoundError) Error() string
• type SecretsManager
  • func NewDockerecretsManager(secretsPath string) SecretsManager
  • func NewFileSecretsManager(fileName string) SecretsManager
  • func NewSecretsManager() SecretsManager
  • func NewSecretsManagerByConfig(conf config.Config) SecretsManager
  • func NewStaticSecretsManager(secrets map[string]string) SecretsManager
• type StaticSecretsManager
  • func (s *StaticSecretsManager) Obtain(key string) (*string, error)

Constants

const DEFAULT_SECRETS_FILE = "~/.credentials"

DEFAULT_SECRETS_FILE defines default path to a credentials file.

const DOCKER_SECRETS_PATH = "/run/secrets"

DOCKER_SECRETS_PATH defined the default path to look for mounted secrets in Docker or K8s.

Functions

func ExportToEnvironment

func ExportToEnvironment(keys []string, manager SecretsManager)

ExportToEnvironment will export secrets identified by given keys to environment variables.

Types

type Base64DecodeError

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

func (*Base64DecodeError) Error

func (e *Base64DecodeError) Error() string

type DockerSecretsManager

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

DockerSecretsManager will read secrets from files mounted by Docker or K8s.

func (*DockerSecretsManager) Obtain

func (s *DockerSecretsManager) Obtain(key string) (*string, error)

Obtain will try to read secrets from mountes secrets files.

type EnvironmentSecretsManager

type EnvironmentSecretsManager struct {
}

EnvironmentSecretsManager will read secrets from environment variables.

func (*EnvironmentSecretsManager) Obtain

func (s *EnvironmentSecretsManager) Obtain(key string) (*string, error)

Obtain will try to read a secrets from environment variable defined by passed key.

type FileSecretsManager

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

FileSecretsManager reads secrets from defined file. Secrets have to be added as key:value pair in this credentials file.

func (*FileSecretsManager) Obtain

func (s *FileSecretsManager) Obtain(key string) (*string, error)

Obtain will try to read secret from defined credentials file. Expects secrets as a key:value pair, separatir is ":", where secrets value is base64 encoded.

type SecretNotFoundError

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

func (*SecretNotFoundError) Error

func (e *SecretNotFoundError) Error() string

type SecretsManager

type SecretsManager interface {

	// Obtain will try to read a secret for given key.
	Obtain(key string) (*string, error)
}

SecretsManager is a generic interface to read secrets from different sources.

func NewDockerecretsManager

func NewDockerecretsManager(secretsPath string) SecretsManager

NewDockerecretsManager returns a new secrets manager for Docker or K8s.

func NewFileSecretsManager

func NewFileSecretsManager(fileName string) SecretsManager

NewFileSecretsManager returns a new secretsmanager for given file.

func NewSecretsManager

func NewSecretsManager() SecretsManager

NewSecretsManager returns a new default secrets mananger, which will read secrets from environment variables.

func NewSecretsManagerByConfig

func NewSecretsManagerByConfig(conf config.Config) SecretsManager

NewSecretsManagerByConfig will create a new secrets manager by given config. If there's no config values for secrets, a default secrets manager will be returned.

func NewStaticSecretsManager

func NewStaticSecretsManager(secrets map[string]string) SecretsManager

NewStaticSecretsManager returns a secrets manager which contains passed secrets. Useful e.g. for testing.

type StaticSecretsManager

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

StaticSecretsManager will manage secrets by internal map.

func (*StaticSecretsManager) Obtain

func (s *StaticSecretsManager) Obtain(key string) (*string, error)

Obtain will try to get a secrets from internal map by given key.