feat:add captcha

frontend/desktop/package.json

@@ -17,8 +17,10 @@
     "postinstall": "pnpm gen:global && pnpm gen:region"
   },
   "dependencies": {
+    "@alicloud/captcha20230305": "1.1.3",
     "@alicloud/dysmsapi20170525": "^2.0.24",
     "@alicloud/openapi-client": "^0.4.6",
+    "@alicloud/tea-typescript": "^1.8.0",
     "@alicloud/tea-util": "^1.4.7",
     "@chakra-ui/anatomy": "^2.2.1",
     "@chakra-ui/icons": "^2.1.1",

frontend/desktop/src/components/signin/Captcha/index.tsx

@@ -0,0 +1,107 @@
+import request from '@/services/request';
+import { useConfigStore } from '@/stores/config';
+import { Box, Button, ButtonProps, Link, LinkProps } from '@chakra-ui/react';
+import { delay } from 'lodash';
+import React, {
+  ReactElement,
+  forwardRef,
+  useEffect,
+  useId,
+  useImperativeHandle,
+  useRef,
+  useState
+} from 'react';
+import { v4 } from 'uuid';
+export type TCaptchaInstance = {
+  getToken: () => Promise<string>;
+  reset: () => void;
+};
+
+const HiddenCaptchaComponent = forwardRef(function HiddenCaptchaComponent(props, ref) {
+  const captchaElementRef = useRef<HTMLDivElement>(null);
+  const captchaInstanceRef = useRef(null);
+  const tokenRef = useRef('');
+  const buttonRef = useRef<HTMLButtonElement>(null);
+  const { authConfig } = useConfigStore();
+  useImperativeHandle<any, TCaptchaInstance>(
+    ref,
+    () => {
+      return {
+        getToken: async () => {
+          buttonRef.current?.click();
+          await new Promise((res) => {
+            setTimeout(res, 1000);
+          });
+          const token = tokenRef.current;
+          return token;
+        },
+        reset() {
+          tokenRef.current = '';
+        }
+      };
+    },
+    []
+  );
+
+  const [buttonId] = useState('captcha_button_pop');
+  const [captchaId] = useState('captcha_' + v4().slice(0, 8));
+
+  // @ts-ignore
+  const getInstance = (instance) => {
+    captchaInstanceRef.current = instance;
+  };
+
+  const onBizResultCallback = () => {};
+  useEffect(() => {
+    const initAliyunCaptchaOptions = {
+      SceneId: authConfig?.captcha.ali.sceneId,
+      prefix: authConfig?.captcha.ali.prefix,
+      mode: 'popup',
+      element: '#' + captchaId,
+      button: '#' + buttonId,
+      async captchaVerifyCallback(captchaToken: string) {
+        try {
+          tokenRef.current = captchaToken;
+          return {
+            captchaResult: true
+          };
+        } catch (err) {
+          tokenRef.current = '';
+          return {
+            captchaResult: false
+          };
+        }
+      },
+      onBizResultCallback: onBizResultCallback,
+      getInstance,
+      slideStyle: {
+        width: 360,
+        height: 40
+      },
+      immediate: false,
+      language: 'cn',
+      region: 'cn'
+    };
+
+    // @ts-ignore
+    window.initAliyunCaptcha(initAliyunCaptchaOptions);
+
+    return () => {
+      captchaInstanceRef.current = null;
+    };
+  }, []);
+  return (
+    <>
+      <Button
+        ref={buttonRef}
+        variant={'unstyled'}
+        hidden
+        id={buttonId}
+        {...(props as ButtonProps)}
+      />
+      <div ref={captchaElementRef} id={captchaId} />
+    </>
+  );
+});
+
+export { HiddenCaptchaComponent };

frontend/desktop/src/components/signin/auth/useSms.tsx

@@ -13,11 +13,12 @@ import {
 import { useTranslation } from 'next-i18next';
 import NextLink from 'next/link';
 import { useRouter } from 'next/router';
-import { MouseEventHandler, useEffect, useRef, useState } from 'react';
-import { useForm } from 'react-hook-form';
+import { MouseEvent, MouseEventHandler, useCallback, useEffect, useRef, useState } from 'react';
+import { get, useForm } from 'react-hook-form';
 import { getRegionToken } from '@/api/auth';
 import { getBaiduId, getInviterId, getUserSemData, sessionConfig } from '@/utils/sessionConfig';
 import { I18nCommonKey } from '@/types/i18next';
+import { useConfigStore } from '@/stores/config';
 
 export default function useSms({
   showError
@@ -27,9 +28,10 @@ export default function useSms({
   const { t } = useTranslation();
   const _remainTime = useRef(0);
   const router = useRouter();
+  const { authConfig } = useConfigStore();
   const [isLoading, setIsLoading] = useState(false);
   const setToken = useSessionStore((s) => s.setToken);
-  const { register, handleSubmit, trigger, getValues } = useForm<{
+  const { register, handleSubmit, trigger, getValues, watch } = useForm<{
     phoneNumber: string;
     verifyCode: string;
   }>();
@@ -81,7 +83,7 @@ export default function useSms({
     onAfterGetCode,
     getCfToken
   }: {
-    getCfToken?: () => string | undefined;
+    getCfToken?: () => Promise<string | undefined>;
     onAfterGetCode?: () => void;
   }) => {
     const [remainTime, setRemainTime] = useState(_remainTime.current);
@@ -93,19 +95,26 @@ export default function useSms({
       }, 1000);
       return () => clearInterval(interval);
     }, [remainTime]);
-
-    const getCode: MouseEventHandler = async (e) => {
+    const [invokeTime, setInvokeTime] = useState(new Date().getTime());
+    const getCode: MouseEventHandler = async (e: MouseEvent) => {
       e.preventDefault();
-
       if (!(await trigger('phoneNumber'))) {
         showError(t('common:invalid_phone_number') || 'Invalid phone number');
         return;
       }
+      if (new Date().getTime() - invokeTime <= 1000) {
+        return;
+      } else {
+        setInvokeTime(new Date().getTime());
+      }
+      const cfToken = await getCfToken?.();
+      if (authConfig?.captcha.enabled && authConfig.captcha.ali.enabled) {
+        if (!cfToken) return;
+      }
       setRemainTime(60);
       _remainTime.current = 60;
-
       try {
-        const cfToken = getCfToken?.();
+        const cfToken = await getCfToken?.();
         const res = await request.post<any, ApiResp<any>>('/api/auth/phone/sms', {
           id: getValues('phoneNumber'),
           cfToken
@@ -121,7 +130,6 @@ export default function useSms({
         onAfterGetCode?.();
       }
     };
-
     return (
       <>
         <InputGroup

frontend/desktop/src/components/signin/index.tsx

@@ -26,6 +26,8 @@ import Head from 'next/head';
 import { useRouter } from 'next/router';
 import { useEffect, useMemo, useRef, useState } from 'react';
 import useWechat from './auth/useWechat';
+import { HiddenCaptchaComponent, TCaptchaInstance } from './Captcha';
+import { captcha } from 'tencentcloud-sdk-nodejs';
 
 export default function SigninComponent() {
   const conf = useConfigStore();
@@ -74,6 +76,7 @@ export default function SigninComponent() {
     }
   }, []);
   const turnstileRef = useRef<TurnstileInstance>(null);
+  const captchaRef = useRef<TCaptchaInstance>(null);
   const loginConfig = useMemo(() => {
     return {
       [LoginType.SMS]: {
@@ -82,9 +85,12 @@ export default function SigninComponent() {
           <SmsModal
             onAfterGetCode={() => {
               turnstileRef.current?.reset();
+              captchaRef.current?.reset();
             }}
-            getCfToken={() => {
-              return turnstileRef.current?.getResponse();
+            getCfToken={async () => {
+              const token = await captchaRef.current?.getToken();
+              const turnstiletoken = turnstileRef.current?.getResponse();
+              return token;
             }}
           />
         )
@@ -225,6 +231,7 @@ export default function SigninComponent() {
                     siteKey={conf.commonConfig?.cfSiteKey}
                   />
                 )}
+                {conf.authConfig?.captcha.enabled && <HiddenCaptchaComponent ref={captchaRef} />}
                 <Button
                   variant={'unstyled'}
                   background="linear-gradient(90deg, #000000 0%, rgba(36, 40, 44, 0.9) 98.29%)"

frontend/desktop/src/pages/api/auth/phone/sms.ts

@@ -1,5 +1,10 @@
 import { ErrorHandler } from '@/services/backend/middleware/error';
-import { filterCf, filterPhoneParams, sendPhoneCodeGuard } from '@/services/backend/middleware/sms';
+import {
+  filterCaptcha,
+  filterCf,
+  filterPhoneParams,
+  sendPhoneCodeGuard
+} from '@/services/backend/middleware/sms';
 import { sendPhoneCodeSvc } from '@/services/backend/svc/sms';
 import { enablePhoneSms } from '@/services/enable';
 import { NextApiRequest, NextApiResponse } from 'next';
@@ -9,8 +14,10 @@ export default ErrorHandler(async function handler(req: NextApiRequest, res: Nex
     throw new Error('SMS is not enabled');
   }
   await filterCf(req, res, async () => {
-    await filterPhoneParams(req, res, ({ phoneNumbers: phone }) =>
-      sendPhoneCodeGuard(phone)(res, () => sendPhoneCodeSvc(phone)(res))
+    await filterCaptcha(req, res, () =>
+      filterPhoneParams(req, res, ({ phoneNumbers: phone }) =>
+        sendPhoneCodeGuard(phone)(res, () => sendPhoneCodeSvc(phone)(res))
+      )
     );
   });
 });

frontend/desktop/src/pages/api/platform/getAppConfig.ts

@@ -52,10 +52,10 @@ export async function getAppConfig(): Promise<AppClientConfigType> {
     const authConf = await getAuthClientConfig();
     const commonConf = await getCommonClientConfig();
     const layoutConf = await getLayoutConfig();
-    const _tracking = global.AppConfig.tracking;
+    const appConfig = global.AppConfig;
     const tracking: Required<TrackingConfigType> = {
-      websiteId: _tracking.websiteId || '',
-      hostUrl: _tracking.hostUrl || ''
+      websiteId: appConfig?.tracking?.websiteId || '',
+      hostUrl: appConfig?.tracking?.hostUrl || ''
     };
     const conf = genResConfig(cloudConf, authConf, commonConf, layoutConf, tracking);
     if (!global.commitCroner) {

frontend/desktop/src/pages/api/platform/getAuthConfig.ts

@@ -19,6 +19,7 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
 
 // genResAuthConfig Return AuthConfigType with only necessary fields for response to client, to avoid exposing sensitive data
 function genResAuthClientConfig(conf: AuthConfigType) {
+  const captcha = conf.captcha;
   const authClientConfig: AuthClientConfigType = {
     callbackURL: conf.callbackURL || '',
     invite: {
@@ -62,6 +63,14 @@ function genResAuthClientConfig(conf: AuthConfigType) {
         proxyAddress: conf.idp.oauth2?.proxyAddress || ''
       }
     },
+    captcha: {
+      enabled: !!captcha?.enabled,
+      ali: {
+        enabled: !!captcha?.ali?.enabled,
+        sceneId: captcha?.ali?.sceneId || '',
+        prefix: captcha?.ali?.prefix || ''
+      }
+    },
     hasBaiduToken: !!conf.baiduToken,
     billingToken: ''
   };

frontend/desktop/src/pages/signin.tsx

@@ -29,9 +29,11 @@ export default function SigninPage() {
         <link rel="shortcut icon" href={layoutConfig?.logo ? layoutConfig?.logo : '/favicon.ico'} />
         <link rel="icon" href={layoutConfig?.logo ? layoutConfig?.logo : '/favicon.ico'} />
       </Head>
+      <Script src="https://o.alicdn.com/captcha-frontend/aliyunCaptcha/AliyunCaptcha.js" />
       {layoutConfig?.meta.scripts?.map((item, i) => {
         return <Script key={i} {...item} />;
       })}
+
       <SigninComponent />
     </Box>
   );

frontend/desktop/src/services/backend/middleware/sms.ts

@@ -11,6 +11,7 @@ import {
 import { isEmail } from '@/utils/crypto';
 import { EMAIL_STATUS } from '@/types/response/email';
 import { SemData } from '@/types/sem';
+import { captchaReq } from '../sms';
 
 export const filterPhoneParams = async (
   req: NextApiRequest,
@@ -140,6 +141,71 @@ export const filterCf = async (req: NextApiRequest, res: NextApiResponse, next:
   }
   return await Promise.resolve(next());
 };
+export const filterCaptcha = async (
+  req: NextApiRequest,
+  res: NextApiResponse,
+  next: () => void
+) => {
+  if (
+    !global.AppConfig.desktop.auth.captcha?.enabled ||
+    (process.env.NODE_ENV === 'development' && !process.env.DEV_CAPTCHA_ENABLED)
+  ) {
+    await Promise.resolve(next());
+    return;
+  }
+  const { cfToken: captchaVerifyParam } = req.body as { cfToken?: string };
+  if (!captchaVerifyParam)
+    return jsonRes(res, {
+      message: 'captchaToken is invalid',
+      code: 400
+    });
+  const result = await captchaReq({
+    captchaVerifyParam
+  });
+  if (!result?.verifyResult)
+    return jsonRes(res, {
+      message: 'captchaToken is invalid',
+      data: {
+        result: !!result?.verifyResult,
+        code: result?.verifyCode || ''
+      },
+      code: 409
+    });
+  await Promise.resolve(next());
+};
+export const captchaSvc = async (req: NextApiRequest, res: NextApiResponse) => {
+  if (process.env.NODE_ENV === 'development' && !process.env.DEV_CAPTCHA_ENABLED) {
+    return true;
+  }
+  const { captchaToken } = req.body as { captchaToken?: string; sceneId?: string };
+
+  if (!captchaToken)
+    return jsonRes(res, {
+      message: 'captchaToken is invalid',
+      code: 400
+    });
+  const result = await captchaReq({
+    captchaVerifyParam: captchaToken
+  });
+  if (!result?.verifyResult)
+    return jsonRes(res, {
+      message: 'captchaToken is invalid',
+      data: {
+        result: !!result?.verifyResult,
+        code: result?.verifyCode || ''
+      },
+      code: 409
+    });
+  else
+    return jsonRes(res, {
+      message: 'captchaToken is valid',
+      data: {
+        result: result.verifyResult,
+        code: result?.verifyCode || ''
+      },
+      code: 203
+    });
+};
 
 // once code
 export const verifyCodeUidGuard =