plugin

package
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 15, 2019 License: MPL-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const BackendPluginName = "backend"

BackendPluginName is the name of the plugin that can be dispensed from the plugin server.

Variables

View Source 
var (
	ErrClientInMetadataMode = errors.New("plugin client can not perform action while in metadata mode")
)
View Source 
var ErrPluginShutdown = errors.New("plugin is shut down")
View Source 
var (
	ErrServerInMetadataMode = errors.New("plugin server can not perform action while in metadata mode")
)

Functions

func NewBackend 

func NewBackend(ctx context.Context, pluginName string, pluginType consts.PluginType, sys pluginutil.LookRunnerUtil, conf *logical.BackendConfig, isMetadataMode bool) (logical.Backend, error)

NewBackend will return an instance of an RPC-based client implementation of the backend for external plugins, or a concrete implementation of the backend if it is a builtin backend. The backend is returned as a logical.Backend interface. The isMetadataMode param determines whether the plugin should run in metadata mode.

func NewPluginClient added in v1.0.0 

func NewPluginClient(ctx context.Context, sys pluginutil.RunnerUtil, pluginRunner *pluginutil.PluginRunner, logger log.Logger, isMetadataMode bool) (logical.Backend, error)

func Serve 

func Serve(opts *ServeOpts) error

Serve is a helper function used to serve a backend plugin. This should be ran on the plugin's main process.

Types

type BackendPlugin 

type BackendPlugin struct {
	*GRPCBackendPlugin
}

BackendPlugin is the plugin.Plugin implementation

func (BackendPlugin) Client 

