Add comprehensive plugin usage examples for Docker, Kubernetes, and Swarm
- Introduced multiple detailed plugin examples for Cloudflare IP restoration, IP whitelisting, JWT validation, and combined usage. - Added configurations for `docker-compose`, `Kubernetes`, and `Swarm` showcasing individual and multi-plugin use cases. - Included clear prerequisites, setup steps, and testing procedures for each example. - Documented advanced scenarios like path blocking, custom IP lists, and JWT validation for production environments.
This commit is contained in:
Joao Gilberto Magalhaes
parent
06d1d447f8
commit
f75cb8aab2
15 changed files with 1977 additions and 0 deletions
|
|
@ -149,6 +149,217 @@ labels:
|
|||
|
||||
---
|
||||
|
||||
## Plugin Examples
|
||||
|
||||
### JWT Validator Plugin
|
||||
|
||||
Protect your API with JWT token validation:
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- ./jwt_pubkey.pem:/etc/haproxy/jwt_keys/api_pubkey.pem:ro
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
HAPROXY_USERNAME: admin
|
||||
HAPROXY_PASSWORD: password
|
||||
HAPROXY_STATS_PORT: 1936
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
- "443:443/tcp"
|
||||
- "1936:1936/tcp"
|
||||
|
||||
api:
|
||||
image: my-api:latest
|
||||
labels:
|
||||
easyhaproxy.http.host: api.example.com
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
# Enable JWT validation
|
||||
easyhaproxy.http.plugins: jwt_validator
|
||||
easyhaproxy.http.plugin.jwt_validator.algorithm: RS256
|
||||
easyhaproxy.http.plugin.jwt_validator.issuer: https://auth.example.com/
|
||||
easyhaproxy.http.plugin.jwt_validator.audience: https://api.example.com
|
||||
easyhaproxy.http.plugin.jwt_validator.pubkey_path: /etc/haproxy/jwt_keys/api_pubkey.pem
|
||||
```
|
||||
|
||||
**What it validates:**
|
||||
- Authorization header presence
|
||||
- JWT signing algorithm
|
||||
- JWT issuer and audience
|
||||
- JWT signature using public key
|
||||
- JWT expiration time
|
||||
|
||||
**Test:**
|
||||
```bash
|
||||
# Without token - should fail
|
||||
curl http://api.example.com/endpoint
|
||||
# Response: Missing Authorization HTTP header
|
||||
|
||||
# With valid JWT token
|
||||
curl -H "Authorization: Bearer eyJhbGc..." http://api.example.com/endpoint
|
||||
# Response: Success
|
||||
```
|
||||
|
||||
**Generate test public key:**
|
||||
```bash
|
||||
# Generate private key
|
||||
openssl genrsa -out jwt_private.pem 2048
|
||||
|
||||
# Extract public key
|
||||
openssl rsa -in jwt_private.pem -pubout -out jwt_pubkey.pem
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Cloudflare IP Restoration Plugin
|
||||
|
||||
Restore original visitor IPs when using Cloudflare CDN:
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- ./cloudflare_ips.lst:/etc/haproxy/cloudflare_ips.lst:ro
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
- "443:443/tcp"
|
||||
|
||||
webapp:
|
||||
image: my-webapp:latest
|
||||
labels:
|
||||
easyhaproxy.http.host: myapp.com
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 3000
|
||||
# Enable Cloudflare plugin
|
||||
easyhaproxy.http.plugins: cloudflare
|
||||
```
|
||||
|
||||
**Setup Cloudflare IP list:**
|
||||
```bash
|
||||
# Download Cloudflare IP ranges
|
||||
curl https://www.cloudflare.com/ips-v4 > cloudflare_ips.lst
|
||||
curl https://www.cloudflare.com/ips-v6 >> cloudflare_ips.lst
|
||||
```
|
||||
|
||||
**What it does:**
|
||||
- Detects requests from Cloudflare IPs
|
||||
- Restores original visitor IP from `CF-Connecting-IP` header
|
||||
- Your application logs show real visitor IPs, not Cloudflare IPs
|
||||
|
||||
---
|
||||
|
||||
### IP Whitelist Plugin
|
||||
|
||||
Restrict access to specific IP addresses:
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
|
||||
admin_panel:
|
||||
image: admin-panel:latest
|
||||
labels:
|
||||
easyhaproxy.http.host: admin.example.com
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
# Enable IP whitelist
|
||||
easyhaproxy.http.plugins: ip_whitelist
|
||||
easyhaproxy.http.plugin.ip_whitelist.allowed_ips: 192.168.1.0/24,10.0.0.5
|
||||
easyhaproxy.http.plugin.ip_whitelist.status_code: 403
|
||||
```
|
||||
|
||||
**Allowed IP formats:**
|
||||
- Single IP: `10.0.0.5`
|
||||
- CIDR range: `192.168.1.0/24`
|
||||
- Multiple (comma-separated): `192.168.1.0/24,10.0.0.5,172.16.0.100`
|
||||
|
||||
**Test:**
|
||||
```bash
|
||||
# From allowed IP
|
||||
curl http://admin.example.com
|
||||
# Response: Success
|
||||
|
||||
# From blocked IP
|
||||
curl http://admin.example.com
|
||||
# Response: HTTP 403 Forbidden
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Multiple Plugins Combined
|
||||
|
||||
Combine multiple plugins for enhanced security:
|
||||
|
||||
```yaml
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- ./cloudflare_ips.lst:/etc/haproxy/cloudflare_ips.lst:ro
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
- "443:443/tcp"
|
||||
|
||||
webapp:
|
||||
image: webapp:latest
|
||||
labels:
|
||||
easyhaproxy.http.host: myapp.example.com
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
# Enable multiple plugins
|
||||
easyhaproxy.http.plugins: cloudflare,deny_pages
|
||||
# Block specific paths
|
||||
easyhaproxy.http.plugin.deny_pages.paths: /admin,/wp-admin,/wp-login.php,/.env
|
||||
easyhaproxy.http.plugin.deny_pages.status_code: 404
|
||||
|
||||
api:
|
||||
image: api:latest
|
||||
labels:
|
||||
easyhaproxy.http.host: api.example.com
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 3000
|
||||
# Combine JWT + IP whitelist + path blocking
|
||||
easyhaproxy.http.plugins: jwt_validator,ip_whitelist,deny_pages
|
||||
easyhaproxy.http.plugin.jwt_validator.algorithm: RS256
|
||||
easyhaproxy.http.plugin.jwt_validator.issuer: https://auth.example.com/
|
||||
easyhaproxy.http.plugin.jwt_validator.pubkey_path: /etc/haproxy/jwt_keys/api.pem
|
||||
easyhaproxy.http.plugin.ip_whitelist.allowed_ips: 192.168.0.0/16,10.0.0.0/8
|
||||
easyhaproxy.http.plugin.deny_pages.paths: /internal,/debug
|
||||
```
|
||||
|
||||
**Plugin execution order:**
|
||||
1. IP Whitelist (blocks non-whitelisted IPs)
|
||||
2. Deny Pages (blocks specific paths)
|
||||
3. JWT Validator (validates authentication)
|
||||
|
||||
---
|
||||
|
||||
## Common Configuration Options
|
||||
|
||||
### Environment Variables (HAProxy Container)
|
||||
|
|
|
|||
60
examples/docker/docker-compose-cloudflare.yml
Normal file
60
examples/docker/docker-compose-cloudflare.yml
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# Cloudflare IP Restoration Plugin Example
|
||||
#
|
||||
# This example demonstrates restoring original visitor IPs when using Cloudflare CDN
|
||||
#
|
||||
# Prerequisites:
|
||||
# 1. Download Cloudflare IP ranges:
|
||||
# curl https://www.cloudflare.com/ips-v4 > cloudflare_ips.lst
|
||||
# curl https://www.cloudflare.com/ips-v6 >> cloudflare_ips.lst
|
||||
#
|
||||
# 2. Add to /etc/hosts:
|
||||
# 127.0.0.1 myapp.local
|
||||
#
|
||||
# 3. Start the stack:
|
||||
# docker compose -f docker-compose-cloudflare.yml up -d
|
||||
#
|
||||
# 4. Test (simulating Cloudflare request):
|
||||
# # Without CF-Connecting-IP header:
|
||||
# curl -H "Host: myapp.local" http://127.0.0.1/
|
||||
#
|
||||
# # With CF-Connecting-IP header (simulating Cloudflare):
|
||||
# curl -H "Host: myapp.local" -H "CF-Connecting-IP: 203.0.113.50" http://127.0.0.1/
|
||||
#
|
||||
# Note: This plugin is most useful when your site is actually behind Cloudflare.
|
||||
# Without Cloudflare, the request won't come from Cloudflare IPs, so the plugin
|
||||
# won't activate. This example is for demonstration and testing purposes.
|
||||
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
# Mount Cloudflare IP list
|
||||
- ./cloudflare_ips.lst:/etc/haproxy/cloudflare_ips.lst:ro
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
HAPROXY_CUSTOMERRORS: "true"
|
||||
HAPROXY_USERNAME: admin
|
||||
HAPROXY_PASSWORD: password
|
||||
HAPROXY_STATS_PORT: 1936
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
- "1936:1936/tcp"
|
||||
|
||||
# Web application behind Cloudflare
|
||||
webapp:
|
||||
image: byjg/static-httpserver
|
||||
environment:
|
||||
TITLE: "App Behind Cloudflare"
|
||||
labels:
|
||||
easyhaproxy.http.host: myapp.local
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
|
||||
# Enable Cloudflare plugin
|
||||
easyhaproxy.http.plugins: cloudflare
|
||||
|
||||
# Optional: Specify custom IP list path
|
||||
# easyhaproxy.http.plugin.cloudflare.ip_list_path: /etc/haproxy/cloudflare_ips.lst
|
||||
57
examples/docker/docker-compose-ip-whitelist.yml
Normal file
57
examples/docker/docker-compose-ip-whitelist.yml
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
# IP Whitelist Plugin Example
|
||||
#
|
||||
# This example demonstrates restricting access to specific IP addresses
|
||||
#
|
||||
# Prerequisites:
|
||||
# 1. Add to /etc/hosts:
|
||||
# 127.0.0.1 admin.local
|
||||
#
|
||||
# 2. Start the stack:
|
||||
# docker compose -f docker-compose-ip-whitelist.yml up -d
|
||||
#
|
||||
# 3. Test from localhost (127.0.0.1 is whitelisted):
|
||||
# curl http://admin.local/
|
||||
# # Response: Success (200 OK)
|
||||
#
|
||||
# 4. Test from non-whitelisted IP:
|
||||
# # You'll need to test from another machine or configure the example
|
||||
# # with your actual IP address in the allowed_ips label
|
||||
#
|
||||
# Note: Update the allowed_ips label with your actual IP addresses/networks
|
||||
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
HAPROXY_CUSTOMERRORS: "true"
|
||||
HAPROXY_USERNAME: admin
|
||||
HAPROXY_PASSWORD: password
|
||||
HAPROXY_STATS_PORT: 1936
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
- "1936:1936/tcp"
|
||||
|
||||
# Admin panel with IP whitelist
|
||||
admin:
|
||||
image: byjg/static-httpserver
|
||||
environment:
|
||||
TITLE: "Admin Panel - IP Restricted"
|
||||
labels:
|
||||
easyhaproxy.http.host: admin.local
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
|
||||
# Enable IP whitelist plugin
|
||||
easyhaproxy.http.plugins: ip_whitelist
|
||||
|
||||
# Allow localhost and private networks
|
||||
# UPDATE THIS with your actual IPs/networks!
|
||||
easyhaproxy.http.plugin.ip_whitelist.allowed_ips: 127.0.0.1,192.168.0.0/16,10.0.0.0/8,172.16.0.0/12
|
||||
|
||||
# Status code to return for blocked IPs
|
||||
easyhaproxy.http.plugin.ip_whitelist.status_code: 403
|
||||
66
examples/docker/docker-compose-jwt-validator.yml
Normal file
66
examples/docker/docker-compose-jwt-validator.yml
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
# JWT Validator Plugin Example
|
||||
#
|
||||
# This example demonstrates JWT token validation for API protection
|
||||
#
|
||||
# Prerequisites:
|
||||
# 1. Generate RSA key pair:
|
||||
# openssl genrsa -out jwt_private.pem 2048
|
||||
# openssl rsa -in jwt_private.pem -pubout -out jwt_pubkey.pem
|
||||
#
|
||||
# 2. Add to /etc/hosts:
|
||||
# 127.0.0.1 api.local
|
||||
#
|
||||
# 3. Start the stack:
|
||||
# docker compose -f docker-compose-jwt-validator.yml up -d
|
||||
#
|
||||
# 4. Test without token (should fail):
|
||||
# curl http://api.local/
|
||||
# # Response: Missing Authorization HTTP header
|
||||
#
|
||||
# 5. Generate test JWT at https://jwt.io with:
|
||||
# - Algorithm: RS256
|
||||
# - Payload: {"iss":"https://auth.example.com/","aud":"https://api.example.com","exp":9999999999}
|
||||
# - Use your jwt_private.pem for signing
|
||||
#
|
||||
# 6. Test with token:
|
||||
# TOKEN="eyJhbGc..."
|
||||
# curl -H "Authorization: Bearer $TOKEN" http://api.local/
|
||||
# # Response: Success
|
||||
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
# Mount the public key for JWT verification
|
||||
- ./jwt_pubkey.pem:/etc/haproxy/jwt_keys/api_pubkey.pem:ro
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
HAPROXY_CUSTOMERRORS: "true"
|
||||
HAPROXY_USERNAME: admin
|
||||
HAPROXY_PASSWORD: password
|
||||
HAPROXY_STATS_PORT: 1936
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
- "1936:1936/tcp"
|
||||
|
||||
# API service protected by JWT
|
||||
api:
|
||||
image: byjg/static-httpserver
|
||||
environment:
|
||||
TITLE: "Protected API - JWT Required"
|
||||
labels:
|
||||
easyhaproxy.http.host: api.local
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
|
||||
# Enable JWT validator plugin
|
||||
easyhaproxy.http.plugins: jwt_validator
|
||||
|
||||
# JWT validator configuration
|
||||
easyhaproxy.http.plugin.jwt_validator.algorithm: RS256
|
||||
easyhaproxy.http.plugin.jwt_validator.issuer: https://auth.example.com/
|
||||
easyhaproxy.http.plugin.jwt_validator.audience: https://api.example.com/
|
||||
easyhaproxy.http.plugin.jwt_validator.pubkey_path: /etc/haproxy/jwt_keys/api_pubkey.pem
|
||||
106
examples/docker/docker-compose-plugins-combined.yml
Normal file
106
examples/docker/docker-compose-plugins-combined.yml
Normal file
|
|
@ -0,0 +1,106 @@
|
|||
# Multiple Plugins Combined Example
|
||||
#
|
||||
# This example demonstrates using multiple plugins together for enhanced security
|
||||
#
|
||||
# Prerequisites:
|
||||
# 1. Generate JWT keys:
|
||||
# openssl genrsa -out jwt_private.pem 2048
|
||||
# openssl rsa -in jwt_private.pem -pubout -out jwt_pubkey.pem
|
||||
#
|
||||
# 2. Download Cloudflare IPs:
|
||||
# curl https://www.cloudflare.com/ips-v4 > cloudflare_ips.lst
|
||||
# curl https://www.cloudflare.com/ips-v6 >> cloudflare_ips.lst
|
||||
#
|
||||
# 3. Add to /etc/hosts:
|
||||
# 127.0.0.1 website.local api.local admin.local
|
||||
#
|
||||
# 4. Start the stack:
|
||||
# docker compose -f docker-compose-plugins-combined.yml up -d
|
||||
#
|
||||
# 5. Test each service:
|
||||
# # Public website (Cloudflare + path blocking)
|
||||
# curl http://website.local/
|
||||
# curl http://website.local/admin # Should be blocked (404)
|
||||
#
|
||||
# # Protected API (JWT required)
|
||||
# curl http://api.local/ # Should fail - no JWT
|
||||
# curl -H "Authorization: Bearer <token>" http://api.local/ # Success
|
||||
#
|
||||
# # Admin panel (IP whitelist only)
|
||||
# curl http://admin.local/ # Success from localhost
|
||||
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
haproxy:
|
||||
image: byjg/easy-haproxy:4.6.0
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- ./cloudflare_ips.lst:/etc/haproxy/cloudflare_ips.lst:ro
|
||||
- ./jwt_pubkey.pem:/etc/haproxy/jwt_keys/api_pubkey.pem:ro
|
||||
environment:
|
||||
EASYHAPROXY_DISCOVER: docker
|
||||
HAPROXY_CUSTOMERRORS: "true"
|
||||
HAPROXY_USERNAME: admin
|
||||
HAPROXY_PASSWORD: password
|
||||
HAPROXY_STATS_PORT: 1936
|
||||
ports:
|
||||
- "80:80/tcp"
|
||||
- "1936:1936/tcp"
|
||||
|
||||
# Public website with Cloudflare + path blocking
|
||||
website:
|
||||
image: byjg/static-httpserver
|
||||
environment:
|
||||
TITLE: "Public Website"
|
||||
labels:
|
||||
easyhaproxy.http.host: website.local
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
|
||||
# Combine Cloudflare IP restoration + deny pages
|
||||
easyhaproxy.http.plugins: cloudflare,deny_pages
|
||||
|
||||
# Block admin paths, config files, etc.
|
||||
easyhaproxy.http.plugin.deny_pages.paths: /admin,/wp-admin,/wp-login.php,/.env,/config
|
||||
easyhaproxy.http.plugin.deny_pages.status_code: 404
|
||||
|
||||
# Protected API with JWT validation + path blocking
|
||||
api:
|
||||
image: byjg/static-httpserver
|
||||
environment:
|
||||
TITLE: "Protected API"
|
||||
labels:
|
||||
easyhaproxy.http.host: api.local
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
|
||||
# JWT validation + block internal endpoints
|
||||
easyhaproxy.http.plugins: jwt_validator,deny_pages
|
||||
|
||||
# JWT configuration
|
||||
easyhaproxy.http.plugin.jwt_validator.algorithm: RS256
|
||||
easyhaproxy.http.plugin.jwt_validator.issuer: https://auth.example.com/
|
||||
easyhaproxy.http.plugin.jwt_validator.audience: https://api.example.com
|
||||
easyhaproxy.http.plugin.jwt_validator.pubkey_path: /etc/haproxy/jwt_keys/api_pubkey.pem
|
||||
|
||||
# Block internal/debug endpoints
|
||||
easyhaproxy.http.plugin.deny_pages.paths: /internal,/debug,/metrics
|
||||
easyhaproxy.http.plugin.deny_pages.status_code: 403
|
||||
|
||||
# Admin panel with strict IP restrictions
|
||||
admin:
|
||||
image: byjg/static-httpserver
|
||||
environment:
|
||||
TITLE: "Admin Panel"
|
||||
labels:
|
||||
easyhaproxy.http.host: admin.local
|
||||
easyhaproxy.http.port: 80
|
||||
easyhaproxy.http.localport: 8080
|
||||
|
||||
# IP whitelist only (strictest security)
|
||||
easyhaproxy.http.plugins: ip_whitelist
|
||||
|
||||
# Only allow local and private networks
|
||||
easyhaproxy.http.plugin.ip_whitelist.allowed_ips: 127.0.0.1,192.168.0.0/16,10.0.0.0/8
|
||||
easyhaproxy.http.plugin.ip_whitelist.status_code: 403
|
||||
Loading…
Add table
Add a link
Reference in a new issue