compile

Documentation

Index

• Constants
• func BatchCompile(queue <-chan *policy.CompilationUnit, schemaMgr schema.Manager) error
• func Compile(unit *policy.CompilationUnit, schemaMgr schema.Manager) (rps *runtimev1.RunnablePolicySet, err error)
• func Condition(cond *policyv1.Condition) (*runtimev1.Condition, error)
• func MigrateCompiledPolicies(policies *runtimev1.RunnablePolicySet) error
• type CELCompileError
  • func (cce *CELCompileError) Error() string
  • func (cce *CELCompileError) Unwrap() error
• type Conf
  • func DefaultConf() *Conf
  • func (c *Conf) Key() string
  • func (c *Conf) SetDefaults()
  • func (c *Conf) Validate() (outErr error)
• type Error
  • func (e *Error) Display() string
  • func (e *Error) Error() string
  • func (e *Error) MarshalJSON() ([]byte, error)
• type ErrorSet
  • func (e *ErrorSet) Add(err error)
  • func (e *ErrorSet) ErrOrNil() error
  • func (e *ErrorSet) Error() string
  • func (e *ErrorSet) Errors() *runtimev1.CompileErrors
• type Manager
  • func NewManager(ctx context.Context, store storage.SourceStore, schemaMgr schema.Manager) (*Manager, error)
  • func NewManagerFromConf(ctx context.Context, conf *Conf, store storage.SourceStore, ...) *Manager
  • func NewManagerFromDefaultConf(ctx context.Context, store storage.SourceStore, schemaMgr schema.Manager) *Manager
  • func (c *Manager) GetFirstMatch(ctx context.Context, candidates []namer.ModuleID) (*runtimev1.RunnablePolicySet, error)
  • func (c *Manager) GetPolicySet(ctx context.Context, modID namer.ModuleID) (*runtimev1.RunnablePolicySet, error)
  • func (c *Manager) OnStorageEvent(events ...storage.Event)
  • func (c *Manager) SubscriberID() string
• type PolicyCompilationErr
  • func (pce PolicyCompilationErr) Error() string
  • func (pce PolicyCompilationErr) Is(target error) bool
  • func (pce PolicyCompilationErr) Unwrap() error

Constants

const AnyRoleVal = "*"

Functions

func BatchCompile

func BatchCompile(queue <-chan *policy.CompilationUnit, schemaMgr schema.Manager) error

func Compile

func Compile(unit *policy.CompilationUnit, schemaMgr schema.Manager) (rps *runtimev1.RunnablePolicySet, err error)

func Condition

func Condition(cond *policyv1.Condition) (*runtimev1.Condition, error)

func MigrateCompiledPolicies

func MigrateCompiledPolicies(policies *runtimev1.RunnablePolicySet) error

MigrateCompiledPolicies modifies a RunnablePolicySet compiled by a previous version of Cerbos to migrate it to the latest format.

Types

type CELCompileError

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

CELCompileError holds CEL compilation errors.

func (*CELCompileError) Error

func (cce *CELCompileError) Error() string

func (*CELCompileError) Unwrap

func (cce *CELCompileError) Unwrap() error

type Conf

type Conf struct {
	// CacheSize is the number of compiled policies to cache in memory.
	CacheSize uint `yaml:"cacheSize" conf:",example=1024"`
	// CacheDuration is the duration to cache an entry.
	CacheDuration time.Duration `yaml:"cacheDuration" conf:",example=60s"`
}

Conf is optional configuration for caches.

func DefaultConf

func DefaultConf() *Conf

DefaultConf creates a config with defaults.

func (*Conf) Key

func (c *Conf) Key() string

func (*Conf) SetDefaults

func (c *Conf) SetDefaults()

func (*Conf) Validate

func (c *Conf) Validate() (outErr error)

type Error

type Error struct {
	*runtimev1.CompileErrors_Err
}

Error describes an error encountered during compilation.

func (*Error) Display

func (e *Error) Display() string

func (*Error) Error

func (e *Error) Error() string

func (*Error) MarshalJSON

func (e *Error) MarshalJSON() ([]byte, error)

type ErrorSet

type ErrorSet struct {
	CompileErrors map[uint64]*runtimev1.CompileErrors_Err
}

func (*ErrorSet) Add

func (e *ErrorSet) Add(err error)

func (*ErrorSet) ErrOrNil

func (e *ErrorSet) ErrOrNil() error

func (*ErrorSet) Error

func (e *ErrorSet) Error() string

func (*ErrorSet) Errors

func (e *ErrorSet) Errors() *runtimev1.CompileErrors

type Manager

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

func NewManager

func NewManager(ctx context.Context, store storage.SourceStore, schemaMgr schema.Manager) (*Manager, error)

func NewManagerFromConf

func NewManagerFromConf(ctx context.Context, conf *Conf, store storage.SourceStore, schemaMgr schema.Manager) *Manager

func NewManagerFromDefaultConf

func NewManagerFromDefaultConf(ctx context.Context, store storage.SourceStore, schemaMgr schema.Manager) *Manager

func (*Manager) GetFirstMatch

func (c *Manager) GetFirstMatch(ctx context.Context, candidates []namer.ModuleID) (*runtimev1.RunnablePolicySet, error)

func (*Manager) GetPolicySet

func (c *Manager) GetPolicySet(ctx context.Context, modID namer.ModuleID) (*runtimev1.RunnablePolicySet, error)

func (*Manager) OnStorageEvent

func (c *Manager) OnStorageEvent(events ...storage.Event)

func (*Manager) SubscriberID

func (c *Manager) SubscriberID() string

type PolicyCompilationErr

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

func (PolicyCompilationErr) Error

func (pce PolicyCompilationErr) Error() string

func (PolicyCompilationErr) Is

func (pce PolicyCompilationErr) Is(target error) bool

func (PolicyCompilationErr) Unwrap

func (pce PolicyCompilationErr) Unwrap() error