mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-16 19:47:02 +02:00
70278c2787
Add plugin version to GRPC interface Added a version interface in the sdk/logical so that it can be shared between all plugin types, and then wired it up to RunningVersion in the mounts, auth list, and database systems. I've tested that this works with auth, database, and secrets plugin types, with the following logic to populate RunningVersion: If a plugin has a PluginVersion() method implemented, then that is used If not, and the plugin is built into the Vault binary, then the go.mod version is used Otherwise, the it will be the empty string. My apologies for the length of this PR. * Placeholder backend should be external We use a placeholder backend (previously a framework.Backend) before a GRPC plugin is lazy-loaded. This makes us later think the plugin is a builtin plugin. So we added a `placeholderBackend` type that overrides the `IsExternal()` method so that later we know that the plugin is external, and don't give it a default builtin version.
80 lines
2.0 KiB
Go
80 lines
2.0 KiB
Go
package dbplugin
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
|
|
"github.com/hashicorp/go-plugin"
|
|
"github.com/hashicorp/vault/sdk/database/dbplugin/v5/proto"
|
|
"github.com/hashicorp/vault/sdk/helper/pluginutil"
|
|
"github.com/hashicorp/vault/sdk/logical"
|
|
)
|
|
|
|
var _ logical.PluginVersioner = (*DatabasePluginClient)(nil)
|
|
|
|
type DatabasePluginClient struct {
|
|
client pluginutil.PluginClient
|
|
Database
|
|
}
|
|
|
|
func (dc *DatabasePluginClient) PluginVersion() logical.PluginVersion {
|
|
if versioner, ok := dc.Database.(logical.PluginVersioner); ok {
|
|
return versioner.PluginVersion()
|
|
}
|
|
return logical.EmptyPluginVersion
|
|
}
|
|
|
|
// This wraps the Close call and ensures we both close the database connection
|
|
// and kill the plugin.
|
|
func (dc *DatabasePluginClient) Close() error {
|
|
err := dc.Database.Close()
|
|
dc.client.Close()
|
|
|
|
return err
|
|
}
|
|
|
|
// pluginSets is the map of plugins we can dispense.
|
|
var PluginSets = map[int]plugin.PluginSet{
|
|
5: {
|
|
"database": &GRPCDatabasePlugin{},
|
|
},
|
|
6: {
|
|
"database": &GRPCDatabasePlugin{},
|
|
},
|
|
}
|
|
|
|
// NewPluginClient returns a databaseRPCClient with a connection to a running
|
|
// plugin.
|
|
func NewPluginClient(ctx context.Context, sys pluginutil.RunnerUtil, config pluginutil.PluginClientConfig) (Database, error) {
|
|
pluginClient, err := sys.NewPluginClient(ctx, config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Request the plugin
|
|
raw, err := pluginClient.Dispense("database")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// We should have a database type now. This feels like a normal interface
|
|
// implementation but is in fact over an RPC connection.
|
|
var db Database
|
|
switch c := raw.(type) {
|
|
case gRPCClient:
|
|
// This is an abstraction leak from go-plugin but it is necessary in
|
|
// order to enable multiplexing on multiplexed plugins
|
|
c.client = proto.NewDatabaseClient(pluginClient.Conn())
|
|
c.versionClient = logical.NewPluginVersionClient(pluginClient.Conn())
|
|
|
|
db = c
|
|
default:
|
|
return nil, errors.New("unsupported client type")
|
|
}
|
|
|
|
return &DatabasePluginClient{
|
|
client: pluginClient,
|
|
Database: db,
|
|
}, nil
|
|
}
|