[CAPTCHA] Replace ReCAPTCHA with Turnstile

.github/workflows/deploy_qa.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      #- turnstile
 
 permissions:
   contents: read
@@ -94,7 +95,7 @@ jobs:
   deploy_update:
     needs: build
     # Only push to the QA server when built on the master branch
-    if: ${{ github.ref_name == 'master' }}
+    #if: ${{ github.ref_name == 'master' }}
     runs-on: [self-hosted, thecombine]
     steps:
       - name: Harden Runner

.vscode/settings.json

@@ -73,7 +73,6 @@
     "piptools",
     "Prenoun",
     "Preverb",
-    "recaptcha",
     "reportgenerator",
     "sched",
     "signup",

Backend.Tests/Controllers/UserControllerTests.cs

@@ -35,7 +35,7 @@ public void Setup()
             _userRepo = new UserRepositoryMock();
             _permissionService = new PermissionServiceMock(_userRepo);
             _userController = new UserController(_userRepo, _permissionService,
-                new EmailServiceMock(), new PasswordResetServiceMock());
+                new EmailServiceMock(), new PasswordResetServiceMock(), new TurnstileServiceMock());
         }
 
         private static User RandomUser()

Backend.Tests/Mocks/TurnstileServiceMock.cs

@@ -0,0 +1,13 @@
+using System.Threading.Tasks;
+using BackendFramework.Interfaces;
+
+namespace Backend.Tests.Mocks
+{
+    sealed internal class TurnstileServiceMock : ITurnstileService
+    {
+        public Task<bool> VerifyToken(string token)
+        {
+            return Task.FromResult(true);
+        }
+    }
+}

Backend/Contexts/TurnstileContext.cs

@@ -0,0 +1,19 @@
+using System.Diagnostics.CodeAnalysis;
+using BackendFramework.Interfaces;
+using Microsoft.Extensions.Options;
+
+namespace BackendFramework.Contexts
+{
+    [ExcludeFromCodeCoverage]
+    public class TurnstileContext : ITurnstileContext
+    {
+        public string? TurnstileSecretKey { get; }
+        public string? TurnstileVerifyUrl { get; }
+
+        public TurnstileContext(IOptions<Startup.Settings> options)
+        {
+            TurnstileSecretKey = options.Value.TurnstileSecretKey;
+            TurnstileVerifyUrl = options.Value.TurnstileVerifyUrl;
+        }
+    }
+}

Backend/Controllers/UserController.cs

@@ -21,14 +21,25 @@ public class UserController : Controller
         private readonly IEmailService _emailService;
         private readonly IPasswordResetService _passwordResetService;
         private readonly IPermissionService _permissionService;
+        private readonly ITurnstileService _turnstileService;
 
         public UserController(IUserRepository userRepo, IPermissionService permissionService,
-            IEmailService emailService, IPasswordResetService passwordResetService)
+            IEmailService emailService, IPasswordResetService passwordResetService, ITurnstileService turnstileService)
         {
             _userRepo = userRepo;
             _emailService = emailService;
             _passwordResetService = passwordResetService;
             _permissionService = permissionService;
+            _turnstileService = turnstileService;
+        }
+
+        /// <summary> Validates a Cloudflare Turnstile token </summary>
+        [AllowAnonymous]
+        [HttpGet("turnstile/{token}", Name = "ValidateTurnstile")]
+        [ProducesResponseType(StatusCodes.Status200OK)]
+        public async Task<IActionResult> ValidateTurnstile(string token)
+        {
+            return await _turnstileService.VerifyToken(token) ? Ok() : BadRequest();
         }
 
         /// <summary> Sends a password reset request </summary>

Backend/Interfaces/ITurnstileContext.cs

@@ -0,0 +1,8 @@
+namespace BackendFramework.Interfaces
+{
+    public interface ITurnstileContext
+    {
+        string? TurnstileSecretKey { get; }
+        string? TurnstileVerifyUrl { get; }
+    }
+}

Backend/Interfaces/ITurnstileService.cs

@@ -0,0 +1,9 @@
+using System.Threading.Tasks;
+
+namespace BackendFramework.Interfaces
+{
+    public interface ITurnstileService
+    {
+        Task<bool> VerifyToken(string token);
+    }
+}

Backend/Properties/launchSettings.json

