enforcer

Documentation

Index

• Variables
• type Enforcer
  • func ProvideEnforcer(logger *log.Logger, tokens token.TokensServer) *Enforcer
  • func (e *Enforcer) Check(ctx context.Context, rule *capabilities.Rule) (bool, error)
  • func (e *Enforcer) Enforce(ctx context.Context, dir capabilities.Direction, val protoreflect.Value) (bool, error)

Variables

var Set = wire.NewSet(ProvideEnforcer)

Set is used by wire.

Types

type Enforcer

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

Enforcer applies a rule-set to protobuf messages.

func ProvideEnforcer

func ProvideEnforcer(logger *log.Logger, tokens token.TokensServer) *Enforcer

ProvideEnforcer is used by wire.

func (*Enforcer) Check

func (e *Enforcer) Check(ctx context.Context, rule *capabilities.Rule) (bool, error)

Check returns true if the rule can be satisfied solely by the context.

func (*Enforcer) Enforce

func (e *Enforcer) Enforce(
	ctx context.Context, dir capabilities.Direction, val protoreflect.Value,
) (bool, error)

Enforce modifies the given message in-place in order to conform to the embedded rule-set. The method returns true if the message already complied with the rule-set (i.e. no modifications were made).