Backend plugin system (#2874)
* Add backend plugin changes
* Fix totp backend plugin tests
* Fix logical/plugin InvalidateKey test
* Fix plugin catalog CRUD test, fix NoopBackend
* Clean up commented code block
* Fix system backend mount test
* Set plugin_name to omitempty, fix handleMountTable config parsing
* Clean up comments, keep shim connections alive until cleanup
* Include pluginClient, disallow LookupPlugin call from within a plugin
* Add wrapper around backendPluginClient for proper cleanup
* Add logger shim tests
* Add logger, storage, and system shim tests
* Use pointer receivers for system view shim
* Use plugin name if no path is provided on mount
* Enable plugins for auth backends
* Add backend type attribute, move builtin/plugin/package
* Fix merge conflict
* Fix missing plugin name in mount config
* Add integration tests on enabling auth backend plugins
* Remove dependency cycle on mock-plugin
* Add passthrough backend plugin, use logical.BackendType to determine lease generation
* Remove vault package dependency on passthrough package
* Add basic impl test for passthrough plugin
* Incorporate feedback; set b.backend after shims creation on backendPluginServer
* Fix totp plugin test
* Add plugin backends docs
* Fix tests
* Fix builtin/plugin tests
* Remove flatten from PluginRunner fields
* Move mock plugin to logical/plugin, remove totp and passthrough plugins
* Move pluginMap into newPluginClient
* Do not create storage RPC connection on HandleRequest and HandleExistenceCheck
* Change shim logger's Fatal to no-op
* Change BackendType to uint32, match UX backend types
* Change framework.Backend Setup signature
* Add Setup func to logical.Backend interface
* Move OptionallyEnableMlock call into plugin.Serve, update docs and comments
* Remove commented var in plugin package
* RegisterLicense on logical.Backend interface (#3017)
* Add RegisterLicense to logical.Backend interface
* Update RegisterLicense to use callback func on framework.Backend
* Refactor framework.Backend.RegisterLicense
* plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs
* plugin: Revert BackendType to remove TypePassthrough and related references
* Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
|
|
|
package plugin
|
|
|
|
|
|
|
|
import (
|
|
|
|
"net/rpc"
|
|
|
|
|
|
|
|
plugin "github.com/hashicorp/go-plugin"
|
|
|
|
log "github.com/mgutz/logxi/v1"
|
|
|
|
)
|
|
|
|
|
|
|
|
type LoggerClient struct {
|
|
|
|
client *rpc.Client
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) Trace(msg string, args ...interface{}) {
|
|
|
|
cArgs := &LoggerArgs{
|
|
|
|
Msg: msg,
|
|
|
|
Args: args,
|
|
|
|
}
|
|
|
|
l.client.Call("Plugin.Trace", cArgs, &struct{}{})
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) Debug(msg string, args ...interface{}) {
|
|
|
|
cArgs := &LoggerArgs{
|
|
|
|
Msg: msg,
|
|
|
|
Args: args,
|
|
|
|
}
|
|
|
|
l.client.Call("Plugin.Debug", cArgs, &struct{}{})
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) Info(msg string, args ...interface{}) {
|
|
|
|
cArgs := &LoggerArgs{
|
|
|
|
Msg: msg,
|
|
|
|
Args: args,
|
|
|
|
}
|
|
|
|
l.client.Call("Plugin.Info", cArgs, &struct{}{})
|
|
|
|
}
|
|
|
|
func (l *LoggerClient) Warn(msg string, args ...interface{}) error {
|
|
|
|
var reply LoggerReply
|
|
|
|
cArgs := &LoggerArgs{
|
|
|
|
Msg: msg,
|
|
|
|
Args: args,
|
|
|
|
}
|
|
|
|
err := l.client.Call("Plugin.Warn", cArgs, &reply)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if reply.Error != nil {
|
|
|
|
return reply.Error
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
func (l *LoggerClient) Error(msg string, args ...interface{}) error {
|
|
|
|
var reply LoggerReply
|
|
|
|
cArgs := &LoggerArgs{
|
|
|
|
Msg: msg,
|
|
|
|
Args: args,
|
|
|
|
}
|
|
|
|
err := l.client.Call("Plugin.Error", cArgs, &reply)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if reply.Error != nil {
|
|
|
|
return reply.Error
|
|
|
|
}
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) Fatal(msg string, args ...interface{}) {
|
|
|
|
// NOOP since it's not actually used within vault
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) Log(level int, msg string, args []interface{}) {
|
|
|
|
cArgs := &LoggerArgs{
|
|
|
|
Level: level,
|
|
|
|
Msg: msg,
|
|
|
|
Args: args,
|
|
|
|
}
|
|
|
|
l.client.Call("Plugin.Log", cArgs, &struct{}{})
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) SetLevel(level int) {
|
|
|
|
l.client.Call("Plugin.SetLevel", level, &struct{}{})
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) IsTrace() bool {
|
|
|
|
var reply LoggerReply
|
|
|
|
l.client.Call("Plugin.IsTrace", new(interface{}), &reply)
|
|
|
|
return reply.IsTrue
|
|
|
|
}
|
|
|
|
func (l *LoggerClient) IsDebug() bool {
|
|
|
|
var reply LoggerReply
|
|
|
|
l.client.Call("Plugin.IsDebug", new(interface{}), &reply)
|
|
|
|
return reply.IsTrue
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) IsInfo() bool {
|
|
|
|
var reply LoggerReply
|
|
|
|
l.client.Call("Plugin.IsInfo", new(interface{}), &reply)
|
|
|
|
return reply.IsTrue
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerClient) IsWarn() bool {
|
|
|
|
var reply LoggerReply
|
|
|
|
l.client.Call("Plugin.IsWarn", new(interface{}), &reply)
|
|
|
|
return reply.IsTrue
|
|
|
|
}
|
|
|
|
|
|
|
|
type LoggerServer struct {
|
|
|
|
logger log.Logger
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) Trace(args *LoggerArgs, _ *struct{}) error {
|
2017-10-05 00:00:53 +00:00
|
|
|
l.logger.Trace(args.Msg, args.Args...)
|
Backend plugin system (#2874)
* Add backend plugin changes
* Fix totp backend plugin tests
* Fix logical/plugin InvalidateKey test
* Fix plugin catalog CRUD test, fix NoopBackend
* Clean up commented code block
* Fix system backend mount test
* Set plugin_name to omitempty, fix handleMountTable config parsing
* Clean up comments, keep shim connections alive until cleanup
* Include pluginClient, disallow LookupPlugin call from within a plugin
* Add wrapper around backendPluginClient for proper cleanup
* Add logger shim tests
* Add logger, storage, and system shim tests
* Use pointer receivers for system view shim
* Use plugin name if no path is provided on mount
* Enable plugins for auth backends
* Add backend type attribute, move builtin/plugin/package
* Fix merge conflict
* Fix missing plugin name in mount config
* Add integration tests on enabling auth backend plugins
* Remove dependency cycle on mock-plugin
* Add passthrough backend plugin, use logical.BackendType to determine lease generation
* Remove vault package dependency on passthrough package
* Add basic impl test for passthrough plugin
* Incorporate feedback; set b.backend after shims creation on backendPluginServer
* Fix totp plugin test
* Add plugin backends docs
* Fix tests
* Fix builtin/plugin tests
* Remove flatten from PluginRunner fields
* Move mock plugin to logical/plugin, remove totp and passthrough plugins
* Move pluginMap into newPluginClient
* Do not create storage RPC connection on HandleRequest and HandleExistenceCheck
* Change shim logger's Fatal to no-op
* Change BackendType to uint32, match UX backend types
* Change framework.Backend Setup signature
* Add Setup func to logical.Backend interface
* Move OptionallyEnableMlock call into plugin.Serve, update docs and comments
* Remove commented var in plugin package
* RegisterLicense on logical.Backend interface (#3017)
* Add RegisterLicense to logical.Backend interface
* Update RegisterLicense to use callback func on framework.Backend
* Refactor framework.Backend.RegisterLicense
* plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs
* plugin: Revert BackendType to remove TypePassthrough and related references
* Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) Debug(args *LoggerArgs, _ *struct{}) error {
|
2017-10-05 00:00:53 +00:00
|
|
|
l.logger.Debug(args.Msg, args.Args...)
|
Backend plugin system (#2874)
* Add backend plugin changes
* Fix totp backend plugin tests
* Fix logical/plugin InvalidateKey test
* Fix plugin catalog CRUD test, fix NoopBackend
* Clean up commented code block
* Fix system backend mount test
* Set plugin_name to omitempty, fix handleMountTable config parsing
* Clean up comments, keep shim connections alive until cleanup
* Include pluginClient, disallow LookupPlugin call from within a plugin
* Add wrapper around backendPluginClient for proper cleanup
* Add logger shim tests
* Add logger, storage, and system shim tests
* Use pointer receivers for system view shim
* Use plugin name if no path is provided on mount
* Enable plugins for auth backends
* Add backend type attribute, move builtin/plugin/package
* Fix merge conflict
* Fix missing plugin name in mount config
* Add integration tests on enabling auth backend plugins
* Remove dependency cycle on mock-plugin
* Add passthrough backend plugin, use logical.BackendType to determine lease generation
* Remove vault package dependency on passthrough package
* Add basic impl test for passthrough plugin
* Incorporate feedback; set b.backend after shims creation on backendPluginServer
* Fix totp plugin test
* Add plugin backends docs
* Fix tests
* Fix builtin/plugin tests
* Remove flatten from PluginRunner fields
* Move mock plugin to logical/plugin, remove totp and passthrough plugins
* Move pluginMap into newPluginClient
* Do not create storage RPC connection on HandleRequest and HandleExistenceCheck
* Change shim logger's Fatal to no-op
* Change BackendType to uint32, match UX backend types
* Change framework.Backend Setup signature
* Add Setup func to logical.Backend interface
* Move OptionallyEnableMlock call into plugin.Serve, update docs and comments
* Remove commented var in plugin package
* RegisterLicense on logical.Backend interface (#3017)
* Add RegisterLicense to logical.Backend interface
* Update RegisterLicense to use callback func on framework.Backend
* Refactor framework.Backend.RegisterLicense
* plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs
* plugin: Revert BackendType to remove TypePassthrough and related references
* Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) Info(args *LoggerArgs, _ *struct{}) error {
|
2017-10-05 00:00:53 +00:00
|
|
|
l.logger.Info(args.Msg, args.Args...)
|
Backend plugin system (#2874)
* Add backend plugin changes
* Fix totp backend plugin tests
* Fix logical/plugin InvalidateKey test
* Fix plugin catalog CRUD test, fix NoopBackend
* Clean up commented code block
* Fix system backend mount test
* Set plugin_name to omitempty, fix handleMountTable config parsing
* Clean up comments, keep shim connections alive until cleanup
* Include pluginClient, disallow LookupPlugin call from within a plugin
* Add wrapper around backendPluginClient for proper cleanup
* Add logger shim tests
* Add logger, storage, and system shim tests
* Use pointer receivers for system view shim
* Use plugin name if no path is provided on mount
* Enable plugins for auth backends
* Add backend type attribute, move builtin/plugin/package
* Fix merge conflict
* Fix missing plugin name in mount config
* Add integration tests on enabling auth backend plugins
* Remove dependency cycle on mock-plugin
* Add passthrough backend plugin, use logical.BackendType to determine lease generation
* Remove vault package dependency on passthrough package
* Add basic impl test for passthrough plugin
* Incorporate feedback; set b.backend after shims creation on backendPluginServer
* Fix totp plugin test
* Add plugin backends docs
* Fix tests
* Fix builtin/plugin tests
* Remove flatten from PluginRunner fields
* Move mock plugin to logical/plugin, remove totp and passthrough plugins
* Move pluginMap into newPluginClient
* Do not create storage RPC connection on HandleRequest and HandleExistenceCheck
* Change shim logger's Fatal to no-op
* Change BackendType to uint32, match UX backend types
* Change framework.Backend Setup signature
* Add Setup func to logical.Backend interface
* Move OptionallyEnableMlock call into plugin.Serve, update docs and comments
* Remove commented var in plugin package
* RegisterLicense on logical.Backend interface (#3017)
* Add RegisterLicense to logical.Backend interface
* Update RegisterLicense to use callback func on framework.Backend
* Refactor framework.Backend.RegisterLicense
* plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs
* plugin: Revert BackendType to remove TypePassthrough and related references
* Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) Warn(args *LoggerArgs, reply *LoggerReply) error {
|
2017-10-05 00:00:53 +00:00
|
|
|
err := l.logger.Warn(args.Msg, args.Args...)
|
Backend plugin system (#2874)
* Add backend plugin changes
* Fix totp backend plugin tests
* Fix logical/plugin InvalidateKey test
* Fix plugin catalog CRUD test, fix NoopBackend
* Clean up commented code block
* Fix system backend mount test
* Set plugin_name to omitempty, fix handleMountTable config parsing
* Clean up comments, keep shim connections alive until cleanup
* Include pluginClient, disallow LookupPlugin call from within a plugin
* Add wrapper around backendPluginClient for proper cleanup
* Add logger shim tests
* Add logger, storage, and system shim tests
* Use pointer receivers for system view shim
* Use plugin name if no path is provided on mount
* Enable plugins for auth backends
* Add backend type attribute, move builtin/plugin/package
* Fix merge conflict
* Fix missing plugin name in mount config
* Add integration tests on enabling auth backend plugins
* Remove dependency cycle on mock-plugin
* Add passthrough backend plugin, use logical.BackendType to determine lease generation
* Remove vault package dependency on passthrough package
* Add basic impl test for passthrough plugin
* Incorporate feedback; set b.backend after shims creation on backendPluginServer
* Fix totp plugin test
* Add plugin backends docs
* Fix tests
* Fix builtin/plugin tests
* Remove flatten from PluginRunner fields
* Move mock plugin to logical/plugin, remove totp and passthrough plugins
* Move pluginMap into newPluginClient
* Do not create storage RPC connection on HandleRequest and HandleExistenceCheck
* Change shim logger's Fatal to no-op
* Change BackendType to uint32, match UX backend types
* Change framework.Backend Setup signature
* Add Setup func to logical.Backend interface
* Move OptionallyEnableMlock call into plugin.Serve, update docs and comments
* Remove commented var in plugin package
* RegisterLicense on logical.Backend interface (#3017)
* Add RegisterLicense to logical.Backend interface
* Update RegisterLicense to use callback func on framework.Backend
* Refactor framework.Backend.RegisterLicense
* plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs
* plugin: Revert BackendType to remove TypePassthrough and related references
* Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
|
|
|
if err != nil {
|
|
|
|
*reply = LoggerReply{
|
|
|
|
Error: plugin.NewBasicError(err),
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) Error(args *LoggerArgs, reply *LoggerReply) error {
|
2017-10-05 00:00:53 +00:00
|
|
|
err := l.logger.Error(args.Msg, args.Args...)
|
Backend plugin system (#2874)
* Add backend plugin changes
* Fix totp backend plugin tests
* Fix logical/plugin InvalidateKey test
* Fix plugin catalog CRUD test, fix NoopBackend
* Clean up commented code block
* Fix system backend mount test
* Set plugin_name to omitempty, fix handleMountTable config parsing
* Clean up comments, keep shim connections alive until cleanup
* Include pluginClient, disallow LookupPlugin call from within a plugin
* Add wrapper around backendPluginClient for proper cleanup
* Add logger shim tests
* Add logger, storage, and system shim tests
* Use pointer receivers for system view shim
* Use plugin name if no path is provided on mount
* Enable plugins for auth backends
* Add backend type attribute, move builtin/plugin/package
* Fix merge conflict
* Fix missing plugin name in mount config
* Add integration tests on enabling auth backend plugins
* Remove dependency cycle on mock-plugin
* Add passthrough backend plugin, use logical.BackendType to determine lease generation
* Remove vault package dependency on passthrough package
* Add basic impl test for passthrough plugin
* Incorporate feedback; set b.backend after shims creation on backendPluginServer
* Fix totp plugin test
* Add plugin backends docs
* Fix tests
* Fix builtin/plugin tests
* Remove flatten from PluginRunner fields
* Move mock plugin to logical/plugin, remove totp and passthrough plugins
* Move pluginMap into newPluginClient
* Do not create storage RPC connection on HandleRequest and HandleExistenceCheck
* Change shim logger's Fatal to no-op
* Change BackendType to uint32, match UX backend types
* Change framework.Backend Setup signature
* Add Setup func to logical.Backend interface
* Move OptionallyEnableMlock call into plugin.Serve, update docs and comments
* Remove commented var in plugin package
* RegisterLicense on logical.Backend interface (#3017)
* Add RegisterLicense to logical.Backend interface
* Update RegisterLicense to use callback func on framework.Backend
* Refactor framework.Backend.RegisterLicense
* plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs
* plugin: Revert BackendType to remove TypePassthrough and related references
* Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
|
|
|
if err != nil {
|
|
|
|
*reply = LoggerReply{
|
|
|
|
Error: plugin.NewBasicError(err),
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) Log(args *LoggerArgs, _ *struct{}) error {
|
|
|
|
l.logger.Log(args.Level, args.Msg, args.Args)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) SetLevel(args int, _ *struct{}) error {
|
|
|
|
l.logger.SetLevel(args)
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) IsTrace(args interface{}, reply *LoggerReply) error {
|
|
|
|
result := l.logger.IsTrace()
|
|
|
|
*reply = LoggerReply{
|
|
|
|
IsTrue: result,
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) IsDebug(args interface{}, reply *LoggerReply) error {
|
|
|
|
result := l.logger.IsDebug()
|
|
|
|
*reply = LoggerReply{
|
|
|
|
IsTrue: result,
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) IsInfo(args interface{}, reply *LoggerReply) error {
|
|
|
|
result := l.logger.IsInfo()
|
|
|
|
*reply = LoggerReply{
|
|
|
|
IsTrue: result,
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (l *LoggerServer) IsWarn(args interface{}, reply *LoggerReply) error {
|
|
|
|
result := l.logger.IsWarn()
|
|
|
|
*reply = LoggerReply{
|
|
|
|
IsTrue: result,
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
type LoggerArgs struct {
|
|
|
|
Level int
|
|
|
|
Msg string
|
|
|
|
Args []interface{}
|
|
|
|
}
|
|
|
|
|
|
|
|
// LoggerReply contains the RPC reply. Not all fields may be used
|
|
|
|
// for a particular RPC call.
|
|
|
|
type LoggerReply struct {
|
|
|
|
IsTrue bool
|
|
|
|
Error *plugin.BasicError
|
|
|
|
}
|