README
¶
github.com/cyberark/summon/provider
Functions to resolve and call a Summon provider.
func Resolve(providerArg string) (string, error)
Searches for a provider in this order:
providerArg, passed in via CLI- environment variable
SUMMON_PROVIDER - check for directory
/usr/local/lib/summon(or%ProgramW6432%\Cyberark Conjur\Summon\Providerson Windows): if it exist, search providers there - if all of the above do not exist: use
<path_to_summon_excutable>\Providersfor searching providers (aka 'portable mode')
Attention: the provider search is limited to the first directory found according to the priority list above. That means, if the system directory exist the local directory will never be searched, even if the system directory is empty.
In order to migrate from system directory configuration to a local provider directory you need to move all providers to the local provider dir AND delete the system directory.
func Call(provider, specPath string) (string, error)
Given a provider and secret's namespace, runs the provider to resolve the secret's value.
func CallInteractiveMode(provider string, secrets secretsyml.SecretsMap) (chan Result, chan error, func())
Given a provider and secrets, runs the provider in interactive mode to resolve multiple secret's values in a single process.
Documentation
¶
Index ¶
- Variables
- func Call(provider, specPath string) (string, error)
- func CallInteractiveMode(provider string, secrets secretsyml.SecretsMap) (chan Result, chan error, func())
- func GetAllProviders(providerDir string) ([]string, error)
- func GetDefaultPath() (string, error)
- func Resolve(providerArg string) (string, error)
- type Result
Constants ¶
This section is empty.
Variables ¶
var ErrInteractiveModeNotSupported = errors.New("interactive mode not supported")
ErrInteractiveModeNotSupported is returned when a provider does not support interactive mode
Functions ¶
func Call ¶
Call shells out to a provider and return its output If call succeeds, stdout is returned with no error If call fails, "" is return with error containing stderr
func CallInteractiveMode ¶
func CallInteractiveMode(provider string, secrets secretsyml.SecretsMap) (chan Result, chan error, func())
CallInteractiveMode calls a provider without passing any arguments. It then constantly fetches secrets from its stdout. It returns a channel of results, a channel of errors and a cleanup function.
func GetAllProviders ¶
GetAllProviders creates slice of all file names in the default path
func GetDefaultPath ¶
Types ¶
type Result ¶
type Result struct {
Key string // The secret's identifier (environment variable name or alias).
Value string // The resolved secret content returned by the provider.
Error error // Non-nil when the provider failed to fetch this secret.
}
Result is the outcome of fetching a single secret from the provider. It pairs the resolved Value with the Key used to request it, plus an Error for failed fetches. The Error field is needed here (but absent from filetemplates.Secret) because callers inspect it for retry and ignore logic before secrets reach the template-rendering stage.
Source Files