mirrors/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2025-11-22 11:11:26 +01:00
Code Issues Projects Releases Wiki Activity

Add comments to the plugin runner

Browse Source
This commit is contained in:
Brian Kassouf 2017-04-12 17:35:53 -07:00
parent 4c75326aad
commit 33d66f3a67
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
helper/pluginutil/runner.go
View File

@ -17,20 +17,28 @@ var (
PluginMlockEnabled = "VAULT_PLUGIN_MLOCK_ENABLED" PluginMlockEnabled = "VAULT_PLUGIN_MLOCK_ENABLED"
) )
// Looker defines the plugin Lookup function that looks into the plugin catalog
// for availible plugins and returns a PluginRunner
type Looker interface { type Looker interface {
LookupPlugin(string) (*PluginRunner, error) LookupPlugin(string) (*PluginRunner, error)
} }
// Wrapper interface defines the functions needed by the runner to wrap the
// metadata needed to run a plugin process. This includes looking up Mlock
// configuration and wrapping data in a respose wrapped token.
type Wrapper interface { type Wrapper interface {
ResponseWrapData(data map[string]interface{}, ttl time.Duration, jwt bool) (string, error) ResponseWrapData(data map[string]interface{}, ttl time.Duration, jwt bool) (string, error)
MlockDisabled() bool MlockDisabled() bool
} }
// LookWrapper defines the functions for both Looker and Wrapper
type LookWrapper interface { type LookWrapper interface {
Looker Looker
Wrapper Wrapper
} }
// PluginRunner defines the metadata needed to run a plugin securely with
// go-plugin.
type PluginRunner struct { type PluginRunner struct {
Name string `json:"name"` Name string `json:"name"`
Command string `json:"command"` Command string `json:"command"`
@ -39,6 +47,8 @@ type PluginRunner struct {
Builtin bool `json:"builtin"` Builtin bool `json:"builtin"`
} }
// Run takes a wrapper instance, and the go-plugin paramaters and executes a
// plugin.
func (r *PluginRunner) Run(wrapper Wrapper, pluginMap map[string]plugin.Plugin, hs plugin.HandshakeConfig, env []string) (*plugin.Client, error) { func (r *PluginRunner) Run(wrapper Wrapper, pluginMap map[string]plugin.Plugin, hs plugin.HandshakeConfig, env []string) (*plugin.Client, error) {
// Get a CA TLS Certificate // Get a CA TLS Certificate
CACertBytes, CACert, CAKey, err := GenerateCACert() CACertBytes, CACert, CAKey, err := GenerateCACert()
@ -87,6 +97,8 @@ func (r *PluginRunner) Run(wrapper Wrapper, pluginMap map[string]plugin.Plugin,
return client, nil return client, nil
} }
// OptionallyEnableMlock determines if mlock should be called, and if so enables
// mlock.
func OptionallyEnableMlock() error { func OptionallyEnableMlock() error {
if os.Getenv(PluginMlockEnabled) == "true" { if os.Getenv(PluginMlockEnabled) == "true" {
return mlock.LockMemory() return mlock.LockMemory()