access_provider

Documentation

Index

• Constants
• type AccessSyncConfig
• type AccessSyncResult
• type AccessSyncer
• type AccessSyncerPlugin
  • func (AccessSyncerPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)
  • func (p AccessSyncerPlugin) Server(*plugin.MuxBroker) (interface{}, error)

Constants

const AccessSyncerName = "accessSyncer"

AccessSyncerName constant should not be used directly when implementing plugins. It's the registration name for the data access syncer plugin, used by the CLI and the cli-plugin-base library (RegisterPlugins function) to register the plugins.

Types

type AccessSyncConfig

type AccessSyncConfig struct {
	config.ConfigMap
	// SourceFile points to the file containing the access controls that need to be pushed to the data source.
	SourceFile string
	// TargetFile points to the file where the plugin needs to export the access controls to that are read from the data source.
	TargetFile string
	Prefix     string
}

AccessSyncConfig represents the configuration that is passed from the CLI to the AccessSyncer plugin interface. It contains all the necessary configuration parameters for the plugin to function.

type AccessSyncResult

type AccessSyncResult struct {
	Error *error2.ErrorResult
}

AccessSyncResult represents the result from the data access sync process. A potential error is also modeled in here so specific errors remain intact when passed over RPC.

type AccessSyncer

type AccessSyncer interface {
	SyncAccess(config *AccessSyncConfig) AccessSyncResult
}

AccessSyncer interface needs to be implemented by any plugin that wants to sync access controls between Raito and the data source. This sync can be in the 2 directions or in just 1 depending on the parameters set in AccessSyncConfig.

type AccessSyncerPlugin

type AccessSyncerPlugin struct {
	Impl AccessSyncer
}

AccessSyncerPlugin is used on the server (CLI) and client (plugin) side to integrate with the plugin system. A plugin should not be using this directly, but instead depend on the cli-plugin-base library to register the plugins.

func (AccessSyncerPlugin) Client

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

func (AccessSyncerPlugin) Server

func (p AccessSyncerPlugin) Server(*plugin.MuxBroker) (interface{}, error)