engine

Documentation

Index

• Constants
• Variables
• type CheckOpt
  • func WithWriterTraceSink(w io.Writer) CheckOpt
  • func WithZapTraceSink(log *zap.Logger) CheckOpt
• type Conf
  • func (c *Conf) Key() string
  • func (c *Conf) SetDefaults()
  • func (c *Conf) Validate() error
• type Engine
  • func New(ctx context.Context, compileMgr *compile.Manager, auditLog audit.Log) (*Engine, error)
  • func NewEphemeral(ctx context.Context, compileMgr *compile.Manager) (*Engine, error)
  • func (engine *Engine) Check(ctx context.Context, inputs []*enginev1.CheckInput, opts ...CheckOpt) ([]*enginev1.CheckOutput, error)
• type EvalResult
• type Evaluator
  • func NewEvaluator(rps *runtimev1.RunnablePolicySet, t *tracer) Evaluator
• type KV
  • func KVActivated() KV
  • func KVEffect(effect effectv1.Effect) KV
  • func KVError(err error) KV
  • func KVMsg(msg string, params ...interface{}) KV
  • func KVResult(result bool) KV
  • func KVSkip() KV
• type NoopTraceSink
  • func (NoopTraceSink) Enabled() bool
  • func (NoopTraceSink) WriteEvent(component []string, data ...KV)
• type TraceSink
• type WriterTraceSink
  • func NewWriterTraceSink(w io.Writer) *WriterTraceSink
  • func (wts *WriterTraceSink) Enabled() bool
  • func (wts *WriterTraceSink) WriteEvent(component []string, data ...KV)
• type ZapTraceSink
  • func NewZapTraceSink(log *zap.Logger) *ZapTraceSink
  • func (zts *ZapTraceSink) Enabled() bool
  • func (zts *ZapTraceSink) WriteEvent(component []string, data ...KV)

Constants

const (
	ActivatedKey = "activated"
	EffectKey    = "effect"
	ErrorKey     = "error"
	MessageKey   = "message"
	ResultKey    = "result"
)

Variables

var (
	ErrPolicyNotExecutable = errors.New("policy not executable")
	ErrUnexpectedResult    = errors.New("unexpected result")
)

var ErrNoPoliciesMatched = errors.New("no matching policies")

ErrNoPoliciesMatched indicates that no policies were matched.

Types

type CheckOpt

type CheckOpt func(*checkOptions)

CheckOpt defines options for engine Check calls.

func WithWriterTraceSink

func WithWriterTraceSink(w io.Writer) CheckOpt

WithWriterTraceSink sets an engine tracer with an io.Writer as the sink.

func WithZapTraceSink

func WithZapTraceSink(log *zap.Logger) CheckOpt

WithZapTraceSink sets an engine tracer with Zap set as the sink.

type Conf

type Conf struct {
	DefaultPolicyVersion string `yaml:"defaultPolicyVersion"`
	NumWorkers           uint   `yaml:"numWorkers"`
}

func (*Conf) Key

func (c *Conf) Key() string

func (*Conf) SetDefaults

func (c *Conf) SetDefaults()

func (*Conf) Validate

func (c *Conf) Validate() error

type Engine

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

func New

func New(ctx context.Context, compileMgr *compile.Manager, auditLog audit.Log) (*Engine, error)

func NewEphemeral

func NewEphemeral(ctx context.Context, compileMgr *compile.Manager) (*Engine, error)

func (*Engine) Check

func (engine *Engine) Check(ctx context.Context, inputs []*enginev1.CheckInput, opts ...CheckOpt) ([]*enginev1.CheckOutput, error)

type EvalResult

type EvalResult struct {
	PolicyKey             string
	Effects               map[string]effectv1.Effect
	EffectiveDerivedRoles map[string]struct{}
}

type Evaluator

type Evaluator interface {
	Evaluate(context.Context, *enginev1.CheckInput) (*EvalResult, error)
}

func NewEvaluator

func NewEvaluator(rps *runtimev1.RunnablePolicySet, t *tracer) Evaluator

type KV

type KV func() (string, string)

KV is a function that returns a key-value pair.

func KVActivated

func KVActivated() KV

KVActivated produces a KV for component activation.

func KVEffect

func KVEffect(effect effectv1.Effect) KV

KVEffect produces a KV for setting default effect.

func KVError

func KVError(err error) KV

KVError produces a KV for an error.

func KVMsg

func KVMsg(msg string, params ...interface{}) KV

KVMsg produces a KV for a free-form message.

func KVResult

func KVResult(result bool) KV

KVResult produces a KV for a condition result.

func KVSkip

func KVSkip() KV

KVSkip produces a KV for skipping evaluation.

type NoopTraceSink

type NoopTraceSink struct{}

NoopTraceSink implements a sink that does nothing.

func (NoopTraceSink) Enabled

func (NoopTraceSink) Enabled() bool

func (NoopTraceSink) WriteEvent

func (NoopTraceSink) WriteEvent(component []string, data ...KV)

type TraceSink

type TraceSink interface {
	Enabled() bool
	WriteEvent(component []string, data ...KV)
}

TraceSink is the interface for sinks that receive trace events from the engine.

type WriterTraceSink

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

WriterTraceSink implements TraceSink using an io.Writer.

func NewWriterTraceSink

func NewWriterTraceSink(w io.Writer) *WriterTraceSink

func (*WriterTraceSink) Enabled

func (wts *WriterTraceSink) Enabled() bool

func (*WriterTraceSink) WriteEvent

func (wts *WriterTraceSink) WriteEvent(component []string, data ...KV)

type ZapTraceSink

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

ZapTraceSink implements TraceSink using a Zap logger.

func NewZapTraceSink

func NewZapTraceSink(log *zap.Logger) *ZapTraceSink

func (*ZapTraceSink) Enabled

func (zts *ZapTraceSink) Enabled() bool

func (*ZapTraceSink) WriteEvent

func (zts *ZapTraceSink) WriteEvent(component []string, data ...KV)