feat: changes on captcha behavior

captchaToken is now optionnal in GraphQL send request
captcha verify url is now configurable
captcha min score is now configurable
add errors to log context when logging errors
using context when requesting captcha verification

cmd/root.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"os"
+	"strings"
 
 	"okp4/cosmos-faucet/pkg"
 
@@ -71,6 +72,7 @@ func ReadPersistentFlags(cmd *cobra.Command) error {
 	}
 	v.SetEnvPrefix(envPrefix)
 	v.AutomaticEnv()
+	v.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 
 	cmd.Flags().VisitAll(func(f *pflag.Flag) {
 		if !f.Changed && v.IsSet(f.Name) {

cmd/start.go

@@ -1,8 +1,6 @@
 package cmd
 
 import (
-	"os"
-
 	"okp4/cosmos-faucet/internal/server"
 	"okp4/cosmos-faucet/pkg/client"
 
@@ -15,6 +13,8 @@ const (
 	FlagMetrics       = "metrics"
 	FlagHealth        = "health"
 	FlagCaptchaSecret = "captcha-secret"
+	FlagCaptchaURL    = "captcha-verify-url"
+	FlagCaptchaScore  = "captcha-min-score"
 )
 
 var serverConfig server.Config
@@ -48,8 +48,20 @@ func NewStartCommand() *cobra.Command {
 	startCmd.Flags().StringVar(
 		&serverConfig.CaptchaSecret,
 		FlagCaptchaSecret,
-		os.Getenv("CAPTCHA_SECRET"),
-		"set Captcha secret (default from env: CAPTCHA_SECRET)",
+		"",
+		"set Captcha secret",
+	)
+	startCmd.Flags().StringVar(
+		&serverConfig.CaptchaVerifyURL,
+		FlagCaptchaURL,
+		"https://www.google.com/recaptcha/api/siteverify",
+		"set Captcha verify URL",
+	)
+	startCmd.Flags().Float64Var(
+		&serverConfig.CaptchaMinScore,
+		FlagCaptchaScore,
+		0.5,
+		"set Captcha min score",
 	)
 
 	return startCmd

graph/schema.graphqls

@@ -13,7 +13,7 @@ scalar UInt64
 """All inputs needed to send token to a given address"""
 input SendInput {
     """Captcha token"""
-    captchaToken: String!
+    captchaToken: String
     """Address where to send token(s)"""
     toAddress: Address!
 }

graph/schema.resolvers.go

@@ -5,6 +5,7 @@ package graph
 
 import (
 	"context"
+	"errors"
 	"okp4/cosmos-faucet/graph/generated"
 	"okp4/cosmos-faucet/graph/model"
 
@@ -13,8 +14,12 @@ import (
 )
 
 func (r *mutationResolver) Send(ctx context.Context, input model.SendInput) (*model.TxResponse, error) {
-	if err := r.CaptchaResolver.CheckRecaptcha(input.CaptchaToken); err != nil {
-		return nil, err
+	if input.CaptchaToken != nil {
+		if err := r.CaptchaResolver.CheckRecaptcha(ctx, *input.CaptchaToken); err != nil {
+			return nil, err
+		}
+	} else {
+		return nil, errors.New("captcha token not specified")
 	}
 
 	resp, err := r.Faucet.SendTxMsg(ctx, input.ToAddress)

graph/schema.resolvers_test.go

@@ -54,7 +54,7 @@ func newMockCaptchaResolver() captcha.Resolver {
 	return mockCaptchaResolver{}
 }
 
-func (r mockCaptchaResolver) CheckRecaptcha(_ string) error {
+func (r mockCaptchaResolver) CheckRecaptcha(_ context.Context, _ string) error {
 	return nil
 }
 

internal/captcha/captcha.go

@@ -1,20 +1,22 @@
 package captcha
 
-import "github.com/rs/zerolog/log"
+import (
+	"context"
 
-type Resolver interface {
-	CheckRecaptcha(string) error
-}
+	"github.com/rs/zerolog/log"
+)
 
-type resolver struct {
-	secret string
+type Resolver interface {
+	CheckRecaptcha(context.Context, string) error
 }
 
-func NewCaptchaResolver(secret string) Resolver {
+func NewCaptchaResolver(secret, verifyURL string, minScore float64) Resolver {
 	if secret == "" {
-		log.Fatal().Msg("Required Captcha secret not set")
+		log.Error().Msg("Required Captcha secret not set")
 	}
 	return resolver{
-		secret: secret,
+		secret:        secret,
+		siteVerifyURL: verifyURL,
+		minScore:      minScore,
 	}
 }

internal/captcha/verify.go

@@ -1,6 +1,7 @@
 package captcha
 
 import (
+	"context"
 	"encoding/json"
 	"errors"
 	"fmt"
@@ -10,8 +11,6 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
-const siteVerifyURL = "https://www.google.com/recaptcha/api/siteverify"
-
 type siteVerifyResponse struct {
 	Success     bool      `json:"success"`
 	Score       float64   `json:"score"`
@@ -21,10 +20,16 @@ type siteVerifyResponse struct {
 	ErrorCodes  []string  `json:"error-codes"`
 }
 
-func (c resolver) CheckRecaptcha(response string) error {
-	req, err := http.NewRequest(http.MethodPost, siteVerifyURL, nil)
+type resolver struct {
+	secret        string
+	siteVerifyURL string
+	minScore      float64
+}
+
+func (c resolver) CheckRecaptcha(ctx context.Context, response string) error {
+	req, err := http.NewRequestWithContext(ctx, http.MethodPost, c.siteVerifyURL, nil)
 	if err != nil {
-		log.Error().Msgf("Error while creating Captcha verification request: %s", err.Error())
+		log.Error().Err(err).Msgf("Error while creating Captcha verification request: %s", err.Error())
 		return fmt.Errorf("error while creating Captcha verification request: %w", err)
 	}
 
@@ -35,14 +40,14 @@ func (c resolver) CheckRecaptcha(response string) error {
 
 	resp, err := http.DefaultClient.Do(req)
 	if err != nil {
-		log.Error().Msgf("Error while requesting Captcha verification: %s", err.Error())
+		log.Error().Err(err).Msgf("Error while requesting Captcha verification: %s", err.Error())
 		return fmt.Errorf("error while requesting Captcha verification: %w", err)
 	}
 	defer resp.Body.Close()
 
 	var body siteVerifyResponse
 	if err = json.NewDecoder(resp.Body).Decode(&body); err != nil {
-		log.Error().Msgf("Error while decoding Captcha verification response: %s", err.Error())
+		log.Error().Err(err).Msgf("Error while decoding Captcha verification response: %s", err.Error())
 		return fmt.Errorf("error while decoding Captcha verification response: %w", err)
 	}
 
@@ -53,8 +58,8 @@ func (c resolver) CheckRecaptcha(response string) error {
 	}
 
 	// If score is too low, verification KO.
-	if body.Score > 0.5 {
-		log.Debug().Msg("Captcha verification failed: score is too low")
+	if body.Score < c.minScore {
+		log.Debug().Float64("score", body.Score).Msg("Captcha verification failed: score is too low")
 		return errors.New("captcha verification failed: score is too low")
 	}
 

internal/server/router.go

@@ -20,8 +20,12 @@ func (s *httpServer) createRoutes(config Config) {
 			graphql.NewDefaultServer(
 				generated.NewExecutableSchema(generated.Config{
 					Resolvers: &graph.Resolver{
-						Faucet:          config.Faucet,
-						CaptchaResolver: captcha.NewCaptchaResolver(config.CaptchaSecret),
+						Faucet: config.Faucet,
+						CaptchaResolver: captcha.NewCaptchaResolver(
+							config.CaptchaSecret,
+							config.CaptchaVerifyURL,
+							config.CaptchaMinScore,
+						),
 					},
 				}),
 			),

internal/server/server.go

@@ -10,10 +10,12 @@ import (
 
 // Config holds config of the http server.
 type Config struct {
-	EnableMetrics bool `mapstructure:"metrics"`
-	EnableHealth  bool `mapstructure:"health"`
-	Faucet        client.Faucet
-	CaptchaSecret string `mapstructure:"captcha-secret"`
+	EnableMetrics    bool `mapstructure:"metrics"`
+	EnableHealth     bool `mapstructure:"health"`
+	Faucet           client.Faucet
+	CaptchaSecret    string  `mapstructure:"captcha-secret"`
+	CaptchaVerifyURL string  `mapstructure:"captcha-verify-url"`
+	CaptchaMinScore  float64 `mapstructure:"captcha-min-score"`
 }
 
 // HTTPServer exposes server methods.