✨ add redis database selection (#100)

* ✨ add redis database selection

* 📝 update docs

* 📝 readme

.github/ISSUE_TEMPLATE/bug_report.md

@@ -30,4 +30,6 @@ Steps to reproduce the behavior:
 3. Scroll down to '....'
 4. See error
 
+<!---
 If you like the plugin, please consider starring it, so you can get updates and we get some more visibility ✨
+-->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -16,4 +16,6 @@ A clear and concise description of what you want to happen.
 **Additional context**
 Add any other context or screenshots about the feature request here.
 
+<!---
 If you like the plugin, please consider starring it, so you can get updates and we get some more visibility ✨
+-->

README.md

@@ -107,6 +107,10 @@ make run
   - string 
   - default: ""
   - Password for the Redis service
+- RedisCacheDatabase
+  - string 
+  - default: ""
+  - Database selection for the Redis service
 - UpdateIntervalSeconds
   - int64
   - default: 60
@@ -138,6 +142,7 @@ experimental:
   plugins:
     bouncer:
       moduleName: github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin
+      version: vX.Y.Z # To update
 ```
 
 ```yaml
@@ -188,6 +193,7 @@ http:
           redisCacheEnabled: false
           redisCacheHost: "redis:6379"
           redisCachePassword: password
+          redisCacheDatabase: "5"
           crowdsecLapiTLSCertificateAuthority: |-
             -----BEGIN CERTIFICATE-----
             MIIEBzCCAu+gAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwgZQxCzAJBgNVBAYTAlVT

bouncer.go

@@ -142,9 +142,13 @@ func New(ctx context.Context, next http.Handler, config *configuration.Config, n
 		cacheClient: &cache.Client{},
 	}
 	config.RedisCachePassword, _ = configuration.GetVariable(config, "RedisCachePassword")
-	bouncer.cacheClient.New(config.RedisCacheEnabled, config.RedisCacheHost, config.RedisCachePassword)
+	bouncer.cacheClient.New(
+		config.RedisCacheEnabled,
+		config.RedisCacheHost,
+		config.RedisCachePassword,
+		config.RedisCacheDatabase,
+	)
 
-	//nolint:nestif
 	if (config.CrowdsecMode == configuration.StreamMode || config.CrowdsecMode == configuration.AloneMode) && ticker == nil {
 		if config.CrowdsecMode == configuration.AloneMode {
 			if err := getToken(bouncer); err != nil {
@@ -152,17 +156,10 @@ func New(ctx context.Context, next http.Handler, config *configuration.Config, n
 				return nil, err
 			}
 		}
-		if err := handleStreamCache(bouncer); err != nil {
+		handleStreamTicker(bouncer)
-			return nil, err
-		}
 		isStartup = false
 		ticker = startTicker(config, func() {
-			if err := handleStreamCache(bouncer); err != nil {
+			handleStreamTicker(bouncer)
-				isCrowdsecStreamHealthy = false
-				logger.Error(err.Error())
-			} else {
-				isCrowdsecStreamHealthy = true
-			}
 		})
 	}
 	logger.Debug(fmt.Sprintf("New initialized mode:%s", config.CrowdsecMode))
@@ -269,6 +266,15 @@ type Login struct {
 	Expire string `json:"expire"`
 }
 
+func handleStreamTicker(bouncer *Bouncer) {
+	if err := handleStreamCache(bouncer); err != nil {
+		isCrowdsecStreamHealthy = false
+		logger.Error(err.Error())
+	} else {
+		isCrowdsecStreamHealthy = true
+	}
+}
+
 func startTicker(config *configuration.Config, work func()) chan bool {
 	ticker := time.NewTicker(time.Duration(config.UpdateIntervalSeconds) * time.Second)
 	stop := make(chan bool, 1)

docker-compose.local.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   traefik:
-    image: "traefik:v2.9.6"
+    image: "traefik:v2.9.10"
     container_name: "traefik"
     restart: unless-stopped
     command:
@@ -52,7 +52,7 @@ services:
       - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.crowdseclapikey=44c36dac5c4140af9f06f397508e82c7"
 
   crowdsec:
-    image: crowdsecurity/crowdsec:v1.4.1
+    image: crowdsecurity/crowdsec:v1.4.6
     container_name: "crowdsec"
     restart: unless-stopped
     environment:

docker-compose.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   traefik:
-    image: "traefik:v2.9.6"
+    image: "traefik:v2.9.10"
     container_name: "traefik"
     restart: unless-stopped
     command:
@@ -14,7 +14,7 @@ services:
       - "--entrypoints.web.address=:80"
 
       - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
-      - "--experimental.plugins.bouncer.version=v1.1.8"
+      - "--experimental.plugins.bouncer.version=v1.1.11"
     volumes:
       - "/var/run/docker.sock:/var/run/docker.sock:ro"
       - "logs:/var/log/traefik"
@@ -63,7 +63,7 @@ services:
       - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.forwardedheaderstrustedips=172.21.0.5"
 
   crowdsec:
-    image: crowdsecurity/crowdsec:v1.4.1
+    image: crowdsecurity/crowdsec:v1.4.6
     container_name: "crowdsec"
     restart: unless-stopped
     environment:

exemples/behind-proxy/docker-compose.cloudflare.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   cloudflare:
-    image: "traefik:v2.9.6"
+    image: "traefik:v2.9.10"
     container_name: "cloudflare"
     restart: unless-stopped
     command:
@@ -12,7 +12,6 @@ services:
       - "--api.insecure=true"
       - "--entrypoints.web.address=:80"
       - "--providers.file.filename=/cloud.yaml"
-      - "--experimental.localplugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
       - ./cloudflare-exemple.yaml:/cloud.yaml:ro
@@ -22,7 +21,7 @@ services:
       - 8080:8080
 
   traefik:
-    image: "traefik:v2.9.6"
+    image: "traefik:v2.9.10"
     container_name: "traefik"
     restart: unless-stopped
     command:
@@ -36,7 +35,7 @@ services:
       - "--entrypoints.web.forwardedheaders.trustedips=172.21.0.5"
 
       - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
-      - "--experimental.plugins.bouncer.version=v1.1.7"
+      - "--experimental.plugins.bouncer.version=v1.1.11"
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
       - logs-traefik:/var/log/traefik
@@ -46,7 +45,7 @@ services:
     depends_on:
       - crowdsec
 
-  whoami1:
+  whoami-foo:
     image: traefik/whoami
     container_name: "simple-service-foo"
     restart: unless-stopped
@@ -66,7 +65,7 @@ services:
       - "traefik.http.middlewares.crowdsec-foo.plugin.bouncer.forwardedheaderstrustedips=172.21.0.5"
       - "traefik.http.middlewares.crowdsec-foo.plugin.bouncer.loglevel=DEBUG"
   
-  whoami2:
+  whoami-bar:
     image: traefik/whoami
     container_name: "simple-service-bar"
     restart: unless-stopped
@@ -88,7 +87,7 @@ services:
   
 
   crowdsec:
-    image: crowdsecurity/crowdsec:v1.4.3
+    image: crowdsecurity/crowdsec:v1.4.6
     container_name: "crowdsec"
     restart: unless-stopped
     environment:

exemples/binary-vm/scripts/install_traefik.sh

@@ -2,7 +2,7 @@
 
 DEBIAN_FRONTEND=noninteractive sudo apt-get update && sudo apt-get install wget -y
 # DEBIAN_FRONTEND=noninteractive sudo apt-get upgrade -y --assume-yes
-wget -O traefik.tar.gz "https://github.com/traefik/traefik/releases/download/v2.9.6/traefik_v2.9.6_linux_amd64.tar.gz"
+wget -O traefik.tar.gz "https://github.com/traefik/traefik/releases/download/v2.9.10/traefik_v2.9.10_linux_amd64.tar.gz"
 tar -zxvf traefik.tar.gz
 # inspired from https://gist.github.com/ubergesundheit/7c9d875befc2d7bfd0bf43d8b3862d85
 sudo mv ./traefik /usr/local/bin/

exemples/binary-vm/scripts/install_whoami.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 DEBIAN_FRONTEND=noninteractive sudo apt-get update && apt-get install wget -y
-wget -O whoami.tar.gz "https://github.com/traefik/whoami/releases/download/v1.8.7/whoami_v1.8.7_linux_amd64.tar.gz"
+wget -O whoami.tar.gz "https://github.com/traefik/whoami/releases/download/v1.9.0/whoami_v1.9.0_linux_amd64.tar.gz"
 tar -zxvf whoami.tar.gz
 # inspired from https://gist.github.com/ubergesundheit/7c9d875befc2d7bfd0bf43d8b3862d85
 sudo mv ./whoami /usr/local/bin/

exemples/kubernetes/crowdsec/values.yml

@@ -1,5 +1,5 @@
 image:
-  tag: v1.4.4-rc1
+  tag: v1.4.6
 
 agent:
   acquisition:

exemples/kubernetes/traefik/values.yml

@@ -1,5 +1,5 @@
 image:
-  tag: v2.9.6
+  tag: v2.9.10
 
 logs:
   general:
@@ -16,4 +16,4 @@ experimental:
 
 additionalArguments:
   - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
-  - "--experimental.plugins.bouncer.version=v1.1.7-beta1"
+  - "--experimental.plugins.bouncer.version=v1.1.11"

exemples/redis-cache/docker-compose.redis.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   traefik:
-    image: "traefik:v2.9.8"
+    image: "traefik:v2.9.10"
     container_name: "traefik"
     restart: unless-stopped
     command:
@@ -15,7 +15,7 @@ services:
       - "--entrypoints.web.address=:80"
 
       - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
-      - "--experimental.plugins.bouncer.version=v1.1.11-beta2"
+      - "--experimental.plugins.bouncer.version=v1.1.11"
       # - "--experimental.localplugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
@@ -47,7 +47,7 @@ services:
       - "traefik.http.middlewares.crowdsec-foo.plugin.bouncer.crowdseclapikey=40796d93c2958f9e58345514e67740e5"
       - "traefik.http.middlewares.crowdsec-foo.plugin.bouncer.rediscacheenabled=true"
       # Contact redis-unsecure without a password
-      - "traefik.http.middlewares.crowdsec-foo.plugin.bouncer.redisCacheHost=redis-insecure:6379"
+      - "traefik.http.middlewares.crowdsec-foo.plugin.bouncer.rediscachehost=redis-insecure:6379"
       - "traefik.http.middlewares.crowdsec-foo.plugin.bouncer.loglevel=DEBUG"
 
   whoami-redis-secure:
@@ -67,9 +67,9 @@ services:
       # crowdseclapikey must be uniq to the middleware attached to the service
       - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.crowdseclapikey=44c36dac5c4140af9f06f397508e82c7"
       - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.rediscacheenabled=true"
-      - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.redisCachePassword=FIXME"
+      - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.rediscachepassword=FIXME"
       # Contact redis-secure with password
-      - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.redisCacheHost=redis-secure:6379"
+      - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.rediscachehost=redis-secure:6379"
       - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.loglevel=DEBUG"
 
 

exemples/standalone-mode/docker-compose.alone.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   traefik:
-    image: "traefik:v2.9.6"
+    image: "traefik:v2.9.10"
     container_name: "traefik"
     restart: unless-stopped
     command:
@@ -15,7 +15,7 @@ services:
       - "--entrypoints.web.address=:80"
 
       - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
-      - "--experimental.plugins.bouncer.version=v1.1.7"
+      - "--experimental.plugins.bouncer.version=v1.1.11"
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
     ports:

exemples/tls-auth/docker-compose.tls-auth.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   traefik:
-    image: "traefik:v2.9.6"
+    image: "traefik:v2.9.10"
     container_name: "traefik"
     restart: unless-stopped
     command:
@@ -15,7 +15,7 @@ services:
       - "--entrypoints.web.address=:80"
 
       - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
-      - "--experimental.plugins.bouncer.version=v1.1.7"
+      - "--experimental.plugins.bouncer.version=v1.1.11"
       # - "--experimental.localplugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
@@ -64,7 +64,7 @@ services:
       - "traefik.http.middlewares.crowdsec-bar.plugin.bouncer.crowdsecLapiTLSCertificateBouncerKeyFile=/etc/traefik/crowdsec-certs/bouncer-key.pem"
 
   crowdsec:
-    image: crowdsecurity/crowdsec:v1.4.3
+    image: crowdsecurity/crowdsec:v1.4.6
     container_name: "crowdsec"
     restart: unless-stopped
     environment:

exemples/trusted-ips/docker-compose.trusted.yml

@@ -2,7 +2,7 @@ version: "3.8"
 
 services:
   traefik:
-    image: "traefik:v2.9.6"
+    image: "traefik:v2.9.10"
     container_name: "traefik"
     restart: unless-stopped
     command:
@@ -15,7 +15,7 @@ services:
       - "--entrypoints.web.address=:80"
 
       - "--experimental.plugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
-      - "--experimental.plugins.bouncer.version=v1.1.7"
+      - "--experimental.plugins.bouncer.version=v1.1.11"
       # - "--experimental.localplugins.bouncer.modulename=github.com/maxlerebourg/crowdsec-bouncer-traefik-plugin"
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
@@ -69,7 +69,7 @@ services:
 
 
   crowdsec:
-    image: crowdsecurity/crowdsec:v1.4.3
+    image: crowdsecurity/crowdsec:v1.4.6
     container_name: "crowdsec"
     restart: unless-stopped
     environment:

go.mod

@@ -4,5 +4,5 @@ go 1.19
 
 require (
 	github.com/leprosus/golang-ttl-map v1.1.7
-	github.com/maxlerebourg/simpleredis v1.0.6
+	github.com/maxlerebourg/simpleredis v1.0.7
 )

go.sum

@@ -1,4 +1,4 @@
 github.com/leprosus/golang-ttl-map v1.1.7 h1:cF4AAFDDnJTFSV+/42sKLhmMluvLdRlCGS2UaifH6UM=
 github.com/leprosus/golang-ttl-map v1.1.7/go.mod h1:4QWHJPeVBbrkhOhXdhCv9IEiyj/YzkO04/iexy4vSe0=
-github.com/maxlerebourg/simpleredis v1.0.6 h1:dKd0hgKk7uGKjujWUMuPTVOAONYdlCys5Iqh6w3dOU4=
+github.com/maxlerebourg/simpleredis v1.0.7 h1:d53p3GOIgQtxxWuqsWMGTJ0dZjP8UhiDX8L1q2QZ/vY=
-github.com/maxlerebourg/simpleredis v1.0.6/go.mod h1:/DH8zOK6kDskSqoX/m5CJJdNGfkIQZd/ERBJgytDDSk=
+github.com/maxlerebourg/simpleredis v1.0.7/go.mod h1:/DH8zOK6kDskSqoX/m5CJJdNGfkIQZd/ERBJgytDDSk=

pkg/cache/cache.go

@@ -82,9 +82,9 @@ type Client struct {
 }
 
 // New Initialize cache client.
-func (client *Client) New(isRedis bool, host string, pass string) {
+func (client *Client) New(isRedis bool, host, pass, database string) {
 	if isRedis {
-		redis.Init(host, pass)
+		redis.Init(host, pass, database)
 		client.cache = &redisCache{}
 	} else {
 		client.cache = &localCache{}

pkg/configuration/configuration.go

@@ -57,6 +57,7 @@ type Config struct {
 	RedisCacheHost                           string   `json:"redisCacheHost,omitempty"`
 	RedisCachePassword                       string   `json:"redisCachePassword,omitempty"`
 	RedisCachePasswordFile                   string   `json:"redisCachePasswordFile,omitempty"`
+	RedisCacheDatabase                       string   `json:"redisCacheDatabase,omitempty"`
 }
 
 func contains(source []string, target string) bool {
@@ -86,6 +87,7 @@ func New() *Config {
 		RedisCacheEnabled:             false,
 		RedisCacheHost:                "redis:6379",
 		RedisCachePassword:            "",
+		RedisCacheDatabase:            "",
 	}
 }
 

vendor/github.com/maxlerebourg/simpleredis/README.md

@@ -9,7 +9,7 @@ import simpleredis "github.com/maxlerebourg/simpleredis"
 
 var redis simpleredis.SimpleRedis
 
-redis.Init("redis:6379", "") // redisHost, redisPass
+redis.Init("redis:6379", "", "") // redisHost, redisPass, redisDatabase
 
 err := redis.Set("test", []bytes("whatever"), 60),  // Set key "test" with "whatever" for 60 seconds
 if err != nil {

vendor/github.com/maxlerebourg/simpleredis/simpleredis.go

@@ -31,8 +31,9 @@ type redisCmd struct {
 
 // A SimpleRedis is used to communicate with redis.
 type SimpleRedis struct {
-	host string
+	host     string
-	pass string
+	pass     string
+	database string
 }
 
 func genRedisArray(params ...[]byte) []byte {
@@ -51,7 +52,25 @@ func send(wr *textproto.Writer, method string, data []byte) {
 	}
 }
 
-func askRedis(sr *SimpleRedis, cmd redisCmd, channel chan redisCmd) {
+func (sr *SimpleRedis) waitRedis(reader *textproto.Reader, channel chan redisCmd) {
+	for {
+		select {
+		case <-time.After(time.Second * 1):
+			channel <- redisCmd{Error: fmt.Errorf(RedisTimeout)}
+			return
+		default:
+			read, _ := reader.ReadLineBytes()
+			if string(read) != "+OK" {
+				channel <- redisCmd{Error: fmt.Errorf(RedisNoAuth)}
+				return
+			}
+		}
+		// breaks out of for
+		break
+	}
+}
+
+func (sr *SimpleRedis) askRedis(cmd redisCmd, channel chan redisCmd) {
 	dialer := net.Dialer{Timeout: 2 * time.Second}
 	conn, err := dialer.Dial("tcp", sr.host)
 	if err != nil {
@@ -70,21 +89,13 @@ func askRedis(sr *SimpleRedis, cmd redisCmd, channel chan redisCmd) {
 	if sr.pass != "" {
 		data := genRedisArray([]byte("AUTH"), []byte(sr.pass))
 		send(writer, "auth", data)
-		for {
+		sr.waitRedis(reader, channel)
-			select {
+	}
-			case <-time.After(time.Second * 1):
+
-				channel <- redisCmd{Error: fmt.Errorf(RedisTimeout)}
+	if sr.database != "" {
-				return
+		data := genRedisArray([]byte("SELECT"), []byte(sr.database))
-			default:
+		send(writer, "select", data)
-				read, _ := reader.ReadLineBytes()
+		sr.waitRedis(reader, channel)
-				if string(read) != "+OK" {
-					channel <- redisCmd{Error: fmt.Errorf(RedisNoAuth)}
-					return
-				}
-			}
-			// breaks out of for
-			break
-		}
 	}
 
 	switch cmd.Command {
@@ -121,9 +132,10 @@ func askRedis(sr *SimpleRedis, cmd redisCmd, channel chan redisCmd) {
 }
 
 // Init sets the redisHost used to connect to redis.
-func (sr *SimpleRedis) Init(host string, pass string) {
+func (sr *SimpleRedis) Init(host, pass, database string) {
 	sr.host = host
 	sr.pass = pass
+	sr.database = database
 }
 
 // Get fetches the value for key name in redis.
@@ -133,7 +145,7 @@ func (sr *SimpleRedis) Get(name string) ([]byte, error) {
 		Name:    name,
 	}
 	channel := make(chan redisCmd)
-	go askRedis(sr, cmd, channel)
+	go sr.askRedis(cmd, channel)
 	resp := <-channel
 	if resp.Error != nil {
 		return nil, resp.Error
@@ -149,7 +161,7 @@ func (sr *SimpleRedis) Set(name string, data []byte, duration int64) error {
 		Data:     data,
 		Duration: duration,
 	}
-	go askRedis(sr, cmd, nil)
+	go sr.askRedis(cmd, nil)
 	return nil
 }
 
@@ -159,6 +171,6 @@ func (sr *SimpleRedis) Del(name string) error {
 		Command: "DEL",
 		Name:    name,
 	}
-	go askRedis(sr, cmd, nil)
+	go sr.askRedis(cmd, nil)
 	return nil
 }

vendor/modules.txt

@@ -1,6 +1,6 @@
 # github.com/leprosus/golang-ttl-map v1.1.7
 ## explicit; go 1.15
 github.com/leprosus/golang-ttl-map
-# github.com/maxlerebourg/simpleredis v1.0.6
+# github.com/maxlerebourg/simpleredis v1.0.7
 ## explicit; go 1.19
 github.com/maxlerebourg/simpleredis