opa

README

OPA decision engine

policy.bindata.go

This file was generated in policy/*.rego.

Run the following command to generate:

go generate ./...

Note: Guarantee required go-bindata be installed.

go install github.com/kevinburke/go-bindata/v4/...@latest

Documentation

Index

• Constants
• func Asset(name string) ([]byte, error)
• func AssetDigest(name string) ([sha256.Size]byte, error)
• func AssetDir(name string) ([]string, error)
• func AssetInfo(name string) (os.FileInfo, error)
• func AssetNames() []string
• func AssetString(name string) (string, error)
• func Digests() (map[string][sha256.Size]byte, error)
• func MustAsset(name string) []byte
• func MustAssetString(name string) string
• func RestoreAsset(dir, name string) error
• func RestoreAssets(dir, name string) error
• type EvaluationError
  • func (e *EvaluationError) Error() string
• type OptFunc
  • func WithModules(mods map[string]*ast.Module) OptFunc
• type State
  • func New(_ context.Context, opts ...OptFunc) (*State, error)
  • func (s *State) DumpData(ctx context.Context) error
  • func (s *State) FilterAuthorizedPairs(ctx context.Context, subjects engine.Subjects, pairs engine.Pairs) (engine.Pairs, error)
  • func (s *State) FilterAuthorizedProjects(ctx context.Context, subjects engine.Subjects) (engine.Projects, error)
  • func (s *State) IsAuthorized(ctx context.Context, subject engine.Subject, action engine.Action, ...) (bool, error)
  • func (s *State) ProjectsAuthorized(ctx context.Context, subjects engine.Subjects, action engine.Action, ...) (engine.Projects, error)
  • func (s *State) SetPolicies(ctx context.Context, policyMap engine.PolicyMap, roleMap engine.RoleMap) error
• type UnexpectedResultExpressionError
  • func (e *UnexpectedResultExpressionError) Error() string
• type UnexpectedResultSetError
  • func (e *UnexpectedResultSetError) Error() string

Constants

const AssetDebug = false

AssetDebug is true if the assets were built with the debug flag enabled.

Functions

func Asset

func Asset(name string) ([]byte, error)

Asset loads and returns the asset for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetDigest

func AssetDigest(name string) ([sha256.Size]byte, error)

AssetDigest returns the digest of the file with the given name. It returns an error if the asset could not be found or the digest could not be loaded.

func AssetDir

func AssetDir(name string) ([]string, error)

AssetDir returns the file names below a certain directory embedded in the file by go-bindata. For example if you run go-bindata on data/... and data contains the following hierarchy:

data/
  foo.txt
  img/
    a.png
    b.png

then AssetDir("data") would return []string{"foo.txt", "img"}, AssetDir("data/img") would return []string{"a.png", "b.png"}, AssetDir("foo.txt") and AssetDir("notexist") would return an error, and AssetDir("") will return []string{"data"}.

func AssetInfo

func AssetInfo(name string) (os.FileInfo, error)

AssetInfo loads and returns the asset info for the given name. It returns an error if the asset could not be found or could not be loaded.

func AssetNames

func AssetNames() []string

AssetNames returns the names of the assets.

func AssetString

func AssetString(name string) (string, error)

AssetString returns the asset contents as a string (instead of a []byte).

func Digests

func Digests() (map[string][sha256.Size]byte, error)

Digests returns a map of all known files and their checksums.

func MustAsset

func MustAsset(name string) []byte

MustAsset is like Asset but panics when Asset would return an error. It simplifies safe initialization of global variables.

func MustAssetString

func MustAssetString(name string) string

MustAssetString is like AssetString but panics when Asset would return an error. It simplifies safe initialization of global variables.

func RestoreAsset

func RestoreAsset(dir, name string) error

RestoreAsset restores an asset under the given directory.

func RestoreAssets

func RestoreAssets(dir, name string) error

RestoreAssets restores an asset under the given directory recursively.

Types

type EvaluationError

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

func (*EvaluationError) Error

func (e *EvaluationError) Error() string

type OptFunc

type OptFunc func(*State)

func WithModules

func WithModules(mods map[string]*ast.Module) OptFunc

type State

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

func New

func New(_ context.Context, opts ...OptFunc) (*State, error)

func (*State) DumpData

func (s *State) DumpData(ctx context.Context) error

func (*State) FilterAuthorizedPairs

func (s *State) FilterAuthorizedPairs(ctx context.Context, subjects engine.Subjects, pairs engine.Pairs) (engine.Pairs, error)

func (*State) FilterAuthorizedProjects

func (s *State) FilterAuthorizedProjects(ctx context.Context, subjects engine.Subjects) (engine.Projects, error)

func (*State) IsAuthorized

func (s *State) IsAuthorized(ctx context.Context, subject engine.Subject, action engine.Action, resource engine.Resource, project engine.Project) (bool, error)

func (*State) ProjectsAuthorized

func (s *State) ProjectsAuthorized(ctx context.Context, subjects engine.Subjects, action engine.Action, resource engine.Resource, projects engine.Projects) (engine.Projects, error)

func (*State) SetPolicies

func (s *State) SetPolicies(ctx context.Context, policyMap engine.PolicyMap, roleMap engine.RoleMap) error

type UnexpectedResultExpressionError

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

func (*UnexpectedResultExpressionError) Error

func (e *UnexpectedResultExpressionError) Error() string

type UnexpectedResultSetError

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

func (*UnexpectedResultSetError) Error

func (e *UnexpectedResultSetError) Error() string