Bearer Kong Plugin

Bearer helps security teams remediate security and compliance risks by discovering, managing, and securing their API usage.

The Bearer Kong plugin allows you:

• Instantly catalog your APIs.
• Automatically map data flows to and from your APIs.

The plugin leverages an asynchronous design to minimize its impact on the latency of your API calls. It has low CPU and memory consumption.

If you need help with installation, drop us a line at [email protected] or contact us here.

Installation

How it works

The Bearer Kong plugin captures API traffic from Kong API Gateway and sends it to a local Bearer agent for analysis.

How to install

If the luarocks utility is installed in your system (this is likely the case if you used one of the official installation packages), you can install the 'rock' in your LuaRocks tree (a directory in which LuaRocks installs Lua modules).

To install the plugin using the LuaRocks repository run:

luarocks install kong-plugin-bearer

For alternative installation methods see here.

How to enable

Add bearer to the plugins value in kong.conf:

plugins = bundled,bearer

or to the KONG_PLUGINS environment variable:

$ export KONG_PLUGINS=bundled,bearer

Development

Building a Rock

$ luarocks --lua-dir <path_to_luajit> build --pack-binary-rock

Releasing

Update the tag, version and filename of the .rockspec, and create a corresponding Github release.

To upload the rock, you need a JSON library installed:

$ luarocks install dkjson

To upload the rock:

$ luarocks --lua-dir <path_to_luajit> upload --api-key=<api_key> kong-plugin-bearer-<version>-1.rockspec