Compare commits

..
57 Commits
Author SHA1 Message Date
Max Lerebourg c99a0ddc46 fix logger 2022-10-01 20:02:49 +02:00
Max Lerebourg f876458bb2 fix logger 2022-10-01 20:00:42 +02:00
Max Lerebourg 6c6a80efb4 fix 2022-10-01 19:44:06 +02:00
MathieuHa cc0261aa86 Add clean message when stream polling start 2022-10-01 19:42:22 +02:00
MathieuHa 465851b536 Fix name of docker volumes 2022-10-01 19:36:18 +02:00
maxlerebourg 9e92aeb449 Merge pull request #13 from maxlerebourg/fixMax
 fix loop
2022-10-01 19:33:09 +02:00
MathieuHa 37c7648854 Clean docker-compose and aquis.yaml 2022-10-01 19:28:09 +02:00
Max Lerebourg dd704d4274 fix 2022-10-01 19:23:20 +02:00
Max Lerebourg 1e4508f091 fix log 2022-10-01 19:18:12 +02:00
Max Lerebourg 89e8b5631e fix loop 2022-10-01 19:12:48 +02:00
Max Lerebourg 68adb31065 fix loop 2022-10-01 19:09:22 +02:00
mathieuHa 1ebde35693 Update README.md 2022-09-30 21:54:51 +02:00
mathieuHa 26913c5f7e Update README.md 2022-09-30 21:54:21 +02:00
mathieuHa ec0ffabc21 Update Readme
Show modes in a table
Fix gramar
2022-09-30 21:53:54 +02:00
Max Lerebourg 2f2cb60f74 🍱 fix 2022-09-30 01:38:00 +02:00
Max Lerebourg cb16130ca0 🍱 lint 2022-09-30 00:30:37 +02:00
Max Lerebourg d4fce42fd7 🍱 lint 2022-09-30 00:03:09 +02:00
Max Lerebourg 253caac5a4 🍱 lint 2022-09-29 22:19:35 +02:00
Max Lerebourg e122ce488c 🍱 lint 2022-09-29 22:18:08 +02:00
Max Lerebourg d9d92ed92d 🍱 lint 2022-09-29 22:08:52 +02:00
Max Lerebourg 3452c62860 add alone mode 2022-09-29 21:38:55 +02:00
Max Lerebourg b545eac5a8 fix lint 2022-09-29 14:01:33 +02:00
Max Lerebourg 2569f26805 fix lint 2022-09-29 11:27:14 +02:00
Max Lerebourg 773f001239 fix lint 2022-09-29 11:18:35 +02:00
Max Lerebourg 6b46c63287 fix logic 2022-09-29 11:16:52 +02:00
Max Lerebourg c8f59c2233 fix lint 2022-09-29 10:57:11 +02:00
Max Lerebourg 2110c70bbd fix lint 2022-09-29 10:52:29 +02:00
Max Lerebourg 00bbcfdb94 fix lint 2022-09-29 10:32:09 +02:00
Max Lerebourg a6012015e6 fix lint 2022-09-29 10:31:25 +02:00
Max Lerebourg feb40d9b5f fix lint 2022-09-29 10:08:07 +02:00
Max Lerebourg 6ab8ccb9db fix lint 2022-09-29 10:02:58 +02:00
Max Lerebourg dd36df5147 fix lint 2022-09-29 10:00:44 +02:00
Max Lerebourg ae959e4e0d fix lint 2022-09-29 09:55:17 +02:00
Max Lerebourg 7f5f69d134 fix lint 2022-09-29 09:52:24 +02:00
Max Lerebourg 1d7c5948f2 fix lint 2022-09-29 09:40:44 +02:00
Max Lerebourg 2559c71930 fix lint 2022-09-29 09:37:25 +02:00
Max Lerebourg 593681fd53 fix lint 2022-09-29 09:36:30 +02:00
Max Lerebourg c7714cb793 fix lint 2022-09-29 09:33:52 +02:00
Max Lerebourg 75267a1746 fix lint 2022-09-29 09:23:29 +02:00
Max Lerebourg 45eca85f3a fix lint 2022-09-29 09:18:39 +02:00
Max Lerebourg 1d9bd3fab0 fix lint 2022-09-29 09:16:03 +02:00
Max Lerebourg 0aff6e1789 fix lint 2022-09-29 09:15:14 +02:00
Max Lerebourg 0abf1b7390 fix main action 2022-09-29 09:13:04 +02:00
Max Lerebourg cb65e48a37 fix readme 8 2022-09-29 09:12:00 +02:00
Max Lerebourg cba7c1231f fix lint 2022-09-29 09:11:19 +02:00
Max Lerebourg da47ef320d fix readme 7 2022-09-29 09:00:20 +02:00
Max Lerebourg bbbb5acac5 fix readme 6 2022-09-29 08:59:28 +02:00
Max Lerebourg 6cf89bfc15 fix readme 5 2022-09-29 08:58:48 +02:00
Max Lerebourg f39317263f fix readme 4 2022-09-29 07:58:16 +02:00
Max Lerebourg 6dbd498212 fix readme 3 2022-09-29 07:54:11 +02:00
Max Lerebourg 7c2ac9830d 🍱 push .local 2022-09-29 07:45:23 +02:00
mathieuHaandMathieuHa b985f2d748 update main (#11)
* Update readme, add about sectioj

* Update readme about

* Change parameter with capitalized letters

* Add docker-compose local and docker-compose for real world utilization

* Update readme and .traefik

* update readme and docker-compose

* Update .traefik

Co-authored-by: MathieuHa <mathieu@hanotaux.fr>
2022-09-29 07:44:22 +02:00
Max Lerebourg a8758eb2e0 fix readme 2 2022-09-29 07:32:57 +02:00
Max Lerebourg aad92013d1 fix readme 2 2022-09-29 07:30:22 +02:00
Max Lerebourg 4843b86b45 fix readme 2022-09-29 07:19:36 +02:00
mathieuHaandMathieuHa 5eb4077133 update usage on readme, docker-compose and traefiker (#8)
* Update readme, add about sectioj

* Update readme about

* Change parameter with capitalized letters

* Add docker-compose local and docker-compose for real world utilization

* Update readme and .traefik

* update readme and docker-compose

* Update .traefik

Co-authored-by: MathieuHa <mathieu@hanotaux.fr>
2022-09-28 23:06:16 +02:00
mathieuHaandMathieuHa 57a97a0cf9 Update readme and solve traefiker error (#6)
* Update readme, add about sectioj

* Update readme about

* Change parameter with capitalized letters

* Add docker-compose local and docker-compose for real world utilization

* Update readme and .traefik

Co-authored-by: MathieuHa <mathieu@hanotaux.fr>
2022-09-28 22:16:03 +02:00
8 changed files with 511 additions and 200 deletions
+1 -1
View File
@@ -3,7 +3,7 @@ name: Main
on: on:
push: push:
branches: branches:
- master - main
pull_request: pull_request:
jobs: jobs:
+4
View File
@@ -1,2 +1,6 @@
.idea/ .idea/
.DS_Store .DS_Store
config
db
logs
docker-compose.dev.yml
+2 -4
View File
@@ -4,11 +4,9 @@ iconPath: .assets/icon.png
import: github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin import: github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
summary: 'Crowdsec Bouncer Traefik Plugin' summary: Middleware plugin which forwards the request IP to local Crowdsec agent, which can be used to allow/deny the request
testData: testData:
crowdsec: Enabled: false
bouncer:
enabled: true
CrowdsecLapiKey: 40796d93c2958f9e58345514e67740e5 CrowdsecLapiKey: 40796d93c2958f9e58345514e67740e5
+150 -9
View File
@@ -1,4 +1,8 @@
[![Build Status](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/workflows/Main/badge.svg?branch=master)](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/actions) ![GitHub](https://img.shields.io/github/license/maxlerebourg/crowdsec-bouncer-traefik-plugin)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/maxlerebourg/crowdsec-bouncer-traefik-plugin)
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/maxlerebourg/crowdsec-bouncer-traefik-plugin)
[![Build Status](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/actions/workflows/go-cross.yml/badge.svg)](https://github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin)](https://goreportcard.com/badge/github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin)
# Crowdsec Bouncer Traefik plugin # Crowdsec Bouncer Traefik plugin
@@ -6,9 +10,59 @@ This plugins aims to implement a Crowdsec Bouncer into a traefik plugin.
> [CrowdSec](https://www.crowdsec.net/) is an open-source and collaborative IPS (Intrusion Prevention System) and a security suite. > [CrowdSec](https://www.crowdsec.net/) is an open-source and collaborative IPS (Intrusion Prevention System) and a security suite.
> We leverage local behavior analysis and crowd power to build the largest CTI network in the world. > We leverage local behavior analysis and crowd power to build the largest CTI network in the world.
The purpose is to enable treafik to authorize or block requests from IP based and their reputation and behavior.
The crowdsec utility will provide the community blocklist which contains highly reported and validated IP banned from the crowdsec network.
When used with crowdsec it will leverage the local API which will analyze traefik logs and take decisions on the requests made by users/bots. Malicious actors will be banned based on patterns against your website.
There are 4 operating modes (CrowdsecMode) for this plugin:
| Mode | Description |
|------|------|
| none | If the client IP is on ban list, it will get a http code 403 response. Otherwise, request will continue as usual. All request call the Crowdsec LAPI |
| live | If the client IP is on ban list, it will get a http code 403 response. Otherwise, request will continue as usual. The bouncer can leverage use of a local cache in order to reduce the number of requests made to the Crowdsec LAPI. It will keep in cache the status for each IP that makes queries. |
| stream | Stream Streaming mode allows you to keep in the local cache only the Banned IPs, every requests that does not hit the cache is authorized. Every minute, the cache is updated with news from the Crowdsec LAPI. |
| alone | Streaming mode but the blacklisted IPs are fetched on the CAPI. Every 2 hours, the cache is updated with news from the Crowdsec CAPI.|
The recommanded mode for performance is the streaming mode, decisions are updated every 60 sec by default and that's the only communication between traefik and crowdsec. Every requests that happens hits the cache for quick decisions.
## Usage ## Usage
### Variables
- Enabled
- bool
- enable the plugin
- CrowdsecMode
- string
- default: `stream`, expected value are: `none`, `live`, `stream`, `alone`
- CrowdsecLapiScheme
- string
- default: `http`, expected value are: `http`, `https`
- CrowdsecLapiHost
- string
- default: "crowdsec:8080"
- Crowdsec LAPI available on which host.
- CrowdsecLapiKey
- string
- Crowdsec LAPI generated key for the bouncer.
- CrowdsecCapiLogin
- string
- Used only in `alone` mode, login for Crowdsec CAPI
- CrowdsecCapiPwd
- string
- Used only in `alone` mode, password for Crowdsec CAPI
- CrowdsecCapiScenarios
- []string
- Used only in `alone` mode, scenarios for Crowdsec CAPI
- UpdateIntervalSeconds
- int64
- default: 60
- Used only in `stream` mode, interval between fetching blacklisted IPs from LAPI
- DefaultDecisionSeconds
- int64
- default: 60
- Used only in `live` mode, decision duration of accepted IPs
### Configuration ### Configuration
@@ -20,7 +74,7 @@ The following declaration (given here in YAML) defines a plugin:
# Static configuration # Static configuration
experimental: experimental:
localPlugins: plugins:
bouncer: bouncer:
moduleName: github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin moduleName: github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
``` ```
@@ -36,7 +90,7 @@ http:
entryPoints: entryPoints:
- web - web
middlewares: middlewares:
- my-plugin - crowdsec
services: services:
service-foo: service-foo:
@@ -48,8 +102,88 @@ http:
crowdsec: crowdsec:
plugin: plugin:
bouncer: bouncer:
enabled: true enabled: false
crowdseclapikey: 40796d93c2958f9e58345514e67740e5 updateIntervalSeconds: 60
defaultDecisionSeconds: 60
crowdsecMode: stream
crowdsecLapiKey: privateKey
crowdsecLapiHost: crowdsec:8080
crowdsecLapiScheme: http
crowdsecCapiLogin: login
crowdsecCapiPwd: password
crowdsecCapiScenarios:
- scenario1
- scenario2
...
```
Except for the crowdsecLapiKey, crowdsecCapiLogin, crowdsecCapiPwd, crowdsecCapiScenarios, these are the default value of the plugin.
#### Generate LAPI KEY (exept for `alone` mode)
You need to generate a crowdsec API key for the LAPI.
You can follow the documentation here: https://docs.crowdsec.net/docs/user_guides/lapi_mgmt/
```bash
docker-compose -f docker-compose-local.yml up -d crowdsec
docker exec crowdsec cscli bouncers add crowdsecBouncer
```
This LAPI key must be set where is noted FIXME-LAPI-KEY in the docker-compose-test.yml
```yaml
...
whoami:
labels:
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseclapikey=FIXME-LAPI-KEY"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseclapischeme=http"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseclapihost=crowdsec:8080"
...
crowdsec:
environment:
BOUNCER_KEY_TRAEFIK: FIXME-LAPI-KEY
...
```
You can then run all the containers:
```bash
docker-compose up -d
```
#### Generate CAPI credentials (only for `alone` mode)
You need to create a crowdsec API credentials for the CAPI.
You can follow the documentation here: https://docs.crowdsec.net/docs/central_api/intro
```bash
curl -X POST "https://api.crowdsec.net/v2/watchers" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"password\": \"PASSWORD\", \"machine_id\": \"LOGIN\"}"
```
These CAPI credentials must be set in your docker-compose.yml or in your config files
```yaml
...
traefik:
command:
...
- "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
- "--experimental.plugins.bouncer.version=v1.0.0"
...
whoami:
labels:
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseccapilogin=LOGIN"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseccapipwd=PASSWORD"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseccapiscenarios=scenario1, scenario2, ..."
- "traefik.http.middlewares.crowdsec.plugin.bouncer.enabled=true"
```
You can then run all the containers:
```bash
docker-compose up -d
```
#### Add manually an IP to the blocklist (testing purpose)
```bash
docker-compose up -d crowdsec
docker exec crowdsec cscli decisions add --ip 10.0.0.10 # this will be effective 4h
docker exec crowdsec cscli decisions remove --ip 10.0.0.10
``` ```
### Local Mode ### Local Mode
@@ -75,13 +209,20 @@ The source code of the plugin should be organized as follows:
├── readme.md ├── readme.md
└── vendor/* └── vendor/*
``` ```
For local developpement a docker-compose.local.yml is provided and reproduce the directory layout needed by traefik. This works once you have generated and filled your LAPI-KEY (crowdsecLapiKey), if not look below for informations
```bash
docker-compose -f docker-compose.local.yml up -d
```
### About ### About
[maxlerebourg](https://github.com/maxlerebourg) and [I](https://github.com/mhanotaux) have been using traefik since 2020. Me and [mathieuHa](https://github.com/mathieuHa) have been using traefik since 2020 at [Primadviz](https://primadviz.com).
We come from developper and security engineer background and wanted to add the power of a very promesing technologie (Crowdsec) into the edge router we love. We come from web developper and security engineer background and wanted to add the power of a very promesing technology (Crowdsec) into the edge router we love.
We initially run into this project: https://github.com/fbonalair/traefik-crowdsec-bouncer We initially run into this project: https://github.com/fbonalair/traefik-crowdsec-bouncer
It was using traefik and forward auth middleware to verify every requests. It was using traefik and forward auth middleware to verify every requests.
They had to go through a webserver which then contacts of another webservice (the crowdsec LAPI) to make a decision based on the source IP. They had to go through a webserver which then contacts of another webservice (the crowdsec LAPI) to make a decision based on the source IP.
We initially proposed some improvement by implementing a streaming mode and a local cache We initially proposed some improvement by implementing a streaming mode and a local cache.
With the Traefik hackathon we deciced to implement our solution directly as a traefik plugin which could be found by every one on plugins.traefik.io and be more performant. With the Traefik hackathon we deciced to implement our solution directly as a traefik plugin which could be found by every one on plugins.traefik.io and be more performant.
+1 -1
View File
@@ -1,4 +1,4 @@
filenames: filenames:
- /var/log/traefik/*.log - /var/log/traefik/access.log
labels: labels:
type: traefik type: traefik
+263 -162
View File
@@ -5,11 +5,13 @@ import (
"context" "context"
"encoding/json" "encoding/json"
"fmt" "fmt"
"io"
"io/ioutil" "io/ioutil"
"log" "log"
"net" "net"
"net/http" "net/http"
"net/url" "net/url"
"strings"
"text/template" "text/template"
"time" "time"
@@ -17,37 +19,51 @@ import (
) )
const ( const (
crowdsecAuthHeader = "X-Api-Key" aloneMode = "alone"
crowdsecRoute = "v1/decisions" streamMode = "stream"
crowdsecStreamRoute = "v1/decisions/stream" liveMode = "live"
noneMode = "none"
crowdsecLapiHeader = "X-Api-Key"
crowdsecCapiHeader = "Authorization"
crowdsecLapiRoute = "v1/decisions"
crowdsecLapiStreamRoute = "v1/decisions/stream"
crowdsecCapiLogin = "v2/watchers/login"
crowdsecCapiDecisions = "v2/decisions/stream"
cacheBannedValue = "t" cacheBannedValue = "t"
cacheNoBannedValue = "f" cacheNoBannedValue = "f"
) )
var cache = ttl_map.New() // Config the plugin configuration.
type Config struct { type Config struct {
Enabled bool `json:"enabled,omitempty"` Enabled bool `json:"enabled,omitempty"`
CrowdsecMode string `json:"crowdsecMode,omitempty"` CrowdsecMode string `json:"crowdsecMode,omitempty"`
CrowdsecLapiScheme string `json:"crowdsecLapiScheme,omitempty"` CrowdsecLapiScheme string `json:"crowdsecLapiScheme,omitempty"`
CrowdsecLapiHost string `json:"crowdsecLapiHost,omitempty"` CrowdsecLapiHost string `json:"crowdsecLapiHost,omitempty"`
CrowdsecLapiKey string `json:"crowdsecLapiKey,omitempty"` CrowdsecLapiKey string `json:"crowdsecLapiKey,omitempty"`
CrowdsecCapiLogin string `json:"crowdsecCapiLogin,omitempty"`
CrowdsecCapiPwd string `json:"crowdsecCapiPwd,omitempty"`
CrowdsecCapiScenarios []string `json:"crowdsecCapiScenarios,omitempty"`
UpdateIntervalSeconds int64 `json:"updateIntervalSeconds,omitempty"` UpdateIntervalSeconds int64 `json:"updateIntervalSeconds,omitempty"`
DefaultDecisionSeconds int64 `json:"defaultDecisionSeconds,omitempty"` DefaultDecisionSeconds int64 `json:"defaultDecisionSeconds,omitempty"`
} }
// CreateConfig creates the default plugin configuration.
func CreateConfig() *Config { func CreateConfig() *Config {
return &Config{ return &Config{
Enabled: false, Enabled: false,
CrowdsecMode: "none", CrowdsecMode: streamMode,
CrowdsecLapiScheme: "http", CrowdsecLapiScheme: "http",
CrowdsecLapiHost: "crowdsec:8080", CrowdsecLapiHost: "crowdsec:8080",
CrowdsecLapiKey: "", CrowdsecLapiKey: "",
CrowdsecCapiLogin: "",
CrowdsecCapiPwd: "",
CrowdsecCapiScenarios: []string{},
UpdateIntervalSeconds: 60, UpdateIntervalSeconds: 60,
DefaultDecisionSeconds: 60, DefaultDecisionSeconds: 60,
} }
} }
// Bouncer a Bouncer plugin.
type Bouncer struct { type Bouncer struct {
next http.Handler next http.Handler
name string name string
@@ -61,55 +77,18 @@ type Bouncer struct {
crowdsecMode string crowdsecMode string
updateInterval int64 updateInterval int64
defaultDecisionTimeout int64 defaultDecisionTimeout int64
crowdsecLogin string
crowdsecPwd string
crowdsecScenarios []string
client *http.Client client *http.Client
cache *ttl_map.Heap
} }
// New creates the crowdsec bouncer plugin. // New creates the crowdsec bouncer plugin.
func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error) { func New(ctx context.Context, next http.Handler, config *Config, name string) (http.Handler, error) {
requiredStrings := map[string]string{ err := validateParams(config)
"CrowdsecLapiScheme": config.CrowdsecLapiScheme,
"CrowdsecLapiHost": config.CrowdsecLapiHost,
"CrowdsecLapiKey": config.CrowdsecLapiKey,
"CrowdsecMode": config.CrowdsecMode,
}
for key, val := range requiredStrings {
if len(val) == 0 {
return nil, fmt.Errorf("%v cannot be empty", key)
}
}
requiredInt := map[string]int64{
"UpdateIntervalSeconds": config.UpdateIntervalSeconds,
"DefaultDecisionSeconds": config.DefaultDecisionSeconds,
}
for key, val := range requiredInt {
if val < 1 {
return nil, fmt.Errorf("%v cannot be less than 1", key)
}
}
// none -> If the client IP is on ban list, it will get a http code 403 response.
// Otherwise, request will continue as usual. All request call the Crowdsec LAPI
// live -> If the client IP is on ban list, it will get a http code 403 response.
// Otherwise, request will continue as usual.
// The bouncer can leverage use of a local cache in order to reduce the number
// of requests made to the Crowdsec LAPI. It will keep in cache the status for
// each IP that makes queries.
// stream -> Stream Streaming mode allows you to keep in the local cache only the Banned IPs,
// every requests that does not hit the cache is authorized.
// Every minute, the cache is updated with news from the Crowdsec LAPI.
if !contains([]string{"none", "live", "stream"}, config.CrowdsecMode) {
return nil, fmt.Errorf("CrowdsecMode must be one of: none, live or stream")
}
if !contains([]string{"http", "https"}, config.CrowdsecLapiScheme) {
return nil, fmt.Errorf("CrowdsecLapiScheme must be one of: http, https")
}
testUrl := url.URL{
Scheme: config.CrowdsecLapiScheme,
Host: config.CrowdsecLapiHost,
Path: crowdsecRoute,
}
_, err := http.NewRequest(http.MethodGet, testUrl.String(), nil)
if err != nil { if err != nil {
return nil, fmt.Errorf("CrowdsecLapiScheme://CrowdsecLapiHost: '%v://%v' must be an URL", config.CrowdsecLapiScheme, config.CrowdsecLapiHost) return nil, err
} }
bouncer := &Bouncer{ bouncer := &Bouncer{
@@ -123,6 +102,9 @@ func New(ctx context.Context, next http.Handler, config *Config, name string) (h
crowdsecScheme: config.CrowdsecLapiScheme, crowdsecScheme: config.CrowdsecLapiScheme,
crowdsecHost: config.CrowdsecLapiHost, crowdsecHost: config.CrowdsecLapiHost,
crowdsecKey: config.CrowdsecLapiKey, crowdsecKey: config.CrowdsecLapiKey,
crowdsecLogin: config.CrowdsecCapiLogin,
crowdsecPwd: config.CrowdsecCapiPwd,
crowdsecScenarios: config.CrowdsecCapiScenarios,
updateInterval: config.UpdateIntervalSeconds, updateInterval: config.UpdateIntervalSeconds,
defaultDecisionTimeout: config.DefaultDecisionSeconds, defaultDecisionTimeout: config.DefaultDecisionSeconds,
client: &http.Client{ client: &http.Client{
@@ -132,32 +114,40 @@ func New(ctx context.Context, next http.Handler, config *Config, name string) (h
}, },
Timeout: 5 * time.Second, Timeout: 5 * time.Second,
}, },
cache: ttl_map.New(),
} }
// if we are on a stream mode, we fetch in a go routine every minute the new decisions if config.CrowdsecMode == streamMode || config.CrowdsecMode == aloneMode {
if config.CrowdsecMode == "stream" { if config.CrowdsecMode == aloneMode {
go handleStreamCache(bouncer, true) getToken(bouncer)
}
ticker := time.NewTicker(time.Duration(config.UpdateIntervalSeconds) * time.Second)
go func() {
go handleStreamCache(bouncer)
for range ticker.C {
go handleStreamCache(bouncer)
}
}()
} }
return bouncer, nil return bouncer, nil
} }
// TODO the serve HTTP should be split as it's too long // ServeHTTP principal function of plugin.
func (a *Bouncer) ServeHTTP(rw http.ResponseWriter, req *http.Request) { func (a *Bouncer) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
if !a.enabled { if !a.enabled {
log.Printf("Crowdsec Bouncer not enabled")
a.next.ServeHTTP(rw, req) a.next.ServeHTTP(rw, req)
return return
} }
// TODO Make sur remote address does not include the port // TODO Make sur remote address does not include the port.
remoteHost, _, err := net.SplitHostPort(req.RemoteAddr) remoteHost, _, err := net.SplitHostPort(req.RemoteAddr)
if err != nil { if err != nil {
log.Printf("failed to extract ip from remote address: %v", err) logger(fmt.Sprintf("failed to extract ip from remote address: %v", err))
a.next.ServeHTTP(rw, req) a.next.ServeHTTP(rw, req)
return return
} }
if a.crowdsecMode == "stream" || a.crowdsecMode == "live" { if a.crowdsecMode == streamMode || a.crowdsecMode == aloneMode || a.crowdsecMode == liveMode {
isBanned, err := getDecision(remoteHost) isBanned, err := getDecision(a, remoteHost)
if err == nil { if err == nil {
if isBanned { if isBanned {
rw.WriteHeader(http.StatusForbidden) rw.WriteHeader(http.StatusForbidden)
@@ -168,78 +158,24 @@ func (a *Bouncer) ServeHTTP(rw http.ResponseWriter, req *http.Request) {
} }
} }
// Right here if we cannot join the stream we forbid the request to go on // Right here if we cannot join the stream we forbid the request to go on.
if a.crowdsecMode == "stream" { if a.crowdsecMode == streamMode || a.crowdsecMode == aloneMode {
if a.crowdsecStreamHealthy { if a.crowdsecStreamHealthy {
a.next.ServeHTTP(rw, req) a.next.ServeHTTP(rw, req)
} else { } else {
rw.WriteHeader(http.StatusForbidden) rw.WriteHeader(http.StatusForbidden)
} }
return } else {
handleNoStreamCache(a, rw, req, remoteHost)
}
} }
// We are now in none or live mode // CUSTOM CODE.
noneUrl := url.URL{ // TODO place in another file.
Scheme: a.crowdsecScheme,
Host: a.crowdsecHost,
Path: crowdsecRoute,
RawQuery: fmt.Sprintf("ip=%v&banned=true", remoteHost),
}
request, _ := http.NewRequest(http.MethodGet, noneUrl.String(), nil)
request.Header.Add(crowdsecAuthHeader, a.crowdsecKey)
res, err := a.client.Do(request)
if err != nil {
log.Printf("failed to get decision: %s", err)
rw.WriteHeader(http.StatusForbidden)
return
}
defer res.Body.Close()
if res.StatusCode != 200 {
log.Printf("failed to get decision, status code: %d", res.StatusCode)
rw.WriteHeader(http.StatusForbidden)
return
}
body, err := ioutil.ReadAll(res.Body)
if err != nil {
log.Printf("failed to read body: %s", err)
rw.WriteHeader(http.StatusForbidden)
return
}
if !bytes.Equal(body, []byte("null")) {
var decisions []Decision
err = json.Unmarshal(body, &decisions)
if err != nil {
log.Printf("failed to parse body: %s", err)
rw.WriteHeader(http.StatusForbidden)
return
}
if len(decisions) == 0 {
if a.crowdsecMode == "live" {
setDecision(remoteHost, false, a.defaultDecisionTimeout)
}
a.next.ServeHTTP(rw, req)
return
}
duration, err := time.ParseDuration(decisions[0].Duration)
if err != nil {
log.Printf("failed to parse duration: %s", err)
rw.WriteHeader(http.StatusForbidden)
return
}
rw.WriteHeader(http.StatusForbidden)
setDecision(remoteHost, true, int64(duration.Seconds()))
return
}
if a.crowdsecMode == "live" {
setDecision(remoteHost, false, a.defaultDecisionTimeout)
}
a.next.ServeHTTP(rw, req)
}
// CUSTOM CODE // Decision Body returned from Crowdsec LAPI.
// TODO place in another file
type Decision struct { type Decision struct {
Id int `json:"id"` ID int `json:"id"`
Origin string `json:"origin"` Origin string `json:"origin"`
Type string `json:"type"` Type string `json:"type"`
Scope string `json:"scope"` Scope string `json:"scope"`
@@ -249,11 +185,23 @@ type Decision struct {
Simulated bool `json:"simulated"` Simulated bool `json:"simulated"`
} }
// Stream Body returned from Crowdsec Stream LAPI.
type Stream struct { type Stream struct {
Deleted []Decision `json:"deleted"` Deleted []Decision `json:"deleted"`
New []Decision `json:"new"` New []Decision `json:"new"`
} }
// Login Body returned from Crowdsec Login CAPI.
type Login struct {
Code int `json:"code"`
Token string `json:"token"`
Expire string `json:"expire"`
}
func logger(str string) {
log.Printf("Crowdsec Bouncer Traefik Plugin - %s", str)
}
func contains(source []string, target string) bool { func contains(source []string, target string) bool {
for _, a := range source { for _, a := range source {
if a == target { if a == target {
@@ -263,74 +211,227 @@ func contains(source []string, target string) bool {
return false return false
} }
// Get Decision check in the cache if the IP has the banned / not banned value // Get Decision check in the cache if the IP has the banned / not banned value.
// Otherwise return with an error to add the IP in cache if we are on // Otherwise return with an error to add the IP in cache if we are on.
func getDecision(clientIP string) (bool, error) { func getDecision(a *Bouncer, clientIP string) (bool, error) {
isBanned, ok := cache.Get(clientIP) banned, isCached := a.cache.Get(clientIP)
if ok && len(isBanned.(string)) > 0 { bannedString, isValid := banned.(string)
if isBanned == cacheNoBannedValue { if isCached && isValid && len(bannedString) > 0 {
return false, nil return bannedString == cacheBannedValue, nil
} else {
return true, nil
} }
} return false, fmt.Errorf("no cache data")
return false, fmt.Errorf("no data")
} }
func setDecision(clientIP string, isBanned bool, duration int64) { func setDecision(a *Bouncer, clientIP string, isBanned bool, duration int64) {
if a.crowdsecMode == noneMode {
return
}
if isBanned { if isBanned {
cache.Set(clientIP, cacheBannedValue, duration) logger(fmt.Sprintf("%v banned", clientIP))
a.cache.Set(clientIP, cacheBannedValue, duration)
} else { } else {
cache.Set(clientIP, cacheNoBannedValue, duration) a.cache.Set(clientIP, cacheNoBannedValue, duration)
} }
} }
func handleStreamCache(a *Bouncer, initialized bool) { func handleNoStreamCache(a *Bouncer, rw http.ResponseWriter, req *http.Request, remoteHost string) {
// TODO clean properly on exit // We are now in none or live mode.
time.AfterFunc(time.Duration(a.updateInterval)*time.Second, func() { routeURL := url.URL{
handleStreamCache(a, false)
})
streamUrl := url.URL{
Scheme: a.crowdsecScheme, Scheme: a.crowdsecScheme,
Host: a.crowdsecHost, Host: a.crowdsecHost,
Path: crowdsecStreamRoute, Path: crowdsecLapiRoute,
RawQuery: fmt.Sprintf("startup=%t", initialized), RawQuery: fmt.Sprintf("ip=%v&banned=true", remoteHost),
} }
req, _ := http.NewRequest(http.MethodGet, streamUrl.String(), nil) body := crowdsecQuery(a, routeURL.String(), false)
req.Header.Add(crowdsecAuthHeader, a.crowdsecKey)
res, err := a.client.Do(req) if bytes.Equal(body, []byte("null")) {
if err != nil || res.StatusCode == http.StatusForbidden { setDecision(a, remoteHost, false, a.defaultDecisionTimeout)
log.Printf("error while fetching decisions: %s", err) a.next.ServeHTTP(rw, req)
a.crowdsecStreamHealthy = false
return return
} }
if res.StatusCode == http.StatusForbidden {
log.Printf("error while fetching decisions, status code: %d", res.StatusCode) var decisions []Decision
a.crowdsecStreamHealthy = false err := json.Unmarshal(body, &decisions)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil { if err != nil {
log.Printf("error while reading body: %s", err) logger(fmt.Sprintf("failed to parse body: %s", err))
a.crowdsecStreamHealthy = false rw.WriteHeader(http.StatusForbidden)
return return
} }
if len(decisions) == 0 {
setDecision(a, remoteHost, false, a.defaultDecisionTimeout)
a.next.ServeHTTP(rw, req)
return
}
rw.WriteHeader(http.StatusForbidden)
duration, err := time.ParseDuration(decisions[0].Duration)
if err != nil {
logger(fmt.Sprintf("failed to parse duration: %s", err))
return
}
setDecision(a, remoteHost, true, int64(duration.Seconds()))
}
func handleStreamCache(a *Bouncer) {
logger(fmt.Sprintf("Start handleStreamCache with health=%v", a.crowdsecStreamHealthy))
// TODO clean properly on exit.
var rawQuery string
var path string
if a.crowdsecMode == aloneMode {
rawQuery = ""
path = crowdsecCapiDecisions
} else {
rawQuery = fmt.Sprintf("startup=%t", !a.crowdsecStreamHealthy)
path = crowdsecLapiStreamRoute
}
streamRouteURL := url.URL{
Scheme: a.crowdsecScheme,
Host: a.crowdsecHost,
Path: path,
RawQuery: rawQuery,
}
body := crowdsecQuery(a, streamRouteURL.String(), false)
var stream Stream var stream Stream
err = json.Unmarshal(body, &stream) err := json.Unmarshal(body, &stream)
if err != nil { if err != nil {
log.Printf("error while parsing body: %s", err) logger(fmt.Sprintf("error while parsing body: %s", err))
a.crowdsecStreamHealthy = false a.crowdsecStreamHealthy = false
return return
} }
for _, decision := range stream.New { for _, decision := range stream.New {
duration, err := time.ParseDuration(decision.Duration) duration, err := time.ParseDuration(decision.Duration)
if err == nil { if err == nil {
setDecision(decision.Value, true, int64(duration.Seconds())) setDecision(a, decision.Value, true, int64(duration.Seconds()))
} }
} }
for _, decision := range stream.Deleted { for _, decision := range stream.Deleted {
cache.Del(decision.Value) a.cache.Del(decision.Value)
} }
a.crowdsecStreamHealthy = true a.crowdsecStreamHealthy = true
} }
func getToken(a *Bouncer) {
loginURL := url.URL{
Scheme: a.crowdsecScheme,
Host: a.crowdsecHost,
Path: crowdsecCapiLogin,
}
body := crowdsecQuery(a, loginURL.String(), true)
var login Login
err := json.Unmarshal(body, &login)
if err != nil {
logger(fmt.Sprintf("error while parsing body: %s", err))
a.crowdsecStreamHealthy = false
return
}
if login.Code == 200 && len(login.Token) > 0 {
a.crowdsecKey = login.Token
}
}
func crowdsecQuery(a *Bouncer, stringURL string, isPost bool) []byte {
var req *http.Request
if isPost {
data := []byte(fmt.Sprintf(
`{"machine_id": "%v","password": "%v","scenarios": ["%v"]}`,
a.crowdsecLogin,
a.crowdsecPwd,
strings.Join(a.crowdsecScenarios, `","`),
))
req, _ = http.NewRequest(http.MethodPost, stringURL, bytes.NewBuffer(data))
} else {
req, _ = http.NewRequest(http.MethodGet, stringURL, nil)
}
if a.crowdsecMode == aloneMode {
req.Header.Add(crowdsecCapiHeader, a.crowdsecKey)
} else {
req.Header.Add(crowdsecLapiHeader, a.crowdsecKey)
}
res, err := a.client.Do(req)
if err != nil {
logger(fmt.Sprintf("error while fetching %v: %s", stringURL, err))
a.crowdsecStreamHealthy = false
return nil
}
if res.StatusCode == http.StatusUnauthorized && a.crowdsecMode == aloneMode {
oldToken := a.crowdsecKey
getToken(a)
if oldToken == a.crowdsecKey {
a.crowdsecStreamHealthy = false
return nil
}
return crowdsecQuery(a, stringURL, false)
}
if res.StatusCode != http.StatusOK {
logger(fmt.Sprintf("error while fetching %v, status code: %d", stringURL, res.StatusCode))
a.crowdsecStreamHealthy = false
return nil
}
defer func(body io.ReadCloser) {
err = body.Close()
if err != nil {
logger(fmt.Sprintf("failed to close body reader: %s", err))
}
}(res.Body)
body, err := ioutil.ReadAll(res.Body)
if err != nil {
logger(fmt.Sprintf("error while reading body: %s", err))
a.crowdsecStreamHealthy = false
return nil
}
return body
}
func validateParams(config *Config) error {
var requiredStrings map[string]string
if config.CrowdsecMode == aloneMode {
requiredStrings = map[string]string{
"CrowdsecCapiLogin": config.CrowdsecLapiScheme,
"CrowdsecCapiPwd": config.CrowdsecLapiHost,
}
for _, val := range config.CrowdsecCapiScenarios {
if len(val) == 0 {
return fmt.Errorf("CrowdsecCapiScenarios: one or more scenario are empty")
}
}
config.UpdateIntervalSeconds = 7200
config.CrowdsecLapiKey = ""
config.CrowdsecLapiScheme = "https"
config.CrowdsecLapiHost = "api.crowdsec.net"
} else {
requiredStrings = map[string]string{
"CrowdsecLapiScheme": config.CrowdsecLapiScheme,
"CrowdsecLapiHost": config.CrowdsecLapiHost,
"CrowdsecLapiKey": config.CrowdsecLapiKey,
"CrowdsecMode": config.CrowdsecMode,
}
requiredInt := map[string]int64{
"UpdateIntervalSeconds": config.UpdateIntervalSeconds,
"DefaultDecisionSeconds": config.DefaultDecisionSeconds,
}
for key, val := range requiredInt {
if val < 1 {
return fmt.Errorf("%v: cannot be less than 1", key)
}
}
}
for key, val := range requiredStrings {
if len(val) == 0 {
return fmt.Errorf("%v: cannot be empty", key)
}
}
if !contains([]string{noneMode, liveMode, streamMode, aloneMode}, config.CrowdsecMode) {
return fmt.Errorf("CrowdsecMode: must be one of 'none', 'live' or 'stream'")
}
if !contains([]string{"http", "https"}, config.CrowdsecLapiScheme) {
return fmt.Errorf("CrowdsecLapiScheme: must be one of 'http' or 'https'")
}
testURL := url.URL{
Scheme: config.CrowdsecLapiScheme,
Host: config.CrowdsecLapiHost,
}
_, err := http.NewRequest(http.MethodGet, testURL.String(), nil)
if err != nil {
return fmt.Errorf("CrowdsecLapiScheme://CrowdsecLapiHost: '%v://%v' must be an URL", config.CrowdsecLapiScheme, config.CrowdsecLapiHost)
}
return nil
}
+70
View File
@@ -0,0 +1,70 @@
version: "3.8"
services:
traefik:
image: "traefik:v2.8.7"
container_name: "traefik"
command:
# - "--log.level=DEBUG"
- "--accesslog"
- "--accesslog.filepath=/var/log/traefik/access.log"
- "--api.insecure=true"
- "--providers.docker=true"
- "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80"
- "--experimental.localplugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- logs:/var/log/traefik
- ./:/plugins-local/src/github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
labels:
- "traefik.enable=true"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.enabled=true"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseclapikey=40796d93c2958f9e58345514e67740e5"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseccapilogin=3829a6c9870e4726a377d8951ebb64a1m8psGvMaq1ykJ3zX"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseccapipwd=Q5pgN8bRNInHGdx6QCksdPOJVLeLQ7ipJntSeuP3r8088zXzRVs4G8liXAKfI1k6"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseccapiscenarios=crowdsecurity/http-backdoors-attempts,baudneo/zoneminder-bf"
ports:
- 8000:80
- 8080:8080
depends_on:
- crowdsec
whoami1:
image: traefik/whoami
container_name: "simple-service1"
labels:
- "traefik.enable=true"
- "traefik.http.routers.whoami.rule=Host(`localhost`)"
- "traefik.http.routers.whoami.entrypoints=web"
- "traefik.http.routers.whoami.middlewares=crowdsec@docker"
- "traefik.http.services.whoami.loadbalancer.server.port=80"
whoami2:
image: traefik/whoami
container_name: "simple-service2"
labels:
- "traefik.enable=true"
- "traefik.http.routers.whoami.rule=Host(`localhost`)"
- "traefik.http.routers.whoami.entrypoints=web"
- "traefik.http.routers.whoami.middlewares=crowdsec@docker"
- "traefik.http.services.whoami.loadbalancer.server.port=80"
crowdsec:
image: crowdsecurity/crowdsec:v1.4.1
container_name: "crowdsec"
command: rm -rf /etc/crowdsec/acquis.yaml
environment:
COLLECTIONS: crowdsecurity/traefik
CUSTOM_HOSTNAME: crowdsec
BOUNCER_KEY_TRAEFIK: 40796d93c2958f9e58345514e67740e5
volumes:
- ./acquis.yaml:/etc/crowdsec/acquis.yaml:ro
- logs:/var/log/traefik:ro
- crowdsec-db:/var/lib/crowdsec/data/
- crowdsec-config:/etc/crowdsec/
volumes:
logs:
crowdsec-db:
crowdsec-config:
+8 -11
View File
@@ -2,25 +2,26 @@ version: "3.8"
services: services:
traefik: traefik:
image: "traefik:v2.8.5" image: "traefik:v2.8.7"
container_name: "traefik" container_name: "traefik"
command: command:
# - "--log.level=DEBUG" # - "--log.level=DEBUG"
- "--accesslog" - "--accesslog"
- "--accesslog.filepath=/var/log/traefik/traefik.log" - "--accesslog.filepath=/var/log/traefik/access.log"
- "--api.insecure=true" - "--api.insecure=true"
- "--providers.docker=true" - "--providers.docker=true"
- "--providers.docker.exposedbydefault=false" - "--providers.docker.exposedbydefault=false"
- "--entrypoints.web.address=:80" - "--entrypoints.web.address=:80"
- "--experimental.localplugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin" - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
volumes: volumes:
- "/var/run/docker.sock:/var/run/docker.sock:ro" - "/var/run/docker.sock:/var/run/docker.sock:ro"
- "logs:/var/log/traefik" - "logs:/var/log/traefik"
- ./:/plugins-local/src/github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
ports: ports:
- 8000:80 - 8000:80
- 8080:8080 - 8080:8080
depends_on:
- 'crowdsec'
whoami: whoami:
image: traefik/whoami image: traefik/whoami
@@ -31,7 +32,7 @@ services:
- "traefik.http.routers.whoami.entrypoints=web" - "traefik.http.routers.whoami.entrypoints=web"
- "traefik.http.routers.whoami.middlewares=crowdsec@docker" - "traefik.http.routers.whoami.middlewares=crowdsec@docker"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.enabled=true" - "traefik.http.middlewares.crowdsec.plugin.bouncer.enabled=true"
- "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseclapikey=40796d93c2958f9e58345514e67740e5" - "traefik.http.middlewares.crowdsec.plugin.bouncer.crowdseclapikey=FIXME-LAPI-KEY"
crowdsec: crowdsec:
image: crowdsecurity/crowdsec:v1.4.1 image: crowdsecurity/crowdsec:v1.4.1
@@ -40,16 +41,12 @@ services:
environment: environment:
COLLECTIONS: crowdsecurity/traefik COLLECTIONS: crowdsecurity/traefik
CUSTOM_HOSTNAME: crowdsec CUSTOM_HOSTNAME: crowdsec
BOUNCER_KEY_TRAEFIK: 40796d93c2958f9e58345514e67740e5 BOUNCER_KEY_TRAEFIK: FIXME-LAPI-KEY
depends_on:
- 'traefik'
volumes: volumes:
- ./acquis.yaml:/etc/crowdsec/acquis.yaml:ro - ./acquis.yaml:/etc/crowdsec/acquis.yaml:ro
- logs:/var/log/traefik - logs:/var/log/traefik:ro
- crowdsec-db:/var/lib/crowdsec/data/ - crowdsec-db:/var/lib/crowdsec/data/
- crowdsec-config:/etc/crowdsec/ - crowdsec-config:/etc/crowdsec/
ports:
- "8083:8080"
volumes: volumes:
logs: logs: