core

Documentation

Index

• type DriftedEntriesBySource
  • func (a DriftedEntriesBySource) Len() int
  • func (a DriftedEntriesBySource) Less(i, j int) bool
  • func (a DriftedEntriesBySource) Swap(i, j int)
• type DriftedEntry
• type EntriesByKey
  • func (a EntriesByKey) Len() int
  • func (a EntriesByKey) Less(i, j int) bool
  • func (a EntriesByKey) Swap(i, j int)
• type EntriesByProvider
  • func (a EntriesByProvider) Len() int
  • func (a EntriesByProvider) Less(i, j int) bool
  • func (a EntriesByProvider) Swap(i, j int)
• type EntriesByValueSize
  • func (a EntriesByValueSize) Len() int
  • func (a EntriesByValueSize) Less(i, j int) bool
  • func (a EntriesByValueSize) Swap(i, j int)
• type EnvEntry
  • func (ee *EnvEntry) AddressingKeyPath() *KeyPath
• type EnvEntryLookup
  • func (ee *EnvEntryLookup) EnvBy(key, provider, path, dflt string) string
  • func (ee *EnvEntryLookup) EnvByKey(key, dflt string) string
  • func (ee *EnvEntryLookup) EnvByKeyAndProvider(key, provider, dflt string) string
• type KeyPath
  • func (k *KeyPath) EffectiveKey() string
  • func (k *KeyPath) EffectiveRemap() map[string]RemapKeyPath
  • func (k *KeyPath) Found(v string) EnvEntry
  • func (k *KeyPath) FoundWithKey(key, v string) EnvEntry
  • func (k *KeyPath) Missing() EnvEntry
  • func (k *KeyPath) SwitchPath(path string) KeyPath
  • func (k *KeyPath) WithEnv(env string) KeyPath
• type Match
• type MetaInfo
• type OpMatrix
• type Opts
• type Populate
  • func NewPopulate(opts Opts) *Populate
  • func (p *Populate) FindAndReplace(path string) string
  • func (p *Populate) KeyPath(kp KeyPath) KeyPath
• type Provider
• type RegisteredProvider
• type RemapKeyPath
• type Severity
• type WizardAnswers

Types

type DriftedEntriesBySource

type DriftedEntriesBySource []DriftedEntry

func (DriftedEntriesBySource) Len

func (a DriftedEntriesBySource) Len() int

func (DriftedEntriesBySource) Less

func (a DriftedEntriesBySource) Less(i, j int) bool

func (DriftedEntriesBySource) Swap

func (a DriftedEntriesBySource) Swap(i, j int)

type DriftedEntry

type DriftedEntry struct {
	Diff   string
	Source EnvEntry
	Target EnvEntry
}

type EntriesByKey

type EntriesByKey []EnvEntry

func (EntriesByKey) Len

func (a EntriesByKey) Len() int

func (EntriesByKey) Less

func (a EntriesByKey) Less(i, j int) bool

func (EntriesByKey) Swap

func (a EntriesByKey) Swap(i, j int)

type EntriesByProvider

type EntriesByProvider []EnvEntry

func (EntriesByProvider) Len

func (a EntriesByProvider) Len() int

func (EntriesByProvider) Less

func (a EntriesByProvider) Less(i, j int) bool

func (EntriesByProvider) Swap

func (a EntriesByProvider) Swap(i, j int)

type EntriesByValueSize

type EntriesByValueSize []EnvEntry

func (EntriesByValueSize) Len

func (a EntriesByValueSize) Len() int

func (EntriesByValueSize) Less

func (a EntriesByValueSize) Less(i, j int) bool

func (EntriesByValueSize) Swap

func (a EntriesByValueSize) Swap(i, j int)

type EnvEntry

type EnvEntry struct {
	Key          string
	Field        string
	Value        string
	ProviderName string
	ResolvedPath string
	Severity     Severity
	RedactWith   string
	Source       string
	Sink         string
	IsFound      bool
}

func (*EnvEntry) AddressingKeyPath

func (ee *EnvEntry) AddressingKeyPath() *KeyPath

type EnvEntryLookup

