Cleafy patented threat detection & protection technology protects web and mobile apps against the most advanced attacks from malware based on Man-In-The-Browser (MITB), Man-In-The-Middle (MITM), RAT-in-The-Browser, Mobile Overlay, SMS Grabbing and other vectors. Cleafy is client-less and does neither impact the user experience nor the endpoint performance. Cleafy is application-transparent and does not require any change to the monitored application. Cleafy smoothly integrates into any application delivery architecture, typically at ADC or API Gateway level. Cleafy plugin for Kong makes possible to leverage Cleafy in any Kong-powered architecture. For more details visit https://cleafy.com/resources.


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: the Kong entity representing a developer or machine using the API. When using Kong, a Consumer only communicates with Kong which proxies every call to the said upstream API.
  • 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.
  • API: a legacy entity used to represent your upstream services. Deprecated in favor of Services since CE 0.13.0 and EE 0.32.

Configuration

Enabling the plugin on a Service

Configure this plugin on a Service by making the following request:

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=cleafy"  \
    --data "config.api_address=http://cleafy.com"

  • service: the id or name of the Service that this plugin configuration will target.

Enabling the plugin on a Route

Configure this plugin on a Route with:

$ curl -X POST http://kong:8001/routes/{route_id}/plugins \
    --data "name=cleafy"  \
    --data "config.api_address=http://cleafy.com"

  • route_id: the id of the Route that this plugin configuration will target.

Enabling the plugin on a Consumer

You can use the http://localhost:8001/plugins endpoint to enable this plugin on specific Consumers:

$ curl -X POST http://kong:8001/plugins \
    --data "name=cleafy" \
    --data "consumer_id={consumer_id}"  \
    --data "config.api_address=http://cleafy.com"

Where consumer_id is the id of the Consumer we want to associate with this plugin.

You can combine consumer_id and service_id

in the same request, to furthermore narrow the scope of the plugin.

Enabling the plugin on an API

If you are using an older version of Kong with the legacy API entity (deprecated in favor of Services since CE 0.13.0 and EE 0.32.), you can configure this plugin on top of such an API by making the following request:

$ curl -X POST http://kong:8001/apis/{api}/plugins \
    --data "name=cleafy"  \
    --data "config.api_address=http://cleafy.com"

  • api: either id or name of the API that this plugin configuration will target.

Global plugins

All plugins can be configured using the http://kong:8001/plugins/ endpoint. 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.

Parameters

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

form parameterdefaultdescription
nameThe name of the plugin to use, in this case cleafy
service_idThe id of the Service which this plugin will target.
route_idThe id of the Route which this plugin will target.
enabledtrueWhether this plugin will be applied.
consumer_idThe id of the Consumer which this plugin will target.
api_idThe id of the API which this plugin will target. Note: The API Entity is deprecated in favor of Services since CE 0.13.0 and EE 0.32.
config.api_address

Specifies the URL pointing to the Cleafy API.

config.accept_encoding
optional

Specifies the type of encoding accepted from the backend server. This plugin does not support gzip-encoded requests.

Cleafy-Stream Kong plugin

Installation

Plugin installation mainly depends on where your Kong installation runs:

Standalone Installation

Once the .rock file has been obtained from your Cleafy distributor it can be installed using the luarocks package manager.

luarocks install cleafy-plugin-for-kong-VERSION.rock

Typical configuration (via curl)

Register Cleafy backend as a Kong service:

$ curl -i -X POST --url http://url-to-kong-api:8001/services/ --data 'name=cleafy'  --data 'url=<url-to-cleafy-api>'

Moreover, each application you want to manage via Kong must be registered as a service:

$ curl -i -X POST --url http://url-to-kong-api:8001/services/ --data 'name=app1'  --data 'url=<url-to-app1-application-server>'

For each application registered (Cleafy excluded) you must define two Kong routes: the first routing traffic to the application server and the second routing traffic to the Cleafy backend:

$ curl -i -X POST --url http://url-to-kong-api:8001/routes/ --data 'hosts[]=<hostname>' --data 'service.id=<cleafy-service-id>' --data 'paths[]=/<ingestion-prefix>'

$ curl -i -X POST --url http://url-to-kong-api:8001/routes/ --data 'hosts[]=<hostname>' --data 'service.id=<app-service-id>'

Then you must activate the stream plugin over each app-related route:

$ curl -i -X POST --url http://url-to-kong-api:8001/plugins/ --data 'name=stream' --data 'route_id=<app-route-id' --data 'config.api_address=<cleafy-api-address>' --data 'config.api_token=<ingestion-token>'