feat: add captcha configuration and verification support

App/FeatureSet/Identity/API/Authentication.ts

@@ -38,6 +38,7 @@ import Express, {
   getClientIp,
   headerValueToString,
 } from "Common/Server/Utils/Express";
+import CaptchaUtil from "Common/Server/Utils/Captcha";
 import logger from "Common/Server/Utils/Logger";
 import Response from "Common/Server/Utils/Response";
 import TotpAuth from "Common/Server/Utils/TotpAuth";
@@ -107,6 +108,16 @@ router.post(
         );
       }
 
+      const miscDataProps: JSONObject =
+        (req.body["miscDataProps"] as JSONObject) || {};
+
+      await CaptchaUtil.verifyCaptcha({
+        token:
+          (miscDataProps["captchaToken"] as string | undefined) ||
+          (req.body["captchaToken"] as string | undefined),
+        remoteIp: getClientIp(req) || null,
+      });
+
       const data: JSONObject = req.body["data"];
 
       /* Creating a type that is a partial of the TBaseModel type. */

Common/Server/EnvironmentConfig.ts

@@ -44,6 +44,8 @@ const FRONTEND_ENV_ALLOW_LIST: Array<string> = [
   "DISABLE_TELEMETRY",
   "SLACK_APP_CLIENT_ID",
   "MICROSOFT_TEAMS_APP_CLIENT_ID",
+  "CAPTCHA_ENABLED",
+  "CAPTCHA_SITE_KEY",
 ];
 
 const FRONTEND_ENV_ALLOW_PREFIXES: Array<string> = [
@@ -324,6 +326,15 @@ export const Host: string = process.env["HOST"] || "";
 
 export const ProvisionSsl: boolean = process.env["PROVISION_SSL"] === "true";
 
+export const CaptchaEnabled: boolean =
+  process.env["CAPTCHA_ENABLED"] === "true";
+
+export const CaptchaSecretKey: string =
+  process.env["CAPTCHA_SECRET_KEY"] || "";
+
+export const CaptchaSiteKey: string =
+  process.env["CAPTCHA_SITE_KEY"] || "";
+
 export const WorkflowScriptTimeoutInMS: number = process.env[
   "WORKFLOW_SCRIPT_TIMEOUT_IN_MS"
 ]

Common/UI/Config.ts

@@ -51,6 +51,9 @@ export const IS_ENTERPRISE_EDITION: boolean =
   env("IS_ENTERPRISE_EDITION") === "true";
 export const BILLING_PUBLIC_KEY: string = env("BILLING_PUBLIC_KEY") || "";
 
+export const CAPTCHA_ENABLED: boolean = env("CAPTCHA_ENABLED") === "true";
+export const CAPTCHA_SITE_KEY: string = env("CAPTCHA_SITE_KEY") || "";
+
 // VAPID Configuration for Push Notifications
 export const VAPID_PUBLIC_KEY: string = env("VAPID_PUBLIC_KEY") || "";
 

config.example.env

@@ -15,6 +15,11 @@ ONEUPTIME_HTTP_PORT=80
 # If you prefer to terminate TLS on an external reverse proxy, leave PROVISION_SSL=false and manage certificates yourself.
 HTTP_PROTOCOL=http
 
+# Captcha configuration
+CAPTCHA_ENABLED=false
+CAPTCHA_SITE_KEY=
+CAPTCHA_SECRET_KEY=
+
 # Secrets - PLEASE CHANGE THESE. Please change these to something random. All of these can be different values.
 ONEUPTIME_SECRET=please-change-this-to-random-value
 DATABASE_PASSWORD=please-change-this-to-random-value