@@ -14,7 +14,10 @@
       "launchBrowser": true,
       "launchUrl": "v1",
       "environmentVariables": {
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "COMBINE_JWT_SECRET_KEY": "0123456789abcdefghijklmnopqrstuvwxyz",
+        "TURNSTILE_SECRET_KEY": "1x0000000000000000000000000000000AA",
+        "TURNSTILE_VERIFY_URL": "challenges.cloudflare.com/turnstile/v0/siteverify"
       }
     },
     "BackendFramework": {
@@ -23,7 +26,10 @@
       "launchUrl": "v1/",
       "environmentVariables": {
         "Key": "Value",
-        "ASPNETCORE_ENVIRONMENT": "Development"
+        "ASPNETCORE_ENVIRONMENT": "Development",
+        "COMBINE_JWT_SECRET_KEY": "0123456789abcdefghijklmnopqrstuvwxyz",
+        "TURNSTILE_SECRET_KEY": "1x0000000000000000000000000000000AA",
+        "TURNSTILE_VERIFY_URL": "challenges.cloudflare.com/turnstile/v0/siteverify"
       },
       "applicationUrl": "http://localhost:5000",
       "hotReloadProfile": "aspnetcore"

Backend/Services/TurnstileService.cs

@@ -0,0 +1,38 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Net.Http;
+using System.Threading.Tasks;
+using BackendFramework.Interfaces;
+
+namespace BackendFramework.Services
+{
+    [ExcludeFromCodeCoverage]
+    public class TurnstileService : ITurnstileService
+    {
+        private readonly ITurnstileContext _turnstileContext;
+
+        public TurnstileService(ITurnstileContext turnstileContext)
+        {
+            _turnstileContext = turnstileContext;
+        }
+
+        public async Task<bool> VerifyToken(string token)
+        {
+            var secret = _turnstileContext.TurnstileSecretKey;
+            var verifyUrl = _turnstileContext.TurnstileVerifyUrl;
+            if (string.IsNullOrEmpty(secret) || string.IsNullOrEmpty(verifyUrl))
+            {
+                return false;
+            }
+            var httpContent = new FormUrlEncodedContent(new Dictionary<string, string>{
+               {"response", token},
+               {"secret", secret},
+            });
+            using var result = await new HttpClient().PostAsync(verifyUrl, httpContent);
+            var contentString = await result.Content.ReadAsStringAsync();
+            Console.WriteLine($"content: {contentString}");
+            return contentString.Contains("\"success\":true");
+        }
+    }
+}

Backend/Startup.cs

@@ -48,6 +48,8 @@ public class Settings
             public string? SmtpAddress { get; set; }
             public string? SmtpFrom { get; set; }
             public int PassResetExpireTime { get; set; }
+            public string? TurnstileSecretKey { get; set; }
+            public string? TurnstileVerifyUrl { get; set; }
 
             public Settings()
             {
@@ -178,10 +180,21 @@ public void ConfigureServices(IServiceCollection services)
                         "COMBINE_SMTP_FROM",
                         null,
                         emailServiceFailureMessage);
+
                     options.PassResetExpireTime = int.Parse(CheckedEnvironmentVariable(
                         "COMBINE_PASSWORD_RESET_EXPIRE_TIME",
                         Settings.DefaultPasswordResetExpireTime.ToString(),
                         $"Using default value: {Settings.DefaultPasswordResetExpireTime}")!);
+
+                    const string turnstileFailureMessage = "Turnstile verification will not be available.";
+                    options.TurnstileSecretKey = CheckedEnvironmentVariable(
+                        "TURNSTILE_SECRET_KEY",
+                        null,
+                        turnstileFailureMessage);
+                    options.TurnstileVerifyUrl = CheckedEnvironmentVariable(
+                        "TURNSTILE_VERIFY_URL",
+                        null,
+                        turnstileFailureMessage);
                 });
 
             // Register concrete types for dependency injection
@@ -228,6 +241,10 @@ public void ConfigureServices(IServiceCollection services)
             // Statistics types
             services.AddSingleton<IStatisticsService, StatisticsService>();
 
+            // Turnstile types
+            services.AddTransient<ITurnstileContext, TurnstileContext>();
+            services.AddTransient<ITurnstileService, TurnstileService>();
+
             // User types
             services.AddTransient<IUserContext, UserContext>();
             services.AddTransient<IUserRepository, UserRepository>();

README.md

