IP Restriction

Restrict access to a Service or a Route by either whitelisting or blacklisting IP addresses. Single IPs, multiple IPs or ranges in CIDR notation like 10.10.10.0/24 can be used. The plugin supports IPv4 and IPv6 addresses.

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=ip-restriction"  \
    --data "config.whitelist=54.13.21.1" \
    --data "config.whitelist=143.1.0.0/24"

plugins:
- name: ip-restriction
  service: {service}
  config: 
    whitelist:
    - 54.13.21.1
    - 143.1.0.0/24

{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=ip-restriction"  \
    --data "config.whitelist=54.13.21.1" \
    --data "config.whitelist=143.1.0.0/24"

plugins:
- name: ip-restriction
  route: {route}
  config: 
    whitelist:
    - 54.13.21.1
    - 143.1.0.0/24

{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=ip-restriction"  \
    --data "config.whitelist=54.13.21.1" \
    --data "config.whitelist=143.1.0.0/24"

plugins:
- name: ip-restriction
  consumer: {consumer}
  config: 
    whitelist:
    - 54.13.21.1
    - 143.1.0.0/24

{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:

A whitelist provides a positive security model, in which the configured CIDR ranges are allowed access to the resource, and all others are inherently rejected. By contrast, a blacklist configuration provides a negative security model, in which certain CIDRS are explicitly denied access to the resource (and all others are inherently allowed).

You can configure the plugin with both whitelist and blacklist configurations. An interesting use case of this flexibility is to whitelist a CIDR range, but blacklist an IP address on that CIDR range:

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=ip-restriction" \
    --data "config.whitelist=127.0.0.0/24" \
    --data "config.blacklist=127.0.0.1"