type EnvEntryLookup struct {
	Entries []EnvEntry
}

func (*EnvEntryLookup) EnvBy

func (ee *EnvEntryLookup) EnvBy(key, provider, path, dflt string) string

func (*EnvEntryLookup) EnvByKey

func (ee *EnvEntryLookup) EnvByKey(key, dflt string) string

func (*EnvEntryLookup) EnvByKeyAndProvider

func (ee *EnvEntryLookup) EnvByKeyAndProvider(key, provider, dflt string) string

type KeyPath

type KeyPath struct {
	Env        string                   `yaml:"env,omitempty"`
	Path       string                   `yaml:"path"`
	Field      string                   `yaml:"field,omitempty"`
	Remap      *map[string]string       `yaml:"remap,omitempty"`
	RemapWith  *map[string]RemapKeyPath `yaml:"remap_with,omitempty"`
	Decrypt    bool                     `yaml:"decrypt,omitempty"`
	Optional   bool                     `yaml:"optional,omitempty"`
	Plaintext  bool                     `yaml:"plaintext,omitempty"`
	Severity   Severity                 `yaml:"severity,omitempty" default:"high"`
	RedactWith string                   `yaml:"redact_with,omitempty" default:"**REDACTED**"`
	Source     string                   `yaml:"source,omitempty"`
	Sink       string                   `yaml:"sink,omitempty"`
}

func (*KeyPath) EffectiveKey

func (k *KeyPath) EffectiveKey() string

func (*KeyPath) EffectiveRemap

func (k *KeyPath) EffectiveRemap() map[string]RemapKeyPath

func (*KeyPath) Found

func (k *KeyPath) Found(v string) EnvEntry

func (*KeyPath) FoundWithKey

func (k *KeyPath) FoundWithKey(key, v string) EnvEntry

NOTE: consider doing what 'updateParams' does in these builders

func (*KeyPath) Missing

func (k *KeyPath) Missing() EnvEntry

func (*KeyPath) SwitchPath

func (k *KeyPath) SwitchPath(path string) KeyPath

func (*KeyPath) WithEnv

func (k *KeyPath) WithEnv(env string) KeyPath

type Match

type Match struct {
	Path       string
	Line       string
	LineNumber int
	MatchIndex int
	Entry      EnvEntry
}

type MetaInfo

type MetaInfo struct {
	Description    string
	Name           string
	Authentication string
	ConfigTemplate string
	Ops            OpMatrix
}

type OpMatrix

type OpMatrix struct {
	Delete        bool
	DeleteMapping bool
	Put           bool
	PutMapping    bool
	Get           bool
	GetMapping    bool
}

type Opts

type Opts map[string]string

type Populate

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

func NewPopulate

func NewPopulate(opts Opts) *Populate

func (*Populate) FindAndReplace

func (p *Populate) FindAndReplace(path string) string

func (*Populate) KeyPath

func (p *Populate) KeyPath(kp KeyPath) KeyPath

type Provider

type Provider interface {
	// in this case 'env' is empty, but EnvEntries are the value
	GetMapping(p KeyPath) ([]EnvEntry, error)

	// in this case env is filled
	Get(p KeyPath) (*EnvEntry, error)

	Put(p KeyPath, val string) error
	PutMapping(p KeyPath, m map[string]string) error

	Delete(p KeyPath) error
	DeleteMapping(p KeyPath) error
}

type RegisteredProvider

type RegisteredProvider struct {
	Meta    MetaInfo
	Builder func(logger logging.Logger) (Provider, error)
}

type RemapKeyPath

type RemapKeyPath struct {
	Field      string   `yaml:"field,omitempty"`
	Severity   Severity `yaml:"severity,omitempty"`
	RedactWith string   `yaml:"redact_with,omitempty"`
}

type Severity

type Severity string

const (
	High   Severity = "high"
	Medium Severity = "medium"
	Low    Severity = "low"
	None   Severity = "none"

	// PlainTextKey the key used for plaintext secrets
	PlainTextKey = "plaintext"
)

type WizardAnswers

type WizardAnswers struct {
	Project      string
	Providers    []string
	ProviderKeys map[string]bool
	Confirm      bool
}