func (b BackendPlugin) Client(broker *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

Client gets called on plugin.NewClient()

func (*BackendPlugin) Server 

func (b *BackendPlugin) Server(broker *plugin.MuxBroker) (interface{}, error)

Server gets called when on plugin.Serve()

type BackendPluginClient 

type BackendPluginClient struct {
	sync.Mutex

	logical.Backend
	// contains filtered or unexported fields
}

BackendPluginClient is a wrapper around backendPluginClient that also contains its plugin.Client instance. It's primarily used to cleanly kill the client on Cleanup()

func (*BackendPluginClient) Cleanup 

func (b *BackendPluginClient) Cleanup(ctx context.Context)

Cleanup calls the RPC client's Cleanup() func and also calls the go-plugin's client Kill() func

type CachingDisabledReply 

type CachingDisabledReply struct {
	CachingDisabled bool
}

type DefaultLeaseTTLReply 

type DefaultLeaseTTLReply struct {
	DefaultLeaseTTL time.Duration
}

type EntityInfoArgs added in v0.10.2 

type EntityInfoArgs struct {
	EntityID string
}

type EntityInfoReply added in v0.10.2 

type EntityInfoReply struct {
	Entity *logical.Entity
	Error  error
}

type GRPCBackendPlugin added in v0.11.4 

type GRPCBackendPlugin struct {
	Factory      logical.Factory
	MetadataMode bool
	Logger       log.Logger

	// Embeding this will disable the netRPC protocol
	plugin.NetRPCUnsupportedPlugin
}

GRPCBackendPlugin is the plugin.Plugin implementation that only supports GRPC transport

func (*GRPCBackendPlugin) GRPCClient added in v0.11.4 

func (b *GRPCBackendPlugin) GRPCClient(ctx context.Context, broker *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

func (GRPCBackendPlugin) GRPCServer added in v0.11.4 

func (b GRPCBackendPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error

type GRPCStorageClient added in v0.9.2 

type GRPCStorageClient struct {
	// contains filtered or unexported fields
}

GRPCStorageClient is an implementation of logical.Storage that communicates over RPC.

func (*GRPCStorageClient) Delete added in v0.9.2 

func (s *GRPCStorageClient) Delete(ctx context.Context, key string) error

func (*GRPCStorageClient) Get added in v0.9.2 

func (s *GRPCStorageClient) Get(ctx context.Context, key string) (*logical.StorageEntry, error)

func (*GRPCStorageClient) List added in v0.9.2 

func (s *GRPCStorageClient) List(ctx context.Context, prefix string) ([]string, error)

func (*GRPCStorageClient) Put added in v0.9.2 

func (s *GRPCStorageClient) Put(ctx context.Context, entry *logical.StorageEntry) error

type GRPCStorageServer added in v0.9.2 

type GRPCStorageServer struct {
	// contains filtered or unexported fields
}

StorageServer is a net/rpc compatible structure for serving

func (*GRPCStorageServer) Delete added in v0.9.2 

func (s *GRPCStorageServer) Delete(ctx context.Context, args *pb.StorageDeleteArgs) (*pb.StorageDeleteReply, error)

func (*GRPCStorageServer) Get added in v0.9.2 

func (s *GRPCStorageServer) Get(ctx context.Context, args *pb.StorageGetArgs) (*pb.StorageGetReply, error)

func (*GRPCStorageServer) List added in v0.9.2 

func (s *GRPCStorageServer) List(ctx context.Context, args *pb.StorageListArgs) (*pb.StorageListReply, error)

func (*GRPCStorageServer) Put added in v0.9.2 

func (s *GRPCStorageServer) Put(ctx context.Context, args *pb.StoragePutArgs) (*pb.StoragePutReply, error)

type HandleExistenceCheckArgs 

type HandleExistenceCheckArgs struct {
	StorageID uint32
	Request   *logical.Request
}

HandleExistenceCheckArgs is the args for HandleExistenceCheck method.

type HandleExistenceCheckReply 

type HandleExistenceCheckReply struct {
	CheckFound bool
	Exists     bool
	Error      error
}

HandleExistenceCheckReply is the reply for HandleExistenceCheck method.

type HandleRequestArgs 

type HandleRequestArgs struct {
	StorageID uint32
	Request   *logical.Request
}

HandleRequestArgs is the args for HandleRequest method.

type HandleRequestReply 

type HandleRequestReply struct {
	Response *logical.Response
	Error    error
}

HandleRequestReply is the reply for HandleRequest method.

type LocalMountReply added in v0.9.4 

type LocalMountReply struct {
	Local bool
}

type LoggerArgs 

type LoggerArgs struct {
	Level int
	Msg   string
	Args  []interface{}
}

type LoggerReply 

type LoggerReply struct {
	IsTrue bool
	Error  error
}

LoggerReply contains the RPC reply. Not all fields may be used for a particular RPC call.

type LoggerServer 

type LoggerServer struct {
	// contains filtered or unexported fields
}

func (*LoggerServer) Debug 

func (l *LoggerServer) Debug(args *LoggerArgs, _ *struct{}) error

func (*LoggerServer) Error 

func (l *LoggerServer) Error(args *LoggerArgs, reply *LoggerReply) error

func (*LoggerServer) Info 

func (l *LoggerServer) Info(args *LoggerArgs, _ *struct{}) error

func (*LoggerServer) IsDebug 

func (l *LoggerServer) IsDebug(args interface{}, reply *LoggerReply) error

func (*LoggerServer) IsInfo 

func (l *LoggerServer) IsInfo(args interface{}, reply *LoggerReply) error

func (*LoggerServer) IsTrace 

func (l *LoggerServer) IsTrace(args interface{}, reply *LoggerReply) error

func (*LoggerServer) IsWarn 

func (l *LoggerServer) IsWarn(args interface{}, reply *LoggerReply) error

func (*LoggerServer) Log 

func (l *LoggerServer) Log(args *LoggerArgs, _ *struct{}) error

func (*LoggerServer) SetLevel 

func (l *LoggerServer) SetLevel(args int, _ *struct{}) error

func (*LoggerServer) Trace 

func (l *LoggerServer) Trace(args *LoggerArgs, _ *struct{}) error

func (*LoggerServer) Warn 

func (l *LoggerServer) Warn(args *LoggerArgs, reply *LoggerReply) error

type MaxLeaseTTLReply 

type MaxLeaseTTLReply struct {
	MaxLeaseTTL time.Duration
}

type MlockEnabledReply 

type MlockEnabledReply struct {
	MlockEnabled bool
}

type NOOPStorage added in v0.8.2 

type NOOPStorage struct{}

NOOPStorage is used to deny access to the storage interface while running a backend plugin in metadata mode.

func (*NOOPStorage) Delete added in v0.8.2 

func (s *NOOPStorage) Delete(_ context.Context, key string) error

func (*NOOPStorage) Get added in v0.8.2 

func (s *NOOPStorage) Get(_ context.Context, key string) (*logical.StorageEntry, error)

func (*NOOPStorage) List added in v0.8.2 

func (s *NOOPStorage) List(_ context.Context, prefix string) ([]string, error)

func (*NOOPStorage) Put added in v0.8.2 

func (s *NOOPStorage) Put(_ context.Context, entry *logical.StorageEntry) error

type PluginEnvReply added in v0.11.0 

type PluginEnvReply struct {
	PluginEnvironment *logical.PluginEnvironment
	Error             error
}

type ReplicationStateReply 

type ReplicationStateReply struct {
	ReplicationState consts.ReplicationState
}

type ResponseWrapDataArgs 

type ResponseWrapDataArgs struct {
	Data map[string]interface{}
	TTL  time.Duration
	JWT  bool
}

type ResponseWrapDataReply 

type ResponseWrapDataReply struct {
	ResponseWrapInfo *wrapping.ResponseWrapInfo
	Error            error
}

type ServeOpts 

type ServeOpts struct {
	BackendFactoryFunc logical.Factory
	TLSProviderFunc    TLSProviderFunc
	Logger             log.Logger
}

type SetupArgs 

type SetupArgs struct {
	StorageID   uint32
	LoggerID    uint32
	SysViewID   uint32
	Config      map[string]string
	BackendUUID string
}

SetupArgs is the args for Setup method.

type SetupReply 

type SetupReply struct {
	Error error
}

SetupReply is the reply for Setup method.

type SpecialPathsReply 

type SpecialPathsReply struct {
	Paths *logical.Paths
}

SpecialPathsReply is the reply for SpecialPaths method.

type StorageClient 

type StorageClient struct {
	// contains filtered or unexported fields
}

StorageClient is an implementation of logical.Storage that communicates over RPC.

func (*StorageClient) Delete 

func (s *StorageClient) Delete(_ context.Context, key string) error

func (*StorageClient) Get 

func (s *StorageClient) Get(_ context.Context, key string) (*logical.StorageEntry, error)

func (*StorageClient) List 

func (s *StorageClient) List(_ context.Context, prefix string) ([]string, error)

func (*StorageClient) Put 

func (s *StorageClient) Put(_ context.Context, entry *logical.StorageEntry) error

type StorageDeleteReply 

type StorageDeleteReply struct {
	Error error
}

type StorageGetReply 

type StorageGetReply struct {
	StorageEntry *logical.StorageEntry
	Error        error
}

type StorageListReply 

type StorageListReply struct {
	Keys  []string
	Error error
}

type StoragePutReply 

type StoragePutReply struct {
	Error error
}

type StorageServer 

type StorageServer struct {
	// contains filtered or unexported fields
}

StorageServer is a net/rpc compatible structure for serving

func (*StorageServer) Delete 

func (s *StorageServer) Delete(key string, reply *StorageDeleteReply) error

func (*StorageServer) Get 

func (s *StorageServer) Get(key string, reply *StorageGetReply) error

func (*StorageServer) List 

func (s *StorageServer) List(prefix string, reply *StorageListReply) error

func (*StorageServer) Put 

func (s *StorageServer) Put(entry *logical.StorageEntry, reply *StoragePutReply) error

type SudoPrivilegeArgs 

type SudoPrivilegeArgs struct {
	Path  string
	Token string
}

type SudoPrivilegeReply 

type SudoPrivilegeReply struct {
	Sudo bool
}

type SystemReply 

type SystemReply struct {
	SystemView logical.SystemView
	Error      error
}

SystemReply is the reply for System method.

type SystemViewClient 

type SystemViewClient struct {
	// contains filtered or unexported fields
}

func (*SystemViewClient) CachingDisabled 

func (s *SystemViewClient) CachingDisabled() bool

func (*SystemViewClient) DefaultLeaseTTL 

func (s *SystemViewClient) DefaultLeaseTTL() time.Duration

func (*SystemViewClient) EntityInfo added in v0.10.2 

func (s *SystemViewClient) EntityInfo(entityID string) (*logical.Entity, error)

func (*SystemViewClient) HasFeature added in v0.11.2 

func (s *SystemViewClient) HasFeature(feature license.Features) bool

func (*SystemViewClient) LocalMount added in v0.9.4 

func (s *SystemViewClient) LocalMount() bool

func (*SystemViewClient) LookupPlugin 

func (s *SystemViewClient) LookupPlugin(_ context.Context, _ string, _ consts.PluginType) (*pluginutil.PluginRunner, error)

func (*SystemViewClient) MaxLeaseTTL 

func (s *SystemViewClient) MaxLeaseTTL() time.Duration

func (*SystemViewClient) MlockEnabled 

func (s *SystemViewClient) MlockEnabled() bool

func (*SystemViewClient) PluginEnv added in v0.11.0 

func (s *SystemViewClient) PluginEnv(_ context.Context) (*logical.PluginEnvironment, error)

func (*SystemViewClient) ReplicationState 

func (s *SystemViewClient) ReplicationState() consts.ReplicationState

func (*SystemViewClient) ResponseWrapData 

func (s *SystemViewClient) ResponseWrapData(ctx context.Context, data map[string]interface{}, ttl time.Duration, jwt bool) (*wrapping.ResponseWrapInfo, error)

func (*SystemViewClient) SudoPrivilege 

func (s *SystemViewClient) SudoPrivilege(ctx context.Context, path string, token string) bool

func (*SystemViewClient) Tainted 

func (s *SystemViewClient) Tainted() bool

type SystemViewServer 

type SystemViewServer struct {
	// contains filtered or unexported fields
}

func (*SystemViewServer) CachingDisabled 

func (s *SystemViewServer) CachingDisabled(_ interface{}, reply *CachingDisabledReply) error

func (*SystemViewServer) DefaultLeaseTTL 

func (s *SystemViewServer) DefaultLeaseTTL(_ interface{}, reply *DefaultLeaseTTLReply) error

func (*SystemViewServer) EntityInfo added in v0.10.2 

func (s *SystemViewServer) EntityInfo(args *EntityInfoArgs, reply *EntityInfoReply) error

func (*SystemViewServer) LocalMount added in v0.9.4 

func (s *SystemViewServer) LocalMount(_ interface{}, reply *LocalMountReply) error

func (*SystemViewServer) MaxLeaseTTL 

func (s *SystemViewServer) MaxLeaseTTL(_ interface{}, reply *MaxLeaseTTLReply) error

func (*SystemViewServer) MlockEnabled 

func (s *SystemViewServer) MlockEnabled(_ interface{}, reply *MlockEnabledReply) error

func (*SystemViewServer) PluginEnv added in v0.11.0 

func (s *SystemViewServer) PluginEnv(_ interface{}, reply *PluginEnvReply) error

func (*SystemViewServer) ReplicationState 

func (s *SystemViewServer) ReplicationState(_ interface{}, reply *ReplicationStateReply) error

func (*SystemViewServer) ResponseWrapData 

func (s *SystemViewServer) ResponseWrapData(args *ResponseWrapDataArgs, reply *ResponseWrapDataReply) error

func (*SystemViewServer) SudoPrivilege 

func (s *SystemViewServer) SudoPrivilege(args *SudoPrivilegeArgs, reply *SudoPrivilegeReply) error

func (*SystemViewServer) Tainted 

func (s *SystemViewServer) Tainted(_ interface{}, reply *TaintedReply) error

type TLSProviderFunc added in v0.9.6 

type TLSProviderFunc func() (*tls.Config, error)

type TaintedReply 

type TaintedReply struct {
	Tainted bool
}

type TypeReply 

type TypeReply struct {
	Type logical.BackendType
}

TypeReply is the reply for the Type method.

Source Files

View all Source files

Directories

Path Synopsis
mock-plugin

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.