Skip to content

plugin: allow selecting wasm target for evaluation #276

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

plugin: allow selecting wasm target for evaluation #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/checks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ jobs:
e2e-envoy-grpc:
name: Envoy gRPC End-to-End Test
runs-on: ubuntu-18.04
strategy:
matrix:
include:
- eval: wasm
- eval: rego
steps:
- name: Check out code
uses: actions/checkout@v2
Expand All @@ -104,7 +109,7 @@ jobs:
working-directory: examples/grpc

- name: Run test
run: make test-setup test
run: make test-setup test EVAL_TARGET=${{ matrix.eval }}
working-directory: examples/grpc

- name: Run test log dump and cleanup
Expand Down
14 changes: 12 additions & 2 deletions envoyauth/evaluation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,12 @@ type EvalContext interface {
SetPreparedQuery(*rego.PreparedEvalQuery)
}

//Eval - Evaluates an input against a provided EvalContext and yields result
// EvalContextWithTarget is the interface that allows setting the evaluation's target engine.
type EvalContextWithTarget interface {
Target() string
}

// Eval evaluates an input against a provided EvalContext and yields result
func Eval(ctx context.Context, evalContext EvalContext, input ast.Value, result *EvalResult, opts ...func(*rego.Rego)) error {
var err error

Expand Down Expand Up @@ -87,13 +92,18 @@ func constructPreparedQuery(evalContext EvalContext, txn storage.Transaction, m
var pq rego.PreparedEvalQuery

evalContext.PreparedQueryDoOnce().Do(func() {
target := "rego"
if ec, ok := evalContext.(EvalContextWithTarget); ok {
target = ec.Target()
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels like a better approach. This also means that if we wanted to add something new, we would create a new interface ? But maybe there's no avoiding that 🤷‍♂️

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can have anonymous interfaces, we don't need to name it. We could do

if ec, ok := evalContext.(interface{ Target() string }); ok {
	target = ec.Target()
}

However, that'll make the assertion bit you've pointed at in the other comment impossible, I think. We'd need to find a way to get a similar assurance somehow, like with an extra test of some sort 🤔

opts = append(opts,
rego.Metrics(m),
rego.ParsedQuery(evalContext.ParsedQuery()),
rego.Compiler(evalContext.Compiler()),
rego.Store(evalContext.Store()),
rego.Transaction(txn),
rego.Runtime(evalContext.Runtime()))
rego.Runtime(evalContext.Runtime()),
rego.Target(target))

r := rego.New(opts...)

Expand Down
3 changes: 2 additions & 1 deletion examples/grpc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ SHELL:=bash
GRPCURL_IMAGE:=fullstorydev/grpcurl:v1.7.0
GRPCURL=docker run --network=host -i --rm -v $$(pwd)/testsrv.pb:/testsrv.pb $(GRPCURL_IMAGE) \
-d @ -plaintext -protoset /testsrv.pb 127.0.0.1:51051
EVAL_TARGET?=rego

all: testsrv.pb testsrv-image test-setup test test-teardown

Expand All @@ -14,7 +15,7 @@ testsrv.pb: testsrv/test.proto

.PHONY: test-setup
test-setup:
docker-compose up -d
EVAL_TARGET=$(EVAL_TARGET) docker-compose up -d

.PHONY: test-teardown
test-teardown:
Expand Down
5 changes: 3 additions & 2 deletions examples/grpc/docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@ services:
command:
- run
- --server
- --config-file=/opa.yaml
- --config-file=/opa-${EVAL_TARGET}.yaml
- /policy.rego
volumes:
- ./testsrv.pb:/testsrv.pb
- ./policy.rego:/policy.rego
- ./opa.yaml:/opa.yaml
- ./opa-wasm.yaml:/opa-wasm.yaml
- ./opa-rego.yaml:/opa-rego.yaml
testsrv:
image: testsrv:latest
ports:
Expand Down
0 examples/grpc/opa.yaml → examples/grpc/opa-rego.yaml
View file
Open in desktop
File renamed without changes.
10 changes: 10 additions & 0 deletions examples/grpc/opa-wasm.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
plugins:
envoy_ext_authz_grpc:
addr: ":9191"
path: envoy/authz/allow
dry-run: false
enable-reflection: true
proto-descriptor: /testsrv.pb
eval-target: wasm
decision_logs:
console: true
20 changes: 16 additions & 4 deletions internal/internal.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,13 @@ import (
"github.com/open-policy-agent/opa/util"
)

const defaultAddr = ":9191"
const defaultPath = "envoy/authz/allow"
const defaultDryRun = false
const defaultEnableReflection = false
const (
defaultAddr = ":9191"
defaultPath = "envoy/authz/allow"
defaultDryRun = false
defaultEnableReflection = false
defaultEvalTarget = "rego"
)

// PluginName is the name to register with the OPA plugin manager
const PluginName = "envoy_ext_authz_grpc"
Expand All @@ -58,6 +61,7 @@ func Validate(m *plugins.Manager, bs []byte) (*Config, error) {
Addr: defaultAddr,
DryRun: defaultDryRun,
EnableReflection: defaultEnableReflection,
EvalTarget: defaultEvalTarget,
}

if err := util.Unmarshal(bs, &cfg); err != nil {
Expand Down Expand Up @@ -133,6 +137,7 @@ type Config struct {
Path string `json:"path"`
DryRun bool `json:"dry-run"`
EnableReflection bool `json:"enable-reflection"`
EvalTarget string `json:"eval-target"`
parsedQuery ast.Body
ProtoDescriptor string `json:"proto-descriptor"`
protoSet *protoregistry.Files
Expand All @@ -147,6 +152,8 @@ type envoyExtAuthzGrpcServer struct {
interQueryBuiltinCache iCache.InterQueryCache
}

var _ envoyauth.EvalContextWithTarget = (*envoyExtAuthzGrpcServer)(nil)

type envoyExtAuthzV2Wrapper struct {
v3 *envoyExtAuthzGrpcServer
}
Expand All @@ -167,6 +174,10 @@ func (p *envoyExtAuthzGrpcServer) Runtime() *ast.Term {
return p.manager.Info
}

func (p *envoyExtAuthzGrpcServer) Target() string {
return p.cfg.EvalTarget
}

func (p *envoyExtAuthzGrpcServer) PreparedQueryDoOnce() *sync.Once {
return p.preparedQueryDoOnce
}
Expand Down Expand Up @@ -243,6 +254,7 @@ func (p *envoyExtAuthzGrpcServer) listen() {
"path": p.cfg.Path,
"dry-run": p.cfg.DryRun,
"enable-reflection": p.cfg.EnableReflection,
"eval-target": p.cfg.EvalTarget,
}).Info("Starting gRPC server.")

p.manager.UpdatePluginStatus(PluginName, &plugins.Status{State: plugins.StateOK})
Expand Down