You can use the Kong Path Allow plugin on a Service, Route, or Consumer with paths. The plugin will check if the path is in the path allow list, and if not, return a 403.

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.
• Consumer: an entity that makes requests for Kong to proxy; it represents either a user or an external service.
• Credential: a unique string associated with a Consumer, also referred to as an API key.
• 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

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=kong-path-allow"  \
    --data "config.allow_paths=/api/services" \
    --data "config.allow_paths=/api/routes" \
    --data "config.regex=true"

plugins:
- name: kong-path-allow
  service: {service}
  config: 
    allow_paths:
    - /api/services
    - /api/routes
    regex: true

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

Enabling the plugin on a Route

$ curl -X POST http://kong:8001/routes/{route}/plugins \
    --data "name=kong-path-allow"  \
    --data "config.allow_paths=/api/services" \
    --data "config.allow_paths=/api/routes" \
    --data "config.regex=true"

plugins:
- name: kong-path-allow
  route: {route}
  config: 
    allow_paths:
    - /api/services
    - /api/routes
    regex: true

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

Enabling the plugin on a Consumer

$ curl -X POST http://kong:8001/consumers/{consumer}/plugins \
    --data "name=kong-path-allow"  \
    --data "config.allow_paths=/api/services" \
    --data "config.allow_paths=/api/routes" \
    --data "config.regex=true"

plugins:
- name: kong-path-allow
  consumer: {consumer}
  config: 
    allow_paths:
    - /api/services
    - /api/routes
    regex: true

{consumer} is the id or username of the Consumer that this plugin configuration will target.

You can combine consumer.id and service.id in the same request, to further narrow the scope of the plugin.

Global plugins

A plugin which is not associated to any Service, Route, or Consumer (or API, if you are using an older version of Kong) is considered "global", and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

• Using a database, all plugins can be configured using the http://kong:8001/plugins/ endpoint.
• Without a database, all plugins can be configured via the plugins: entry on the declarative configuration file.

Parameters

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

Install

Luarocks

luarocks install kong-path-allow

Source Code

$ git clone https://github.com/seifchen/kong-path-allow.git
$ cd /path/to/kong/plugins/kong-path-allow
$ luarocks make *.rockspec

See the README in the plugin source repository for more usage examples.

Maintainers

seifchen