README
¶
Secret Stores
Secret Stores provide a common way to interact with different secret stores, cloud/edge/commercial or open-source.
Implementing a new Secret Store
A compliant secret store needs to implement the SecretStore interface included in the secret_store.go file.
Documentation
¶
Index ¶
Constants ¶
const DefaultSecretRefKeyName = "_value"
DefaultSecretRefKeyName is the default key if secretKeyRef.key is not given.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type BulkGetSecretRequest ¶
BulkGetSecretRequest describes a bulk get secret request from a secret store.
type BulkGetSecretResponse ¶
BulkGetSecretResponse describes the response object for all the secrets returned from a secret store.
type Feature ¶
type Feature string
Feature names a feature that can be implemented by Secret Store components.
const ( // FeatureMultipleKeyValuesPerSecret advertises that this SecretStore supports multiple keys-values under a single secret. FeatureMultipleKeyValuesPerSecret Feature = "MULTIPLE_KEY_VALUES_PER_SECRET" )
type GetSecretRequest ¶
type GetSecretRequest struct {
Name string `json:"name"`
Metadata map[string]string `json:"metadata"`
}
GetSecretRequest describes a get secret request from a secret store.
type GetSecretResponse ¶
GetSecretResponse describes the response object for a secret returned from a secret store.
type SecretStore ¶
type SecretStore interface {
// Init authenticates with the actual secret store and performs other init operation
Init(ctx context.Context, metadata Metadata) error
// GetSecret retrieves a secret using a key and returns a map of decrypted string/string values.
GetSecret(ctx context.Context, req GetSecretRequest) (GetSecretResponse, error)
// BulkGetSecret retrieves all secrets in the store and returns a map of decrypted string/string values.
BulkGetSecret(ctx context.Context, req BulkGetSecretRequest) (BulkGetSecretResponse, error)
// Features lists the features supported by the secret store.
Features() []Feature
// GetComponentMetadata returns the metadata options for the secret store.
GetComponentMetadata() map[string]string
}
SecretStore is the interface for a component that handles secrets management.
Source Files
Directories