vault

package

v1.1.0 Latest Latest Go to latest Published: Aug 15, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/flowexec/flow

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CacheDirectory(subPath string) string
func ConfigFilePath(vaultName string) string
func NewAES256Vault(name, storagePath, keyEnv, keyFile, logLevel string)
func NewAgeVault(name, storagePath, recipients, identityKey, identityFile string)
func NewExternalVault(providerConfigFile string)
func NewKeyringVault(name string)
func NewUnencryptedVault(name, storagePath string)
func RefToParts(ref SecretRef) (vaultName, key string, err error)
func ValidateIdentifier(reference string) error
func VaultFromName(name string) (*VaultConfig, Vault, error)
type Secret
- func NewSecret(vaultName, key string, value vault.Secret) (Secret, error)
type SecretList
- func NewSecretList(vaultName string, v Vault) (SecretList, error)
- func (l SecretList) AsObfuscatedText() SecretList
- func (l SecretList) AsPlaintext() SecretList
- func (l SecretList) FindByName(name string) Secret
- func (l SecretList) Items() []*types.EntityInfo
- func (l SecretList) JSON() (string, error)
- func (l SecretList) JSONWithMode(plaintext bool) (string, error)
- func (l SecretList) Plural() string
- func (l SecretList) Singular() string
- func (l SecretList) YAML() (string, error)
- func (l SecretList) YAMLWithMode(plaintext bool) (string, error)
type SecretRef
- func (r SecretRef) Key() string
- func (r SecretRef) Vault() string
type SecretValue
- func NewSecretValue(value []byte) *SecretValue
type Vault
type VaultConfig

Constants ¶

View Source

const (
	DefaultVaultKeyEnv      = "FLOW_VAULT_KEY"
	DefaultVaultIdentityEnv = "FLOW_VAULT_IDENTITY"
)

View Source

const DemoVaultReservedName = "demo"

Variables ¶

This section is empty.

Functions ¶

func CacheDirectory ¶ added in v1.1.0

func CacheDirectory(subPath string) string

func ConfigFilePath ¶ added in v1.1.0

func ConfigFilePath(vaultName string) string

func NewAES256Vault ¶ added in v1.1.0

func NewAES256Vault(name, storagePath, keyEnv, keyFile, logLevel string)

func NewAgeVault ¶ added in v1.1.0

func NewAgeVault(name, storagePath, recipients, identityKey, identityFile string)

func NewExternalVault ¶ added in v1.1.0

func NewExternalVault(providerConfigFile string)

func NewKeyringVault ¶ added in v1.1.0

func NewKeyringVault(name string)

func NewUnencryptedVault ¶ added in v1.1.0

func NewUnencryptedVault(name, storagePath string)

func RefToParts ¶ added in v1.1.0

func RefToParts(ref SecretRef) (vaultName, key string, err error)

func ValidateIdentifier ¶ added in v1.1.0

func ValidateIdentifier(reference string) error

func VaultFromName ¶ added in v1.1.0

func VaultFromName(name string) (*VaultConfig, Vault, error)

Types ¶

type Secret ¶

type Secret interface {
	vault.Secret
	types.Entity

	Ref() SecretRef
	AsPlaintext() Secret
	AsObfuscatedText() Secret
}

func NewSecret ¶

func NewSecret(vaultName, key string, value vault.Secret) (Secret, error)

type SecretList ¶

type SecretList []Secret

func NewSecretList ¶ added in v1.1.0

func NewSecretList(vaultName string, v Vault) (SecretList, error)

func (SecretList) AsObfuscatedText ¶ added in v1.1.0

func (l SecretList) AsObfuscatedText() SecretList

func (SecretList) AsPlaintext ¶ added in v1.1.0

func (l SecretList) AsPlaintext() SecretList

func (SecretList) FindByName ¶

func (l SecretList) FindByName(name string) Secret

func (SecretList) Items ¶

func (l SecretList) Items() []*types.EntityInfo

func (SecretList) JSON ¶

func (l SecretList) JSON() (string, error)

func (SecretList) JSONWithMode ¶ added in v1.1.0

func (l SecretList) JSONWithMode(plaintext bool) (string, error)

JSONWithMode allows explicit control over plaintext vs obfuscated serialization

func (SecretList) Plural ¶

func (l SecretList) Plural() string

func (SecretList) Singular ¶

func (l SecretList) Singular() string

func (SecretList) YAML ¶

func (l SecretList) YAML() (string, error)

func (SecretList) YAMLWithMode ¶ added in v1.1.0

func (l SecretList) YAMLWithMode(plaintext bool) (string, error)

YAMLWithMode allows explicit control over plaintext vs obfuscated serialization

type SecretRef ¶ added in v1.1.0

type SecretRef string

func (SecretRef) Key ¶ added in v1.1.0

func (r SecretRef) Key() string

func (SecretRef) Vault ¶ added in v1.1.0

func (r SecretRef) Vault() string

type SecretValue ¶

type SecretValue = vault.SecretValue

func NewSecretValue ¶ added in v1.1.0

func NewSecretValue(value []byte) *SecretValue

type Vault ¶

type Vault = vault.Provider

type VaultConfig ¶ added in v1.1.0

type VaultConfig = vault.Config

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL