Add plugin file
This commit is contained in:
parent
9099231229
commit
748c70cfb4
242
builtin/logical/database/dbs/plugin.go
Normal file
242
builtin/logical/database/dbs/plugin.go
Normal file
|
@ -0,0 +1,242 @@
|
||||||
|
package dbs
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/rpc"
|
||||||
|
"os/exec"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/hashicorp/go-plugin"
|
||||||
|
)
|
||||||
|
|
||||||
|
// handshakeConfigs are used to just do a basic handshake between
|
||||||
|
// a plugin and host. If the handshake fails, a user friendly error is shown.
|
||||||
|
// This prevents users from executing bad plugins or executing a plugin
|
||||||
|
// directory. It is a UX feature, not a security feature.
|
||||||
|
var handshakeConfig = plugin.HandshakeConfig{
|
||||||
|
ProtocolVersion: 1,
|
||||||
|
MagicCookieKey: "BASIC_PLUGIN",
|
||||||
|
MagicCookieValue: "hello",
|
||||||
|
}
|
||||||
|
|
||||||
|
type DatabasePlugin struct {
|
||||||
|
impl DatabaseType
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d DatabasePlugin) Server(*plugin.MuxBroker) (interface{}, error) {
|
||||||
|
return &databasePluginRPCServer{impl: d.impl}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (DatabasePlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error) {
|
||||||
|
return &databasePluginRPCClient{client: c}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type DatabasePluginClient struct {
|
||||||
|
client *plugin.Client
|
||||||
|
sync.Mutex
|
||||||
|
|
||||||
|
*databasePluginRPCClient
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dc *DatabasePluginClient) Close() {
|
||||||
|
dc.databasePluginRPCClient.Close()
|
||||||
|
|
||||||
|
dc.client.Kill()
|
||||||
|
}
|
||||||
|
|
||||||
|
func newPluginClient(command string) (DatabaseType, error) {
|
||||||
|
// pluginMap is the map of plugins we can dispense.
|
||||||
|
var pluginMap = map[string]plugin.Plugin{
|
||||||
|
"database": new(DatabasePlugin),
|
||||||
|
}
|
||||||
|
|
||||||
|
client := plugin.NewClient(&plugin.ClientConfig{
|
||||||
|
HandshakeConfig: handshakeConfig,
|
||||||
|
Plugins: pluginMap,
|
||||||
|
Cmd: exec.Command(command),
|
||||||
|
})
|
||||||
|
|
||||||
|
// Connect via RPC
|
||||||
|
rpcClient, err := client.Client()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// Request the plugin
|
||||||
|
raw, err := rpcClient.Dispense("database")
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// We should have a Greeter now! This feels like a normal interface
|
||||||
|
// implementation but is in fact over an RPC connection.
|
||||||
|
databaseRPC := raw.(*databasePluginRPCClient)
|
||||||
|
|
||||||
|
return &DatabasePluginClient{
|
||||||
|
client: client,
|
||||||
|
databasePluginRPCClient: databaseRPC,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewPluginServer(db DatabaseType) {
|
||||||
|
dbPlugin := &DatabasePlugin{
|
||||||
|
impl: db,
|
||||||
|
}
|
||||||
|
|
||||||
|
// pluginMap is the map of plugins we can dispense.
|
||||||
|
var pluginMap = map[string]plugin.Plugin{
|
||||||
|
"database": dbPlugin,
|
||||||
|
}
|
||||||
|
|
||||||
|
plugin.Serve(&plugin.ServeConfig{
|
||||||
|
HandshakeConfig: handshakeConfig,
|
||||||
|
Plugins: pluginMap,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- RPC client domain ----
|
||||||
|
|
||||||
|
type databasePluginRPCClient struct {
|
||||||
|
client *rpc.Client
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) Type() string {
|
||||||
|
return "plugin"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) CreateUser(statements Statements, username, password, expiration string) error {
|
||||||
|
req := CreateUserRequest{
|
||||||
|
Statements: statements,
|
||||||
|
Username: username,
|
||||||
|
Password: password,
|
||||||
|
Expiration: expiration,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := dr.client.Call("Plugin.CreateUser", req, &struct{}{})
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) RenewUser(statements Statements, username, expiration string) error {
|
||||||
|
req := RenewUserRequest{
|
||||||
|
Statements: statements,
|
||||||
|
Username: username,
|
||||||
|
Expiration: expiration,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := dr.client.Call("Plugin.RenewUser", req, &struct{}{})
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) RevokeUser(statements Statements, username string) error {
|
||||||
|
req := RevokeUserRequest{
|
||||||
|
Statements: statements,
|
||||||
|
Username: username,
|
||||||
|
}
|
||||||
|
|
||||||
|
err := dr.client.Call("Plugin.RevokeUser", req, &struct{}{})
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) Close() error {
|
||||||
|
err := dr.client.Call("Plugin.Close", struct{}{}, &struct{}{})
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) GenerateUsername(displayName string) (string, error) {
|
||||||
|
var username string
|
||||||
|
err := dr.client.Call("Plugin.GenerateUsername", displayName, &username)
|
||||||
|
|
||||||
|
return username, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) GeneratePassword() (string, error) {
|
||||||
|
var password string
|
||||||
|
err := dr.client.Call("Plugin.GeneratePassword", struct{}{}, &password)
|
||||||
|
|
||||||
|
return password, err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (dr *databasePluginRPCClient) GenerateExpiration(duration time.Duration) (string, error) {
|
||||||
|
var expiration string
|
||||||
|
err := dr.client.Call("Plugin.GenerateExpiration", duration, &expiration)
|
||||||
|
|
||||||
|
return expiration, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- RPC server domain ----
|
||||||
|
type databasePluginRPCServer struct {
|
||||||
|
impl DatabaseType
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) Type(_ struct{}, resp *string) error {
|
||||||
|
*resp = "string"
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) CreateUser(args *CreateUserRequest, _ *struct{}) error {
|
||||||
|
err := ds.impl.CreateUser(args.Statements, args.Username, args.Password, args.Expiration)
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) RenewUser(args *RenewUserRequest, _ *struct{}) error {
|
||||||
|
err := ds.impl.RenewUser(args.Statements, args.Username, args.Expiration)
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) RevokeUser(args *RevokeUserRequest, _ *struct{}) error {
|
||||||
|
err := ds.impl.RevokeUser(args.Statements, args.Username)
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) Close(_ interface{}, _ *struct{}) error {
|
||||||
|
ds.impl.Close()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) GenerateUsername(args string, resp *string) error {
|
||||||
|
var err error
|
||||||
|
*resp, err = ds.impl.GenerateUsername(args)
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) GeneratePassword(_ struct{}, resp *string) error {
|
||||||
|
var err error
|
||||||
|
*resp, err = ds.impl.GeneratePassword()
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (ds *databasePluginRPCServer) GenerateExpiration(args time.Duration, resp *string) error {
|
||||||
|
var err error
|
||||||
|
*resp, err = ds.impl.GenerateExpiration(args)
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Request Args domain ----
|
||||||
|
|
||||||
|
type CreateUserRequest struct {
|
||||||
|
Statements Statements
|
||||||
|
Username string
|
||||||
|
Password string
|
||||||
|
Expiration string
|
||||||
|
}
|
||||||
|
|
||||||
|
type RenewUserRequest struct {
|
||||||
|
Statements Statements
|
||||||
|
Username string
|
||||||
|
Expiration string
|
||||||
|
}
|
||||||
|
|
||||||
|
type RevokeUserRequest struct {
|
||||||
|
Statements Statements
|
||||||
|
Username string
|
||||||
|
}
|
Loading…
Reference in a new issue