/opa-http-api-example-kotlin

A simple example showing how to restrict a custom HTTP API using the Open Policy Agent.

Primary LanguageKotlinMIT LicenseMIT

Open Policy Agent HTTP API example

Open Policy Agent Kotlin

A minimalistic example of restricting an HTTP API with OPA

Get started

1. Start the API server (kotlin application)

./gradlew run

2. Start the OPA server (+ bundle server)

docker compose -f opa/docker-compose.yml up

3. Be the client - sample requests to the API server

Allowed

curl --user alice:password localhost:5000/finance/salary/alice

Forbidden

curl --user alice:password localhost:5000/finance/salary/charlie

What happens here?

On each HTTP request from a client to the API server, the API server asks the OPA server whether the requesting client is authorized to perform this action or not. Depending on the answer of OPA, the client request will be processed or rejected.

Policy / Bundle

Why does the OPA server knows about the permissions of a client? From the policy!

  • The policy is defined in the example-policy.rego file
  • From this file a bundle was built using the OPA executable
  • This bundle is persisted in and shipped from the bundle server to the OPA server

How to edit and apply the policy?

  1. Make changes to the policy file
  2. Download and install the Open Policy Agent. Tip: drop the opa executable to ~/.local/bin, so it is on the PATH.
  3. Build the policy and move the resulting bundle to the correct folder so that it can be collected by the bundle server 
    cd opa
opa build example-policy.rego
mv bundle.tar.gz bundles

References