feat: add sensitive (#724)

hyrious · web-flow · commit 553d246cc21a · 2023-04-26T10:59:57.000+08:00
diff --git a/src/dao/index.ts b/src/dao/index.ts
@@ -16,6 +16,7 @@ import { UserAppleModel } from "../model/user/Apple";
 import { UserAgoraModel } from "../model/user/Agora";
 import { UserGoogleModel } from "../model/user/Google";
 import { UserPhoneModel } from "../model/user/Phone";
+import { UserSensitiveModel } from "../model/user/Sensitive";
 
 export const UserDAO = DAOImplement(UserModel) as ReturnType<DAO<UserModel>>;
 
@@ -31,6 +32,10 @@ export const UserGoogleDAO = DAOImplement(UserGoogleModel) as ReturnType<DAO<Use
 
 export const UserPhoneDAO = DAOImplement(UserPhoneModel) as ReturnType<DAO<UserPhoneModel>>;
 
+export const UserSensitiveDAO = DAOImplement(UserSensitiveModel) as ReturnType<
+    DAO<UserSensitiveModel>
+>;
+
 export const RoomDAO = DAOImplement(RoomModel) as ReturnType<DAO<RoomModel>>;
 
 export const RoomUserDAO = DAOImplement(RoomUserModel) as ReturnType<DAO<RoomUserModel>>;
diff --git a/src/model/index.ts b/src/model/index.ts
@@ -17,6 +17,7 @@ import { CloudStorageConfigsModel } from "./cloudStorage/CloudStorageConfigs";
 import { OAuthInfosModel } from "./oauth/oauth-infos";
 import { OAuthSecretsModel } from "./oauth/oauth-secrets";
 import { OAuthUsersModel } from "./oauth/oauth-users";
+import { UserSensitiveModel } from "./user/Sensitive";
 
 export type Model =
     | UserModel
@@ -26,6 +27,7 @@ export type Model =
     | UserAgoraModel
     | UserGoogleModel
     | UserPhoneModel
+    | UserSensitiveModel
     | RoomModel
     | RoomUserModel
     | RoomPeriodicConfigModel
diff --git a/src/model/user/Constants.ts b/src/model/user/Constants.ts
@@ -0,0 +1,4 @@
+export enum SensitiveType {
+    Phone = "phone",
+    Avatar = "avatar",
+}
diff --git a/src/model/user/Sensitive.ts b/src/model/user/Sensitive.ts
@@ -0,0 +1,32 @@
+import { Column, Entity, Index } from "typeorm";
+import { Content } from "../Content";
+
+@Entity({
+    name: "user_sensitive",
+})
+export class UserSensitiveModel extends Content {
+    @Index("user_sensitive_user_uuid_index")
+    @Column({
+        length: 40,
+    })
+    user_uuid: string;
+
+    @Index("user_sensitive_type_index")
+    @Column({
+        length: 128,
+        comment: "sensitive type like 'phone'",
+    })
+    type: string;
+
+    @Column({
+        length: 2083,
+        comment: "sensitive value like '123****4'",
+    })
+    content: string;
+
+    @Index("user_sensitive_is_delete_index")
+    @Column({
+        default: false,
+    })
+    is_delete: boolean;
+}
diff --git a/src/thirdPartyService/TypeORMService.ts b/src/thirdPartyService/TypeORMService.ts
@@ -17,6 +17,7 @@ import { UserAppleModel } from "../model/user/Apple";
 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 { OAuthInfosModel } from "../model/oauth/oauth-infos";
 import { OAuthSecretsModel } from "../model/oauth/oauth-secrets";
 import { OAuthUsersModel } from "../model/oauth/oauth-users";
@@ -36,6 +37,7 @@ export const dataSource = new DataSource({
         UserAgoraModel,
         UserGoogleModel,
         UserPhoneModel,
+        UserSensitiveModel,
         RoomModel,
         RoomUserModel,
         RoomPeriodicConfigModel,
diff --git a/src/v1/controller/login/platforms/LoginPhone.ts b/src/v1/controller/login/platforms/LoginPhone.ts
@@ -7,6 +7,7 @@ import { ServiceCloudStorageConfigs } from "../../../service/cloudStorage/CloudS
 import { ServiceCloudStorageUserFiles } from "../../../service/cloudStorage/CloudStorageUserFiles";
 import { ServiceUserPhone } from "../../../service/user/UserPhone";
 import { dataSource } from "../../../../thirdPartyService/TypeORMService";
+import { ServiceUserSensitive } from "../../../service/user/UserSensitive";
 
 @Login()
 export class LoginPhone extends AbstractLogin {
@@ -18,6 +19,7 @@ export class LoginPhone extends AbstractLogin {
         this.svc = {
             user: new ServiceUser(this.userUUID),
             userPhone: new ServiceUserPhone(this.userUUID),
+            userSensitive: new ServiceUserSensitive(this.userUUID),
             cloudStorageFiles: new ServiceCloudStorageFiles(),
             cloudStorageConfigs: new ServiceCloudStorageConfigs(this.userUUID),
             cloudStorageUserFiles: new ServiceCloudStorageUserFiles(this.userUUID),
@@ -33,8 +35,14 @@ export class LoginPhone extends AbstractLogin {
             const createUser = this.svc.user.create(info, t);
 
             const createUserPhone = this.svc.userPhone.create(info, t);
+            const createUserSensitive = this.svc.userSensitive.phone(info, t);
 
-            return await Promise.all([createUser, createUserPhone, this.setGuidePPTX(this.svc, t)]);
+            return await Promise.all([
+                createUser,
+                createUserPhone,
+                createUserSensitive,
+                this.setGuidePPTX(this.svc, t),
+            ]);
         });
     }
 
@@ -50,6 +58,7 @@ export class LoginPhone extends AbstractLogin {
 interface RegisterService {
     user: ServiceUser;
     userPhone: ServiceUserPhone;
+    userSensitive: ServiceUserSensitive;
     cloudStorageFiles: ServiceCloudStorageFiles;
     cloudStorageUserFiles: ServiceCloudStorageUserFiles;
     cloudStorageConfigs: ServiceCloudStorageConfigs;
diff --git a/src/v1/controller/user/binding/platform/phone/Binding.ts b/src/v1/controller/user/binding/platform/phone/Binding.ts
@@ -10,6 +10,7 @@ import { ErrorCode } from "../../../../../../ErrorCode";
 import { Status } from "../../../../../../constants/Project";
 import { ServiceUserPhone } from "../../../../../service/user/UserPhone";
 import { UserDAO } from "../../../../../../dao";
+import { ServiceUserSensitive } from "../../../../../service/user/UserSensitive";
 
 @Controller<RequestType, ResponseType>({
     method: "post",
@@ -38,6 +39,7 @@ export class BindingPhone extends AbstractController<RequestType, ResponseType>
 
     private svc = {
         userPhone: new ServiceUserPhone(this.userUUID),
+        userSensitive: new ServiceUserSensitive(this.userUUID),
     };
 
     private static ExhaustiveAttackCount = 10;
@@ -75,6 +77,9 @@ export class BindingPhone extends AbstractController<RequestType, ResponseType>
             phone,
             userName: userInfo.user_name,
         });
+        await this.svc.userSensitive.phone({
+            phone,
+        });
 
         await BindingPhone.clearVerificationCode(safePhone);
 
diff --git a/src/v1/controller/user/uploadAvatar/Finish.ts b/src/v1/controller/user/uploadAvatar/Finish.ts
@@ -12,6 +12,7 @@ import { getOSSDomain, getOSSFileURLPath } from "../../cloudStorage/alibabaCloud
 import { deleteObject, isExistObject } from "../../cloudStorage/alibabaCloud/Utils";
 import { getFilePath } from "./Utils";
 import { dataSource } from "../../../../thirdPartyService/TypeORMService";
+import { ServiceUserSensitive } from "../../../service/user/UserSensitive";
 
 @Controller<RequestType, ResponseType>({
     method: "post",
@@ -34,6 +35,7 @@ export class UploadAvatarFinish extends AbstractController<RequestType, Response
 
     public readonly svc: {
         user: ServiceUser;
+        userSensitive: ServiceUserSensitive;
     };
 
     private static readonly censorshipLogger = createLoggerContentCensorship({});
@@ -43,6 +45,7 @@ export class UploadAvatarFinish extends AbstractController<RequestType, Response
 
         this.svc = {
             user: new ServiceUser(this.userUUID),
+            userSensitive: new ServiceUserSensitive(this.userUUID),
         };
     }
 
@@ -86,6 +89,7 @@ export class UploadAvatarFinish extends AbstractController<RequestType, Response
         // Delete previous avatar and set new avatar.
         await dataSource.transaction(async t => {
             await this.svc.user.updateAvatar(alibabaCloudFileURL, t);
+            await this.svc.userSensitive.avatar({ avatarURL: alibabaCloudFileURL }, t);
 
             const avatarURL = (await this.svc.user.nameAndAvatar())?.avatarURL;
             if (avatarURL) {
diff --git a/src/v1/service/user/UserSensitive.ts b/src/v1/service/user/UserSensitive.ts
@@ -0,0 +1,37 @@
+import { EntityManager, InsertResult } from "typeorm";
+import { UserSensitiveDAO } from "../../../dao";
+import { SensitiveType } from "../../../model/user/Constants";
+
+export class ServiceUserSensitive {
+    constructor(private readonly userUUID: string) {}
+
+    public async phone(
+        data: {
+            phone: string;
+        },
+        t?: EntityManager,
+    ): Promise<InsertResult> {
+        return await UserSensitiveDAO(t).insert({
+            user_uuid: this.userUUID,
+            type: SensitiveType.Phone,
+            content: this.desensitivePhone(data.phone),
+        });
+    }
+
+    private desensitivePhone(phone: string): string {
+        return phone.slice(0, 3) + "*******" + phone.slice(-1);
+    }
+
+    public async avatar(
+        data: {
+            avatarURL: string;
+        },
+        t?: EntityManager,
+    ): Promise<InsertResult> {
+        return await UserSensitiveDAO(t).insert({
+            user_uuid: this.userUUID,
+            type: SensitiveType.Avatar,
+            content: data.avatarURL,
+        });
+    }
+}
diff --git a/src/v2/controllers/user/routes.ts b/src/v2/controllers/user/routes.ts
@@ -2,6 +2,7 @@ import { Server } from "../../../utils/registryRoutersV2";
 import { userRename, userRenameSchema } from "./rename";
 import { userUploadAvatarStart, userUploadAvatarStartSchema } from "./upload-avatar/start";
 import { userUploadAvatarFinish, userUploadAvatarFinishSchema } from "./upload-avatar/finish";
+import { userSensitive, userSensitiveSchema } from "./sensitive";
 
 export const userRouters = (server: Server): void => {
     server.post("user/rename", userRename, {
@@ -15,4 +16,8 @@ export const userRouters = (server: Server): void => {
     server.post("user/upload-avatar/finish", userUploadAvatarFinish, {
         schema: userUploadAvatarFinishSchema,
     });
+
+    server.post("user/sensitive", userSensitive, {
+        schema: userSensitiveSchema,
+    });
 };
diff --git a/src/v2/controllers/user/sensitive/index.ts b/src/v2/controllers/user/sensitive/index.ts
@@ -0,0 +1,27 @@
+import { Type } from "@sinclair/typebox";
+import { FastifyRequestTypebox, Response } from "../../../../types/Server";
+import { UserSensitiveListReturn, UserSensitiveService } from "../../../services/user/sensitive";
+import { successJSON } from "../../internal/utils/response-json";
+
+export const userSensitiveSchema = {
+    body: Type.Object(
+        {
+            from: Type.Integer(),
+            to: Type.Integer(),
+        },
+        {
+            additionalProperties: false,
+        },
+    ),
+};
+
+export const userSensitive = async (
+    req: FastifyRequestTypebox<typeof userSensitiveSchema>,
+): Promise<Response<UserSensitiveListReturn[]>> => {
+    const result = await new UserSensitiveService(req.ids, req.DBTransaction, req.userUUID).list({
+        from: new Date(req.body.from),
+        to: new Date(req.body.to),
+    });
+
+    return successJSON(result);
+};
diff --git a/src/v2/dao/index.ts b/src/v2/dao/index.ts
@@ -10,6 +10,7 @@ import { UserGithubModel } from "../../model/user/Github";
 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 { RoomModel } from "../../model/room/Room";
 import { RoomUserModel } from "../../model/room/RoomUser";
 import { RoomPeriodicConfigModel } from "../../model/room/RoomPeriodicConfig";
@@ -181,6 +182,7 @@ export const userAppleDAO = new DAO(UserAppleModel);
 export const userAgoraDAO = new DAO(UserAgoraModel);
 export const userGoogleDAO = new DAO(UserGoogleModel);
 export const userPhoneDAO = new DAO(UserPhoneModel);
+export const userSensitiveDAO = new DAO(UserSensitiveModel);
 export const roomDAO = new DAO(RoomModel);
 export const roomUserDAO = new DAO(RoomUserModel);
 export const roomPeriodicConfigDAO = new DAO(RoomPeriodicConfigModel);
diff --git a/src/v2/services/user/sensitive.ts b/src/v2/services/user/sensitive.ts
@@ -0,0 +1,52 @@
+import { EntityManager } from "typeorm";
+import { UserSensitiveModel } from "../../../model/user/Sensitive";
+import { createLoggerService } from "../../../logger";
+
+export class UserSensitiveService {
+    private readonly logger = createLoggerService<"userSensitive">({
+        serviceName: "userSensitive",
+        ids: this.ids,
+    });
+
+    constructor(
+        private readonly ids: IDS,
+        private readonly DBTransaction: EntityManager,
+        private readonly userUUID: string,
+    ) {}
+
+    public async list(range: { from: Date; to: Date }): Promise<UserSensitiveListReturn[]> {
+        this.logger.debug("list user sensitive", {
+            userSensitive: {
+                from: range.from.valueOf(),
+                to: range.to.valueOf(),
+            },
+        });
+
+        const result: UserSensitiveListReturn[] = await this.DBTransaction.createQueryBuilder(
+            UserSensitiveModel,
+            "us",
+        )
+            .addSelect("us.type", "type")
+            .addSelect("us.content", "content")
+            .where("us.user_uuid = :userUUID", { userUUID: this.userUUID })
+            .andWhere("us.created_at >= :from", { from: range.from })
+            .andWhere("us.created_at <= :to", { to: range.to })
+            .andWhere("us.is_delete = :isDelete", { isDelete: false })
+            .getRawMany();
+
+        this.logger.debug("list user sensitive done", {
+            userSensitive: {
+                from: range.from.valueOf(),
+                to: range.to.valueOf(),
+                count: result.length,
+            },
+        });
+
+        return result;
+    }
+}
+
+export type UserSensitiveListReturn = {
+    type: string;
+    content: string;
+};
diff --git a/src/v2/services/user/update.ts b/src/v2/services/user/update.ts
@@ -1,6 +1,7 @@
 import { createLoggerService } from "../../../logger";
 import { EntityManager } from "typeorm";
-import { userDAO } from "../../dao";
+import { userDAO, userSensitiveDAO } from "../../dao";
+import { SensitiveType } from "../../../model/user/Constants";
 
 export class UserUpdateService {
     private readonly logger = createLoggerService<"userUpdate">({
@@ -41,6 +42,11 @@ export class UserUpdateService {
                 user_uuid: this.userUUID,
             },
         );
+        await userSensitiveDAO.insert(this.DBTransaction, {
+            user_uuid: this.userUUID,
+            type: SensitiveType.Avatar,
+            content: newAvatarURL,
+        });
         this.logger.debug("avatar URL updated", {
             userUpdate: {
                 newAvatarURL,
