mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-09 16:17:01 +02:00
39bcd5c715
* use automtls for v5 secrets/auth plugins * add automtls env guard * start backend without metadata mode * use PluginClientConfig for backend's NewPluginClient param refactor * - fix pluginutil test - do not expect plugin to be unloaded in UT - fix pluginutil tests --need new env var - use require in UT - fix lazy load test * add changelog * prioritize automtls; improve comments * user multierror; refactor pluginSet for v4 unit test * add test cases for v4 and v5 plugin versions * remove unnecessary call to AutoMTLSSupported * update comment on pluginSets * use runconfig directly in sdk newpluginclient * use automtls without metadatamode for v5 backend plugin registration * use multierror for plugin runconfig calls * remove some unnecessary code
96 lines
3.5 KiB
Go
96 lines
3.5 KiB
Go
package pluginutil
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
log "github.com/hashicorp/go-hclog"
|
|
plugin "github.com/hashicorp/go-plugin"
|
|
"github.com/hashicorp/vault/sdk/helper/consts"
|
|
"github.com/hashicorp/vault/sdk/helper/wrapping"
|
|
"google.golang.org/grpc"
|
|
)
|
|
|
|
// Looker defines the plugin Lookup function that looks into the plugin catalog
|
|
// for available plugins and returns a PluginRunner
|
|
type Looker interface {
|
|
LookupPlugin(context.Context, string, consts.PluginType) (*PluginRunner, error)
|
|
}
|
|
|
|
// RunnerUtil 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 response wrapped token.
|
|
// logical.SystemView implementations satisfy this interface.
|
|
type RunnerUtil interface {
|
|
NewPluginClient(ctx context.Context, config PluginClientConfig) (PluginClient, error)
|
|
ResponseWrapData(ctx context.Context, data map[string]interface{}, ttl time.Duration, jwt bool) (*wrapping.ResponseWrapInfo, error)
|
|
MlockEnabled() bool
|
|
}
|
|
|
|
// LookRunnerUtil defines the functions for both Looker and Wrapper
|
|
type LookRunnerUtil interface {
|
|
Looker
|
|
RunnerUtil
|
|
}
|
|
|
|
type PluginClient interface {
|
|
Conn() grpc.ClientConnInterface
|
|
plugin.ClientProtocol
|
|
}
|
|
|
|
// PluginRunner defines the metadata needed to run a plugin securely with
|
|
// go-plugin.
|
|
type PluginRunner struct {
|
|
Name string `json:"name" structs:"name"`
|
|
Type consts.PluginType `json:"type" structs:"type"`
|
|
Command string `json:"command" structs:"command"`
|
|
Args []string `json:"args" structs:"args"`
|
|
Env []string `json:"env" structs:"env"`
|
|
Sha256 []byte `json:"sha256" structs:"sha256"`
|
|
Builtin bool `json:"builtin" structs:"builtin"`
|
|
BuiltinFactory func() (interface{}, error) `json:"-" structs:"-"`
|
|
}
|
|
|
|
// Run takes a wrapper RunnerUtil instance along with the go-plugin parameters and
|
|
// returns a configured plugin.Client with TLS Configured and a wrapping token set
|
|
// on PluginUnwrapTokenEnv for plugin process consumption.
|
|
func (r *PluginRunner) Run(ctx context.Context, wrapper RunnerUtil, pluginSets map[int]plugin.PluginSet, hs plugin.HandshakeConfig, env []string, logger log.Logger) (*plugin.Client, error) {
|
|
return r.RunConfig(ctx,
|
|
Runner(wrapper),
|
|
PluginSets(pluginSets),
|
|
HandshakeConfig(hs),
|
|
Env(env...),
|
|
Logger(logger),
|
|
MetadataMode(false),
|
|
)
|
|
}
|
|
|
|
// RunMetadataMode returns a configured plugin.Client that will dispense a plugin
|
|
// in metadata mode. The PluginMetadataModeEnv is passed in as part of the Cmd to
|
|
// plugin.Client, and consumed by the plugin process on api.VaultPluginTLSProvider.
|
|
func (r *PluginRunner) RunMetadataMode(ctx context.Context, wrapper RunnerUtil, pluginSets map[int]plugin.PluginSet, hs plugin.HandshakeConfig, env []string, logger log.Logger) (*plugin.Client, error) {
|
|
return r.RunConfig(ctx,
|
|
Runner(wrapper),
|
|
PluginSets(pluginSets),
|
|
HandshakeConfig(hs),
|
|
Env(env...),
|
|
Logger(logger),
|
|
MetadataMode(true),
|
|
)
|
|
}
|
|
|
|
// CtxCancelIfCanceled takes a context cancel func and a context. If the context is
|
|
// shutdown the cancelfunc is called. This is useful for merging two cancel
|
|
// functions.
|
|
func CtxCancelIfCanceled(f context.CancelFunc, ctxCanceler context.Context) chan struct{} {
|
|
quitCh := make(chan struct{})
|
|
go func() {
|
|
select {
|
|
case <-quitCh:
|
|
case <-ctxCanceler.Done():
|
|
f()
|
|
}
|
|
}()
|
|
return quitCh
|
|
}
|