✨ Implement captcha protection (#139)

* ✨ Implement captcha protection * 🍱 fix lint * 🍱 fix lint * 🍱 fix lint * 📝 Update exemple doc Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Add doc for the captcha and update some exemples Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Update doc readme with some arguments Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Update doc Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 generic documentation in readme on catpcha feature Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Update exemple captcha Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Fix rendering and typos Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 🍱 fix readme * 📝 update doc ongoing Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Add doc on crowdsec config Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Add sequence diagram for captcha exemple Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * Fix rendering and typos Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 add mermaid basics graphs Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Update first diagram Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Update first seq diagram Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 🐛 Fix bug in diagram syntax Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 rework all diagrams Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 📝 Update a bit diagrams Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> * 🌐 Fix lang fr * 🚸 change advice on uniq lapi confusing for users * ✅ Fix test du to rework on cache interface * 🚨 Fix lint --------- Signed-off-by: Mathieu Hanotaux <mathieu@hanotaux.fr> Co-authored-by: max.lerebourg <max.lerebourg@monisnap.com> Co-authored-by: Mathieu Hanotaux <mathieu@hanotaux.fr>
2026-07-21 11:38:59 +02:00 · 2024-04-01 11:41:28 +02:00
parent c3e0c2d4c3
commit 497d1a2928
24 changed files with 1413 additions and 184 deletions
@@ -19,13 +19,16 @@ import (

 // Enums for crowdsec mode.
 const (
-	AloneMode  = "alone"
-	StreamMode = "stream"
-	LiveMode   = "live"
-	NoneMode   = "none"
-	AppsecMode = "appsec"
-	HTTPS      = "https"
-	HTTP       = "http"
+	AloneMode         = "alone"
+	StreamMode        = "stream"
+	LiveMode          = "live"
+	NoneMode          = "none"
+	AppsecMode        = "appsec"
+	HTTPS             = "https"
+	HTTP              = "http"
+	HcaptchaProvider  = "hcaptcha"
+	RecaptchaProvider = "recaptcha"
+	TurnstileProvider = "turnstile"
 )

 // Config the plugin configuration.
@@ -63,6 +66,13 @@ type Config struct {
 	RedisCachePassword                       string   `json:"redisCachePassword,omitempty"`
 	RedisCachePasswordFile                   string   `json:"redisCachePasswordFile,omitempty"`
 	RedisCacheDatabase                       string   `json:"redisCacheDatabase,omitempty"`
+	CaptchaHTMLFilePath                      string   `json:"captchaHtmlFilePath,omitempty"`
+	CaptchaProvider                          string   `json:"captchaProvider,omitempty"`
+	CaptchaSiteKey                           string   `json:"captchaSiteKey,omitempty"`
+	CaptchaSiteKeyFile                       string   `json:"captchaSiteKeyFile,omitempty"`
+	CaptchaSecretKey                         string   `json:"captchaSecretKey,omitempty"`
+	CaptchaSecretKeyFile                     string   `json:"captchaSecretKeyFile,omitempty"`
+	CaptchaGracePeriodSeconds                int64    `json:"captchaGracePeriodSeconds,omitempty"`
 }

 func contains(source []string, target string) bool {
@@ -90,6 +100,11 @@ func New() *Config {
 		UpdateIntervalSeconds:         60,
 		DefaultDecisionSeconds:        60,
 		HTTPTimeoutSeconds:            10,
+		CaptchaProvider:               "",
+		CaptchaSiteKey:                "",
+		CaptchaSecretKey:              "",
+		CaptchaHTMLFilePath:           "/captcha.html",
+		CaptchaGracePeriodSeconds:     1800,
 		ForwardedHeadersCustomName:    "X-Forwarded-For",
 		ForwardedHeadersTrustedIPs:    []string{},
 		ClientTrustedIPs:              []string{},
@@ -156,6 +171,15 @@ func ValidateParams(config *Config) error {
 		return nil
 	}

+	if config.CaptchaProvider != "" {
+		if _, err := GetVariable(config, "CaptchaSiteKey"); err != nil {
+			return err
+		}
+		if _, err := GetVariable(config, "CaptchaSecretKey"); err != nil {
+			return err
+		}
+	}
+
 	if err := validateURL("CrowdsecLapi", config.CrowdsecLapiScheme, config.CrowdsecLapiHost); err != nil {
 		return err
 	}
@@ -254,9 +278,10 @@ func validateParamsRequired(config *Config) error {
 		}
 	}
 	requiredInt := map[string]int64{
-		"UpdateIntervalSeconds":  config.UpdateIntervalSeconds,
-		"DefaultDecisionSeconds": config.DefaultDecisionSeconds,
-		"HTTPTimeoutSeconds":     config.HTTPTimeoutSeconds,
+		"UpdateIntervalSeconds":     config.UpdateIntervalSeconds,
+		"DefaultDecisionSeconds":    config.DefaultDecisionSeconds,
+		"HTTPTimeoutSeconds":        config.HTTPTimeoutSeconds,
+		"CaptchaGracePeriodSeconds": config.CaptchaGracePeriodSeconds,
 	}
 	for key, val := range requiredInt {
 		if val < 1 {
@@ -269,6 +294,9 @@ func validateParamsRequired(config *Config) error {
 	if !contains([]string{HTTP, HTTPS}, config.CrowdsecLapiScheme) {
 		return fmt.Errorf("CrowdsecLapiScheme: must be one of 'http' or 'https'")
 	}
+	if !contains([]string{"", HcaptchaProvider, RecaptchaProvider, TurnstileProvider}, config.CaptchaProvider) {
+		return fmt.Errorf("CrowdsecLapiScheme: must be one of 'hcaptcha', 'recaptcha' or 'turnstile'")
+	}
 	return nil
 }