vault

package

v1.3.2 Latest Latest Go to latest Published: Jan 20, 2022 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func GetLoginAuthTTY() (*types.VaultAuth, error)

func TryAuth(host string, vaultAuth *types.VaultAuth) error

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

FetchedVaultSecret is an implementation of types.FetchedSecret specifically for a secret fetched from Vault

func (fetched *FetchedVaultSecret) Format() int

Format returns the configured format for this secret

func (fetched *FetchedVaultSecret) IsMissingData() bool

IsMissingData returns true if the remote secret existed but was incomplete

func (fetched *FetchedVaultSecret) UploadNew(value interface{}) (interface{}, error)

UploadNew modifies the remote secret and replaces the value or sub-value with a new given value, and returns the new secret version

func (fetched *FetchedVaultSecret) Value() interface{}

Value returns the fetched secret value or sub-value

func (fetched *FetchedVaultSecret) Version() interface{}

Version returns the fetched secret's version

type FromDataMapping struct {
	Format string         `yaml:"format"`
	Path   *[]interface{} `yaml:"path,omitempty"`
}

FromDataMapping contains the settings for mapping a subset of the data of a Vault key/value secret document to file contents

type FromTextMapping struct {
	Path []interface{} `yaml:"path"`
}

FromTextMapping contains the settings for mapping a string value in the data of a Vault key/value secret document to file contents

type Mapping struct {
	FromData *FromDataMapping `yaml:"fromData,omitempty"`
	FromText *FromTextMapping `yaml:"fromText,omitempty"`
}

Mapping represents a data or text mapping of a Vault key/value secret document to file contents

type SecretConfig struct {
	URL     string  `yaml:"url"`
	Mapping Mapping `yaml:"mapping"`
}

SecretConfig contains the Vault-specific configuration parameters for a secret in secrets.yaml

func (secretConfig *SecretConfig) Fetch() (types.FetchedSecret, error)

Fetch downloads this secret and returns an instance of FetchedVaultSecret

func (secretConfig *SecretConfig) Prepare() error

Prepare ensures that the Vault engine has all the required authentication parameters to fetch this secret