config

Documentation

Overview

Package config creates an osquery configuration plugin.

See https://osquery.readthedocs.io/en/latest/development/config-plugins/ for more.

Index

• type GenerateConfigsFunc
• type Plugin
  • func NewPlugin(name string, fn GenerateConfigsFunc) *Plugin
  • func (t *Plugin) Call(ctx context.Context, request osquery.ExtensionPluginRequest) osquery.ExtensionResponse
  • func (t *Plugin) Name() string
  • func (t *Plugin) Ping() osquery.ExtensionStatus
  • func (t *Plugin) RegistryName() string
  • func (t *Plugin) Routes() osquery.ExtensionPluginResponse
  • func (t *Plugin) Shutdown()

Types

type GenerateConfigsFunc

type GenerateConfigsFunc func(ctx context.Context) (map[string]string, error)

GenerateConfigsFunc returns the configurations generated by this plugin. The returned map should use the source name as key, and the config JSON as values. The context argument can optionally be used for cancellation in long-running operations.

type Plugin

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

Plugin is an osquery configuration plugin. Plugin implements the OsqueryPlugin interface.

func NewPlugin

func NewPlugin(name string, fn GenerateConfigsFunc) *Plugin

NewConfigPlugin takes a value that implements ConfigPlugin and wraps it with the appropriate methods to satisfy the OsqueryPlugin interface. Use this to easily create configuration plugins.

func (*Plugin) Call

func (t *Plugin) Call(ctx context.Context, request osquery.ExtensionPluginRequest) osquery.ExtensionResponse

func (*Plugin) Name

func (t *Plugin) Name() string

func (*Plugin) Ping

func (t *Plugin) Ping() osquery.ExtensionStatus

func (*Plugin) RegistryName

func (t *Plugin) RegistryName() string

func (*Plugin) Routes

func (t *Plugin) Routes() osquery.ExtensionPluginResponse

func (*Plugin) Shutdown

func (t *Plugin) Shutdown()