feat: add email support (#745)

* feat(v2): add email support

feat: add SMTP support

* add ajv email, return email send failed, email length = 100

* return phone send failed

Author: hyrious

config/defaults.yaml

@@ -126,6 +126,23 @@ login:
       access_secret:
       template_code:
       sign_name:
+  email:
+    enable: true
+    test_emails:
+      - email:
+        code:
+    type: smtp
+    smtp:
+      host: smtpdm.aliyun.com
+      port: 465
+      secure: true
+      auth:
+        user:
+        pass:
+    aliCloud:
+      access_id:
+      access_secret:
+      account_name: [email protected]
 
 agora:
   app:

config/test.yaml

@@ -121,6 +121,23 @@ login:
       access_secret:
       template_code:
       sign_name:
+  email:
+    enable: true
+    test_emails:
+      - email:
+        code:
+    type: smtp
+    smtp:
+      host: smtpdm.aliyun.com
+      port: 465
+      secure: true
+      auth:
+        user:
+        pass:
+    aliCloud:
+      access_id:
+      access_secret:
+      account_name: [email protected]
 
 agora:
   app:

package.json

@@ -23,6 +23,7 @@
     "@types/lodash": "^4.14.170",
     "@types/node": "^18.0.0",
     "@types/node-rsa": "^1.1.1",
+    "@types/nodemailer": "^6.4.9",
     "@types/qs": "^6.9.7",
     "@types/query-string": "^6.3.0",
     "@types/sinon": "^10.0.12",
@@ -58,6 +59,7 @@
     "webpack-node-externals": "^3.0.0"
   },
   "dependencies": {
+    "@alicloud/dm20151123": "^1.0.6",
     "@alicloud/dysmsapi20170525": "^2.0.9",
     "@alicloud/openapi-client": "^0.4.1",
     "@fastify-userland/request-id": "^2.0.1",
@@ -89,6 +91,7 @@
     "mysql2": "^2.2.5",
     "nanoid": "^3.1.31",
     "node-rsa": "^1.1.1",
+    "nodemailer": "^6.9.4",
     "prom-client": "^14.0.0",
     "qs": "^6.10.3",
     "reflect-metadata": "^0.1.13",

src/ErrorCode.ts

@@ -51,6 +51,12 @@ export enum ErrorCode {
     SMSVerificationCodeInvalid = 110000, // verification code invalid
     SMSAlreadyExist, // phone already exist by current user
     SMSAlreadyBinding, // phone are binding by other users
+    SMSFailedToSendCode, // failed to send verification code
+
+    EmailVerificationCodeInvalid = 115000, // verification code invalid
+    EmailAlreadyExist, // email already exist by current user
+    EmailAlreadyBinding, // email are binding by other users
+    EmailFailedToSendCode, // failed to send verification code
 
     CensorshipFailed = 120000, // censorship failed
 

src/constants/Config.ts

@@ -100,6 +100,31 @@ export const PhoneSMS = {
     },
 };
 
+export const EmailSMS = {
+    enable: config.login.email.enable,
+    testEmails: config.login.email.test_emails.map(user => {
+        return {
+            email: String(user.email),
+            code: user.code,
+        };
+    }),
+    type: config.login.email.type,
+    aliCloud: {
+        accessId: config.login.email.aliCloud.access_id,
+        accessSecret: config.login.email.aliCloud.access_secret,
+        accountName: config.login.email.aliCloud.account_name,
+    },
+    smtp: {
+        host: config.login.email.smtp.host,
+        port: config.login.email.smtp.port,
+        secure: config.login.email.smtp.secure,
+        auth: {
+            user: config.login.email.smtp.auth.user,
+            pass: config.login.email.smtp.auth.pass,
+        },
+    },
+};
+
 export const Agora = {
     appId: config.agora.app.id,
     appCertificate: config.agora.app.certificate,

src/constants/Project.ts

@@ -15,6 +15,7 @@ export enum LoginPlatform {
     Agora = "Agora",
     Google = "Google",
     Phone = "Phone",
+    Email = "Email",
 }
 
 export enum Gender {

src/dao/index.ts

@@ -17,6 +17,7 @@ import { UserAgoraModel } from "../model/user/Agora";
 import { UserGoogleModel } from "../model/user/Google";
 import { UserPhoneModel } from "../model/user/Phone";
 import { UserSensitiveModel } from "../model/user/Sensitive";
+import { UserEmailModel } from "../model/user/Email";
 
 export const UserDAO = DAOImplement(UserModel) as ReturnType<DAO<UserModel>>;
 
@@ -32,6 +33,8 @@ export const UserGoogleDAO = DAOImplement(UserGoogleModel) as ReturnType<DAO<Use
 
 export const UserPhoneDAO = DAOImplement(UserPhoneModel) as ReturnType<DAO<UserPhoneModel>>;
 
+export const UserEmailDAO = DAOImplement(UserEmailModel) as ReturnType<DAO<UserEmailModel>>;
+
 export const UserSensitiveDAO = DAOImplement(UserSensitiveModel) as ReturnType<
     DAO<UserSensitiveModel>
 >;

src/logger/LogConext.ts

@@ -76,6 +76,19 @@ export type LoggerSMS = LoggerBase & {
     };
 };
 
+export type LoggerEmail = LoggerBase & {
+    email: {
+        accountName: string;
+        email: string;
+        verificationCode: string;
+    };
+    emailDetail?: {
+        envId: string;
+        requestId: string;
+        messageId: string;
+    };
+};
+
 export type LoggerQueue = LoggerBase & {
     queue: {
         name: string;

src/logger/index.ts

@@ -12,6 +12,7 @@ import {
     LoggerServer,
     LoggerService,
     LoggerSMS,
+    LoggerEmail,
 } from "./LogConext";
 import { LoggerPluginFile } from "./plugins/LoggerPluginFile";
 import { LoggerPluginTerminal } from "./plugins/LoggerPluginTerminal";
@@ -104,6 +105,19 @@ export const createLoggerSMS = <R extends LoggerContext>(
     );
 };
 
+export const createLoggerEmail = <R extends LoggerContext>(
+    context: Partial<LoggerEmail & R>,
+): Logger<LoggerEmail & R> => {
+    return new Logger<LoggerEmail & R>(
+        "email",
+        {
+            ...context,
+            ...baseContext,
+        },
+        loggerPlugins as LoggerAbstractPlugin<LoggerEmail & R>[],
+    );
+};
+
 export const createLoggerRTCScreenshot = <R extends LoggerContext>(
     context: Partial<LoggerRTCScreenshot & R>,
 ): Logger<LoggerRTCScreenshot & R> => {

src/model/index.ts

@@ -18,6 +18,7 @@ import { OAuthInfosModel } from "./oauth/oauth-infos";
 import { OAuthSecretsModel } from "./oauth/oauth-secrets";
 import { OAuthUsersModel } from "./oauth/oauth-users";
 import { UserSensitiveModel } from "./user/Sensitive";
+import { UserEmailModel } from "./user/Email";
 
 export type Model =
     | UserModel
@@ -27,6 +28,7 @@ export type Model =
     | UserAgoraModel
     | UserGoogleModel
     | UserPhoneModel
+    | UserEmailModel
     | UserSensitiveModel
     | RoomModel
     | RoomUserModel