embesozzi / kong-plugin-opa

Integration of the Open Policy Agent (OPA) with the Kong API Gateway

API Authorization with OPA and Kong

⚠️ NOTE

The kong-plugin-opa has been released to the OPA community and can be found in the OPA contrib repository. This repository maps to the kong_api_authz subdirectory and its only purpose is to provide a CI pipeline that run tests and publish the rock on Luarocks.

To map that subdirectory, the master branch has to be replaced by a new one. The old master branch has been renamed precontrib-master. The new master branch is kind of a fork of the kong_api_authz directory from the contrib repository.

• Contributing

If you want to contribute, with bug fixes, new features or improvements, please feel free to submit a Pull Request in the contrib repository.

If you want to update the CI pipeline, create a Pull Request and specify the master branch to merge your changes. DO NOT merge into the upstream-kong-plugin-opa branch, it should only contains commits from the [contib] repository.

• Pulling commits from upstream

From https://stackoverflow.com/a/24577293

First, you need to pull the master branch from the contrib repository:

1. Add the contrib repository. We're going to name it upstream

   $ git remote add upstream https://github.com/open-policy-agent/contrib.git
   

2. Create (or update) the upstream-master branch to track remote master branch from upstream

   $ git fetch --all
   $ git checkout upstream/master -B upstream-master
   

Next, we need to update upstream-kong-api-authz branch:

1. From upstream-master branch (where you should already be if you followed previous steps), filter commits related to kong_api_authz subdirectory.

   git subtree split \
   --prefix=kong_api_authz \
   --onto upstream-kong-api-authz
   

Finally, rebase origin/master on upstream-kong-api-authz

   git checkout master
   git rebase upstream-kong-api-authz

---

This directory contains a plugin to integrate OPA with Kong API Gateway to perform API authorization.

The plugin can be enabled on a Service or Route to authorize access to an upstream service.

This plugin does not verify authentication; it requires an authentication plugin enabled on the Service or Route.

This plugin will:

• authorize access to the upstream service when the policy evaluate successfully
• respond with 403 forbidden on policy evaluation failure
• respond with a 500 Internal Server Error on unexcepted error

Basic Sequence Diagram

---

Terminology

• plugin: a plugin executing actions inside Kong before or after a request has been proxied to the upstream API.
• Service: the Kong entity representing an external upstream API or microservice.
• Route: the Kong entity representing a way to map downstream requests to upstream services.
• Upstream service: this refers to your own API/service sitting behind Kong, to which client requests are forwarded.

Configuration

This plugin is compatible with requests with the following protocols:

• http
• https

This plugin is compatible with DB-less mode.

Enabling the plugin on a Service

With a database

Configure this plugin on a Service with:

$ curl -i -X POST http://kong:8001/services/{service}/plugins/ \
--data 'name=opa' \
--data 'config.server.host=opa' \
--data 'config.policy.decision=httpapi/authz/allow'

Without a database

Configure this plugin on a Service by adding this section to your declarative configuration file:

plugins:
    - name: opa
      service: {service}
      config:
        server:
            host: opa
        policy:
            decision: httpapi/authz/allow

{service} is the id or name of the Service that this plugin configuration will target.

Enabling the plugin on a Route

With a database

Configure this plugin on a Route with:

$ curl -i -X POST http://kong:8001/routes/{route}/plugins/ \
--data 'name=opa' \
--data 'config.server.host=opa' \
--data 'config.policy.decision=httpapi/authz/allow'

Without a database

Configure this plugin on a Route by adding this section to your declarative configuration file:

plugins:
    - name: opa
      route: {route}
      config:
        server:
            host: opa
        policy:
            decision: httpapi/authz/allow

{route} is the id or name of the Route that this plugin configuration will target.

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration:

required fields are in bold

form parameter	default	description
config.server.protocol	http	The communication protocol to use with OPA Server (http or https)
config.server.host	localhost	The OPA DNS or IP address
config.server.port	8181	The port on wich OPA is listening
config.server.connection.timeout	60	For the connection with the OPA server: the maximal idle timeout (ms)
config.server.connection.pool	10	For the connection with the OPA server: the maximum number of connections in the pool
config.policy.base_path	v1/data	The OPA DATA API base path
config.policy.decision		The path to the OPA rule to evaluate

---

Makefile

Prerequisites

• docker: to compile and test the plugin in a container.
• docker-compose: to run integration tests with Kong and OPA services.

Usage

The following list is all targets present in the Makefile:

target	description
all	Execute the whole lifecycle: check, build, test, verify
check	Analyze code quality
build	Build package in current directory using the rockspec
test	Run all unit tests
verify	Run integration tests
clean	Delete all files that are created by running make, including docker images
mostlyclean	Like ‘clean’, but do not delete the Docker image built to run other commands
push	builds a Kong image with the kong-plugin-opa installed and publishes it

---

Folder structure

• ./.devcontainer contains a Docker image that provide a development container with Lua and Luarocks.

  This image is used by Makefile commands.

  For VS Code users, it contains also the configuration to make VS Code access (or create) the container. luarocks and luacheck commands can then be ran directly from a VS Code terminal.

  (Note: switching between local and in-container commands requires to delete files generated by luarocks init since the initialization configure the path to lua_modules - this can be done locally with make mostlyclean)

• ./doc contains assets for the README

• ./integration contains:

  • a docker-compose example that includes the following services:
    • kong with the kong-plugin-opa installed
    • db the postgres database used by kong
    • kong-migration to boostrap de database
    • opa running as a server
  • a docker-compose for automated tests, that:
    • creates the sut service that will run a postman collection to test the integration
    • configures kong to run in DB-less mode with a declarative Kong configuration that setup a Service, Route and enable the plugin
    • loads a simple policies bundle in opa service
    • creates an Httpbin service to mock the target upstream service

• ./spec contains unit tests

• ./src contains the plugin source code