In order to give you better service, we use cookies. By continuing to use our website, you agree to the use of cookies as described in our Cookie Policy.

Skip to content
The Kong Gateway OSS and Enterprise docs are now combined!  —See the docs →
|
search
Plugin Hub
header icon

Upstream HTTP Basic Authentication

Kong Plugin to add HTTP Basic Authentication to the upstream request header.

Installation

  1. The LuaRocks package manager must be Installed.
  2. Kong must be Installed and you must be familiar with using and configuring Kong.
  3. Install the module kong-plugin-upstream-auth-basic. 
    luarocks install kong-plugin-upstream-auth-basic
  4. Add the custom plugin to the kong.conf file (e.g. /etc/kong/kong.conf) 
    custom_plugins = ...,upstream-auth-basic
  5. Restart kong

Configuration Reference

This plugin is not compatible with DB-less mode.

Enable the plugin on a service

Admin API
Kubernetes
Declarative (YAML)

For example, configure this plugin on a service by making the following request:

curl -X POST http://{HOST}:8001/services/{SERVICE}/plugins \
    --data "name=upstream-auth-basic"  \
    --data "config.username=kingkong" \
    --data "config.password=1-big-ape"

SERVICE is the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <upstream-auth-basic-example>
config: 
  username: kingkong
  password: 1-big-ape
plugin: upstream-auth-basic

Next, apply the KongPlugin resource to a Service by annotating the Service as follows:

apiVersion: v1
kind: Service
metadata:
  name: {SERVICE}
  labels:
    app: {SERVICE}
  annotations:
    konghq.com/plugins: <upstream-auth-basic-example>
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: {SERVICE}
  selector:
    app: {SERVICE}

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

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a service by adding this section to your declarative configuration file:

plugins:
- name: upstream-auth-basic
  service: {SERVICE}
  config: 
    username: kingkong
    password: 1-big-ape

SERVICE is the id or name of the service that this plugin configuration will target.

Enable the plugin on a route

Admin API
Kubernetes
Declarative (YAML)

For example, configure this plugin on a route with:

$ curl -X POST http://{HOST}:8001/routes/{ROUTE}/plugins \
    --data "name=upstream-auth-basic"  \
    --data "config.username=kingkong" \
    --data "config.password=1-big-ape"

ROUTE is the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: <upstream-auth-basic-example>
config: 
  username: kingkong
  password: 1-big-ape
plugin: upstream-auth-basic

Then, apply it to an ingress (Route or Routes) by annotating the ingress as follows:

apiVersion: networking/v1beta1
kind: Ingress
metadata:
  name: {ROUTE}
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: <upstream-auth-basic-example>
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          serviceName: echo
          servicePort: 80

ROUTE is the id or name of the route that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

For example, configure this plugin on a route by adding this section to your declarative configuration file:

plugins:
- name: upstream-auth-basic
  route: <route>
  config: 
    username: kingkong
    password: 1-big-ape

ROUTE is the id or name of the route that this plugin configuration will target.

Enable the plugin globally

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

Admin API
Kubernetes
Declarative (YAML)

For example, configure this plugin globally with:

$ curl -X POST http://{HOST}:8001/plugins/ \
    --data "name=upstream-auth-basic"  \
    --data "config.username=kingkong" \
    --data "config.password=1-big-ape"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-upstream-auth-basic>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  username: kingkong
  password: 1-big-ape
plugin: upstream-auth-basic

For example, configure this plugin using the plugins: entry in the declarative configuration file:

plugins:
- name: upstream-auth-basic
  config: 
    username: kingkong
    password: 1-big-ape

Parameters

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

Form Parameter Description
name

Type: string

required		 The name of the plugin to use, in this case upstream-auth-basic.
service.id

Type: string		 The ID of the Service the plugin targets.
route.id

Type: string		 The ID of the Route the plugin targets.
enabled

Type: boolean

required

Default value: true		 Whether this plugin will be applied.
api_id

Type: string		 The ID of the API the plugin targets.

Note: The API Entity is deprecated in favor of Services since CE 0.13.0 and EE 0.32.
config.username
required

The username to send in the Authorization header to the upstream service
config.password
required

The password to send in the Authorization header to the upstream service