plugin

Documentation

Index

• Variables
• func Serve(options *PluginOptions) error
• type AsertoPluginServer
  • func (s AsertoPluginServer) Delete(srv proto.Plugin_DeleteServer) error
  • func (s AsertoPluginServer) Export(req *proto.ExportRequest, srv proto.Plugin_ExportServer) error
  • func (s AsertoPluginServer) Import(srv proto.Plugin_ImportServer) error
  • func (s AsertoPluginServer) Info(ctx context.Context, req *proto.InfoRequest) (*proto.InfoResponse, error)
  • func (s AsertoPluginServer) Validate(ctx context.Context, req *proto.ValidateRequest) (*proto.ValidateResponse, error)
• type OperationType
• type PluginConfig
• type PluginHandler
• type PluginOptions
• type Stats

Variables

var Handshake = plugin.HandshakeConfig{

	ProtocolVersion:  1,
	MagicCookieKey:   "IDP_PLUGIN",
	MagicCookieValue: "be60172b-2526-432a-865c-12386998a714",
}

Handshake is a common handshake that is shared by plugin and host.

var PluginMap = plugin.PluginSet{
	"idp-plugin": &grpcplugin.PluginGRPC{},
}

PluginMap is the map of plugins we can dispense.

Functions

func Serve

func Serve(options *PluginOptions) error

Types

type AsertoPluginServer

type AsertoPluginServer struct {
	PluginHandler PluginHandler
}

func (AsertoPluginServer) Delete

func (s AsertoPluginServer) Delete(srv proto.Plugin_DeleteServer) error

func (AsertoPluginServer) Export

func (s AsertoPluginServer) Export(req *proto.ExportRequest, srv proto.Plugin_ExportServer) error

func (AsertoPluginServer) Import

func (s AsertoPluginServer) Import(srv proto.Plugin_ImportServer) error

func (AsertoPluginServer) Info

func (s AsertoPluginServer) Info(ctx context.Context, req *proto.InfoRequest) (*proto.InfoResponse, error)

func (AsertoPluginServer) Validate

func (s AsertoPluginServer) Validate(ctx context.Context, req *proto.ValidateRequest) (*proto.ValidateResponse, error)

type OperationType

type OperationType int

const (
	OperationTypeRead OperationType = iota
	OperationTypeWrite
	OperationTypeDelete
)

type PluginConfig

type PluginConfig interface {
	Validate() error
	Description() string
}

type PluginHandler

type PluginHandler interface {
	GetConfig() PluginConfig
	Open(PluginConfig, OperationType) error
	Read() ([]*api.User, error)
	Write(*api.User) error
	Delete(string) error
	Close() (*Stats, error)
	GetVersion() (string, string, string)
}

type PluginOptions

type PluginOptions struct {
	PluginHandler PluginHandler
}

type Stats

type Stats struct {
	Received int32
	Created  int32
	Updated  int32
	Deleted  int32
	Errors   int32
}