@@ -142,11 +142,9 @@ A rapid word collection tool. See the [User Guide](https://sillsdev.github.io/Th
 
 ### Prepare the Environment
 
-1. Set the environment variable `COMBINE_JWT_SECRET_KEY` to a string **containing at least 32 characters**, such as
-   _This is a secret key that is longer_. Set it in your `.profile` (Linux or Mac 10.14-), your `.zprofile` (Mac
-   10.15+), or the _System_ app (Windows).
-2. If you want the email services to work you will need to set the following environment variables. These values must be
-   kept secret, so ask your email administrator to supply them.
+1. If you want the email services to work you will need to set the following environment variables. These values must be
+   kept secret, so ask your email administrator to supply them. Set them in your `.profile` (Linux or Mac 10.14-), your
+   `.zprofile` (Mac 10.15+), or the _System_ app (Windows).
 
    - `COMBINE_SMTP_SERVER`
    - `COMBINE_SMTP_PORT`
@@ -155,16 +153,16 @@ A rapid word collection tool. See the [User Guide](https://sillsdev.github.io/Th
    - `COMBINE_SMTP_ADDRESS`
    - `COMBINE_SMTP_FROM`
 
-3. _(Optional)_ To opt in to segment.com analytics to test the analytics during development:
+2. _(Optional)_ To opt in to segment.com analytics to test the analytics during development:
 
    ```bash
    # For Windows, use `copy`.
    cp .env.local.template .env.local
    ```
 
-4. Run `npm start` from the project directory to install dependencies and start the project.
+3. Run `npm start` from the project directory to install dependencies and start the project.
 
-5. Consult our [C#](docs/style_guide/c_sharp_style_guide.md) and [TypeScript](docs/style_guide/ts_style_guide.md) style
+4. Consult our [C#](docs/style_guide/c_sharp_style_guide.md) and [TypeScript](docs/style_guide/ts_style_guide.md) style
    guides for best coding practices in this project.
 
 [chocolatey]: https://chocolatey.org/

deploy/helm/thecombine/charts/backend/templates/backend-config-map.yaml

@@ -11,3 +11,4 @@ data:
   COMBINE_SMTP_FROM: {{ .Values.combineSmtpFrom | quote }}
   COMBINE_SMTP_PORT: {{ .Values.combineSmtpPort | quote }}
   COMBINE_SMTP_SERVER: {{ .Values.combineSmtpServer | quote }}
+  TURNSTILE_VERIFY_URL: {{ .Values.turnstileVerifyUrl | quote }}

deploy/helm/thecombine/charts/backend/templates/backend-secrets.yaml

@@ -9,3 +9,4 @@ data:
   COMBINE_JWT_SECRET_KEY: {{ .Values.global.combineJwtSecretKey | b64enc }}
   COMBINE_SMTP_USERNAME: {{ .Values.global.combineSmtpUsername | b64enc }}
   COMBINE_SMTP_PASSWORD: {{ .Values.global.combineSmtpPassword | b64enc }}
+  TURNSTILE_SECRET_KEY: {{ .Values.global.turnstileSecretKey | b64enc }}

deploy/helm/thecombine/charts/backend/templates/deployment-backend.yaml

@@ -69,6 +69,16 @@ spec:
                 secretKeyRef:
                   key: COMBINE_SMTP_USERNAME
                   name: env-backend-secrets
+            - name: TURNSTILE_SECRET_KEY
+              valueFrom:
+                secretKeyRef:
+                  key: TURNSTILE_SECRET_KEY
+                  name: env-backend-secrets
+            - name: TURNSTILE_VERIFY_URL
+              valueFrom:
+                configMapKeyRef:
+                  key: TURNSTILE_VERIFY_URL
+                  name: env-backend
           ports:
             - containerPort: 5000
           resources:

deploy/helm/thecombine/charts/backend/values.yaml

@@ -21,11 +21,14 @@ global:
   combineJwtSecretKey: "Override"
   combineSmtpUsername: "Override"
   combineSmtpPassword: "Override"
+  combineTurnstileSecretKey: "Override"
   # Values for pulling container image from image registry
   imagePullPolicy: "Override"
   imageTag: "latest"
   # Define the image registry to use (may be blank for local images)
   imageRegistry: ""
+  # Cloudflare Turnstile verification
+  turnstileSecretKey: "Override"
 
 persistentVolumeSize: 32Gi
 combinePasswordResetTime: 15
@@ -34,3 +37,4 @@ combineSmtpFrom: "The Combine"
 combineSmtpPort: 587
 combineSmtpServer: "email-smtp.us-east-1.amazonaws.com"
 imageName: combine_backend
+turnstileVerifyUrl: "challenges.cloudflare.com/turnstile/v0/siteverify"

deploy/helm/thecombine/values.yaml

@@ -38,6 +38,8 @@ global:
   pullSecretName: aws-login-credentials
   # Update strategy should be "Recreate" or "Rolling Update"
   updateStrategy: Recreate
+  # Cloudflare Turnstile verification
+  turnstileSecretKey: "Override"
 
   includeResourceLimits: false
 

deploy/scripts/setup_files/combine_config.yaml

@@ -156,6 +156,8 @@ charts:
         env_var: COMBINE_SMTP_USERNAME
       - config_item: combineSmtpPassword
         env_var: COMBINE_SMTP_PASSWORD
+      - config_item: turnstileSecretKey
+        env_var: TURNSTILE_SECRET_KEY
   create-admin-user:
     namespace: thecombine
     install_langs: false

docs/deploy/README.md

@@ -291,6 +291,7 @@ The setup scripts require the following environment variables to be set:
 - COMBINE_ADMIN_USERNAME
 - COMBINE_ADMIN_PASSWORD
 - COMBINE_ADMIN_EMAIL
+- TURNSTILE_SECRET_KEY
 
 You may also set the KUBECONFIG environment variable to the location of the `kubectl` configuration file. This is not
 necessary if the configuration file is at `${HOME}/.kube/config`.

docs/user_guide/assets/licenses/frontend_licenses.txt

@@ -972,29 +972,8 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
-@matt-block/react-recaptcha-v2 2.0.1
+@marsidev/react-turnstile 0.7.2
 MIT
-MIT License
-
-Copyright (c) 2018-present Matei Bogdan Radu <[email protected]>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
 
 
 @microsoft/signalr 8.0.0
@@ -43055,30 +43034,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
-nanoid 3.3.7
-MIT
-The MIT License (MIT)
-
-Copyright 2017 Andrey Sitnik <[email protected]>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
 new-date 1.0.3
 null
 Copyright (c) 2016 Segment.io, Inc.