Brute force protection with Redisv3.13+
Protect against brute force attacks by enabling config.brute_force_protection and the redis strategy.
This will return an 429 Too Many Requests error after the fourth failed login attempt.
For a complete tutorial, see Protect against brute force attacks with basic authentication.
Environment variables
-
REDIS_HOST -
REDIS_PASSWORD
The Basic Auth plugin needs a Consumer with a credential attached before it can authenticate requests.
The following creates the Consumer and attaches the credential in one document:
_format_version: "3.0"
consumers:
- username: alex
basicauth_credentials:
- username: alex
password: hello_worldThe Basic Auth plugin needs a Consumer with a credential attached before it can authenticate requests.
Create the Consumer:
curl -i -X POST http://localhost:8001/consumers/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"username": "alex"
}
'Attach the basic-auth credential:
curl -i -X POST http://localhost:8001/consumers/alex/basic-auth \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"username": "alex",
"password": "hello_world"
}
'The Basic Auth plugin needs a Consumer with a credential attached before it can authenticate requests.
Create the Consumer:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"username": "alex"
}
'Attach the basic-auth credential:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/alex/basic-auth \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"username": "alex",
"password": "hello_world"
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane.
See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
The Basic Auth plugin needs a Consumer with a credential attached before it can authenticate requests.
Create a Secret labeled with the basic-auth credential type:
apiVersion: v1
kind: Secret
metadata:
name: alex-basic-auth
namespace: kong
labels:
konghq.com/credential: basic-auth
stringData:
username: alex
password: hello_worldCreate the KongConsumer and reference the Secret:
apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
name: alex
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
username: alex
credentials:
- alex-basic-authThe Basic Auth plugin needs a Consumer with a credential attached before it can authenticate requests.
Add the following to your Terraform configuration to create the Consumer and the credential:
resource "konnect_gateway_consumer" "my_consumer" {
username = "alex"
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
resource "konnect_gateway_basic_auth" "my_basic_auth" {
consumer_id = konnect_gateway_consumer.my_consumer.id
username = "alex"
password = "hello_world"
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: basic-auth
config:
brute_force_protection:
strategy: redis
redis:
host: ${{ env "DECK_REDIS_HOST" }}
port: 6379
database: 0
timeout: 2000
ssl: false
ssl_verify: falseMake the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "basic-auth",
"config": {
"brute_force_protection": {
"strategy": "redis",
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379,
"database": 0,
"timeout": 2000,
"ssl": false,
"ssl_verify": false
}
}
}
}
'Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "basic-auth",
"config": {
"brute_force_protection": {
"strategy": "redis",
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379,
"database": 0,
"timeout": 2000,
"ssl": false,
"ssl_verify": false
}
}
}
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane.
See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: basic-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
labels:
global: 'true'
config:
brute_force_protection:
strategy: redis
redis:
host: '$REDIS_HOST'
port: 6379
database: 0
timeout: 2000
ssl: false
ssl_verify: false
plugin: basic-auth
" | kubectl apply -f -Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_basic_auth" "my_basic_auth" {
enabled = true
config = {
brute_force_protection = {
strategy = "redis"
redis = {
host = var.redis_host
port = 6379
database = 0
timeout = 2000
ssl = false
ssl_verify = false
}
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "redis_host" {
type = string
}
variable "redis_password" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: basic-auth
service: serviceName|Id
config:
brute_force_protection:
strategy: redis
redis:
host: ${{ env "DECK_REDIS_HOST" }}
port: 6379
database: 0
timeout: 2000
ssl: false
ssl_verify: falseMake sure to replace the following placeholders with your own values:
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "basic-auth",
"config": {
"brute_force_protection": {
"strategy": "redis",
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379,
"database": 0,
"timeout": 2000,
"ssl": false,
"ssl_verify": false
}
}
}
}
'Make sure to replace the following placeholders with your own values:
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "basic-auth",
"config": {
"brute_force_protection": {
"strategy": "redis",
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379,
"database": 0,
"timeout": 2000,
"ssl": false,
"ssl_verify": false
}
}
}
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
serviceId: Theidof the service the plugin configuration will target.
See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: basic-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
brute_force_protection:
strategy: redis
redis:
host: '$REDIS_HOST'
port: 6379
database: 0
timeout: 2000
ssl: false
ssl_verify: false
plugin: basic-auth
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=basic-authPrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_basic_auth" "my_basic_auth" {
enabled = true
config = {
brute_force_protection = {
strategy = "redis"
redis = {
host = var.redis_host
port = 6379
database = 0
timeout = 2000
ssl = false
ssl_verify = false
}
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "redis_host" {
type = string
}
variable "redis_password" {
type = string
}Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: basic-auth
route: routeName|Id
config:
brute_force_protection:
strategy: redis
redis:
host: ${{ env "DECK_REDIS_HOST" }}
port: 6379
database: 0
timeout: 2000
ssl: false
ssl_verify: falseMake sure to replace the following placeholders with your own values:
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "basic-auth",
"config": {
"brute_force_protection": {
"strategy": "redis",
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379,
"database": 0,
"timeout": 2000,
"ssl": false,
"ssl_verify": false
}
}
}
}
'Make sure to replace the following placeholders with your own values:
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "basic-auth",
"config": {
"brute_force_protection": {
"strategy": "redis",
"redis": {
"host": "'$REDIS_HOST'",
"port": 6379,
"database": 0,
"timeout": 2000,
"ssl": false,
"ssl_verify": false
}
}
}
}
'Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
controlPlaneId: Theidof the control plane. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: basic-auth
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
config:
brute_force_protection:
strategy: redis
redis:
host: '$REDIS_HOST'
port: 6379
database: 0
timeout: 2000
ssl: false
ssl_verify: false
plugin: basic-auth
" | kubectl apply -f -Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=basic-authkubectl annotate -n kong ingress konghq.com/plugins=basic-authPrerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_basic_auth" "my_basic_auth" {
enabled = true
config = {
brute_force_protection = {
strategy = "redis"
redis = {
host = var.redis_host
port = 6379
database = 0
timeout = 2000
ssl = false
ssl_verify = false
}
}
}
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.
variable "redis_host" {
type = string
}
variable "redis_password" {
type = string
}