@lingxiteam/ebe-utils 0.0.33 → 0.0.37

package/lib/public/src/utils/Security/utils/encrypted.ts

@@ -2,9 +2,14 @@ import config from '../config';
 import { lxKey } from '../const';
 import { AESDecrypt, AESEncrypt } from '../encipher/aes';
 import { RSADecrypt, RSAEncrypt } from '../encipher/rsa';
-import { MODE } from '../types';
-import message from './message';
+import { MODE, requester } from '../types';
+import { getObjectValue } from './caseInsensitive';
 
+/**
+ * 预置内部加密函数，将秘钥进行加密使用
+ * @param str 待加密内容
+ * @returns
+ */
 export function lxEncrypt(str: string) {
   if (config.keyEncrypt) {
     return AESEncrypt(str, lxKey) || str;
@@ -12,6 +17,11 @@ export function lxEncrypt(str: string) {
   return str;
 }
 
+/**
+ * 预置内部解密函数
+ * @param str 待加密内容
+ * @returns
+ */
 function lxDecrypt(str: string) {
   if (config.keyEncrypt) {
     return AESDecrypt(str, lxKey) || str;
@@ -19,6 +29,12 @@ function lxDecrypt(str: string) {
   return str;
 }
 
+/**
+ * 统一加密函数
+ * @param str 待加密内容
+ * @param type 加密类型
+ * @returns string 加密后内容
+ */
 export function encryptedStr(str: string, type: string): string {
   if (type === MODE.AES) {
     return AESEncrypt(
@@ -36,17 +52,17 @@ export function encryptedStr(str: string, type: string): string {
       ) || ''
     );
   }
-  if (type === MODE.DES) {
-    message.warn('DES encryption is no longer supported');
-  }
   return str;
 }
 
-export function decryptedStr(
-  str: string,
-  type: string,
-  config: any = {},
-): string {
+/**
+ * 统一解密函数
+ * @param str 待解密内容
+ * @param type 加密类型
+ * @param config 配置项(自定义秘钥和解密方法)
+ * @returns string 解密后的内容
+ */
+export function decryptedStr(str: string, type: string): string {
   if (type === MODE.AES) {
     return AESDecrypt(
       str,
@@ -63,59 +79,190 @@ export function decryptedStr(
       ) || ''
     );
   }
-  if (type === MODE.DES) {
-    message.warn('DES encryption is no longer supported');
-  }
   return str;
 }
 
+/**
+ * 将url参数加密，如： a=1&b=2 -> a=XAZYt1dl43v0gYUlNM6wEg%3D%3D&b=rbsCqzqEZvsUn41oxNsJ%2FQ%3D%3D
+ * @param search url参数, 如: a=1&b=2
+ * @param mode 加密模式
+ * @returns string 加密后数据
+ */
+export const encryptedStrForSearchParams = (
+  search: string,
+  mode: '2.0' | '3.0',
+) => {
+  const params = search.split('&').map((param) => {
+    const [k, v] = param.split('=');
+    return `${encodeURIComponent(k)}=${encodeURIComponent(
+      encryptedStr(v, mode),
+    )}`;
+  });
+  return params.join('&');
+};
+
+/**
+ * 将url参数解密
+ * @param search url参数, 如: a=XAZYt1dl43v0gYUlNM6wEg%3D%3D&b=rbsCqzqEZvsUn41oxNsJ%2FQ%3D%3D
+ * @param mode 加密模式
+ * @returns string 解密后数据
+ */
+export const decryptedStrForSearchParams = (
+  search: string,
+  mode: '2.0' | '3.0',
+) => {
+  const params = search.split('&').map((param) => {
+    const [k, v] = param.split('=');
+    return `${decodeURIComponent(k)}=${decryptedStr(
+      decodeURIComponent(v),
+      mode,
+    )}`;
+  });
+  return params.join('&');
+};
+
+/**
+ * 将对象数据value字段加密， 如: { a: 1, b: 2 } -> { a: 'XAZYt1dl43v0gYUlNM6wEg', b: 'XAZYt1dl43v0gYUlNM6wEg' }
+ * @param data 对象数据
+ * @param mode 加密模式
+ * @returns string 加密后数据
+ */
+const encryptedStrForObjectBody = (
+  data: Record<any, any>,
+  mode: '2.0' | '3.0',
+) => {
+  return Object.keys(data).reduce(
+    (
+      previousValue: Record<string, string>,
+      key: string,
+    ): Record<string, string> => {
+      if (typeof data[key] === 'object') {
+        previousValue[key] = encryptedStr(JSON.stringify(data[key]), mode);
+      } else {
+        previousValue[key] = encryptedStr(String(data[key]), mode);
+      }
+      return previousValue;
+    },
+    {},
+  );
+};
+
 interface optsType {
   body?: any;
   headers?: any;
 }
 type returnType = [string, { body?: any; headers?: any }];
 
-// 统一请求参数加密
+/**
+ * 统一请求参数加密，对url参数、body参数进行加密
+ * @param url 请求url地址
+ * @param opts 请求配置，包含 headers、body
+ * @param mode 加密模式，2.0:rsa，3.0:aes
+ * @param requester 请求程序，"fetch" | "xhr" | "wxRequest"
+ * @returns [加密处理后的url， 加密处理后的数据(header、body)]
+ */
 export const encryptedRequestParams = (
   url: string,
   opts: optsType,
-  type: string,
+  mode: '2.0' | '3.0',
+  requester: requester,
 ): returnType => {
-  const isFormData = opts.body instanceof FormData;
+  const encryptedOpts = Object.assign({}, opts);
 
-  // search 部分加密
+  // 在请求头增加‘模式’字段，告知后端解密方式
+  encryptedOpts.headers = {
+    ...(opts.headers || {}),
+    [config.securityHeaderKey as string]: mode,
+  };
+
+  // url search 部分参数加密
   const encryptedUrl =
     url.indexOf('?') !== -1
-      ? url.replace(/[^?]+$/g, (search: string) => {
-          const params = search.split('&').map((param) => {
-            const [k, v] = param.split('=');
-            return `${encodeURIComponent(k)}=${encodeURIComponent(
-              encryptedStr(v, type),
-            )}`;
-          });
-          return params.join('&');
-        })
+      ? url.replace(/[^?]+$/g, (data) =>
+          encryptedStrForSearchParams(data, mode),
+        )
       : url;
 
-  // body参数加密
-  const encryptedOpts = Object.assign({}, opts);
-  encryptedOpts.headers = {
-    ...(opts.headers || {}),
-    [config.securityHeaderKey as string]: type,
-  };
+  /**
+   * body参数加密
+   * body 数据类型：
+   * - Fetch:  a string | ArrayBuffer | Blob | DataView | File | FormData | TypedArray | URLSearchParams  see: https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#body
+   * - XHR: a string | Blob | FormData | URLSearchParams | Document | null see: https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest/send
+   * - wx.request: a string | object | ArrayBuffer see: https://developers.weixin.qq.com/miniprogram/dev/api/network/request/wx.request.html
+   *
+   * 入参数据为: opts.body, 数据来源于
+   * fetch请求的 options.body
+   * xhr请求 send方法入参
+   * wx请求的 options.data
+   *
+   * 加密原则：
+   * 1. 对于表单数据只加密value部分
+   * 2. json或文本类型整个body加密
+   * 3. 其他类型(File、Blob...)不加密
+   */
+  if (opts.body) {
+    const defaultContentType: Record<requester, string> = {
+      xhr: 'application/x-www-form-urlencoded',
+      fetch: 'text/plain',
+      wxRequest: 'application/json',
+    };
+    const contentType =
+      getObjectValue(opts.headers, 'Content-Type') ||
+      defaultContentType[requester];
+    const method = opts.headers?.method?.toUpperCase() || 'GET';
+    const isFormData =
+      typeof FormData !== 'undefined' && opts.body instanceof FormData;
+    const isURLSearchParams =
+      typeof URLSearchParams !== 'undefined' &&
+      opts.body instanceof URLSearchParams;
 
-  if (isFormData) {
-    // formData 加密
-    const formData = new FormData();
-    const reqBody = opts.body;
-    for (const key of (reqBody as any).keys()) {
-      const value = reqBody.get(key);
-      formData.append(key, encryptedStr(value, type));
+    /* 1. 优先根据body数据类型来处理 */
+    if (isFormData || isURLSearchParams) {
+      const newObjData = isFormData ? new FormData() : new URLSearchParams();
+      const reqBody = opts.body;
+      for (const key of (reqBody as any).keys()) {
+        const value = reqBody.get(key);
+        // 只加密文本类型数据，文件数据不处理
+        if (typeof value === 'string') {
+          newObjData.append(key, encryptedStr(value, mode));
+        } else {
+          newObjData.append(key, value as any);
+        }
+      }
+      encryptedOpts.body = newObjData;
+    } /* 2. 根据contentType类型来处理 */ else if (
+      contentType.indexOf('application/json') !== -1
+    ) {
+      // wx.request 可以为对象类型
+      if (typeof opts.body === 'object') {
+        try {
+          if (method === 'GET') {
+            // get请求时，body数据将通过url参数传递
+            encryptedOpts.body = encryptedStrForObjectBody(opts.body, mode);
+          } else {
+            encryptedOpts.body = encryptedStr(JSON.stringify(opts.body), mode);
+          }
+        } catch {
+          encryptedOpts.body = opts.body;
+        }
+      } else {
+        encryptedOpts.body = encryptedStr(opts.body, mode);
+      }
+    } else if (
+      contentType.indexOf('application/x-www-form-urlencoded') !== -1
+    ) {
+      if (typeof opts.body === 'object') {
+        encryptedOpts.body = encryptedStrForObjectBody(opts.body, mode);
+      } else {
+        encryptedOpts.body = encryptedStrForSearchParams(opts.body, mode);
+      }
+    } else if (typeof opts.body === 'string') {
+      //  文本数据 加密
+      encryptedOpts.body = encryptedStr(opts.body, mode);
+    } else {
+      // 其他类型数据不处理
+      encryptedOpts.body = opts.body;
     }
-    encryptedOpts.body = formData;
-  } else if (opts.body) {
-    //  文本加密
-    encryptedOpts.body = encryptedStr(opts.body, type);
   }
 
   return [encryptedUrl, encryptedOpts];

package/lib/public/src/utils/Security/utils/random.ts

@@ -0,0 +1,21 @@
+/* eslint-disable no-restricted-properties */
+
+/**
+ * 生成随机整数
+ * @param numDigits 随机数位数
+ * @returns 随机数
+ */
+
+function generateRandomNumber(numDigits: number) {
+  // 确保输入的位数为正整数
+  const _numDigits = Math.floor(Math.abs(numDigits));
+
+  // 生成指定位数的最小值和最大值
+  const min = Math.pow(10, _numDigits - 1);
+  const max = Math.pow(10, _numDigits) - 1;
+
+  // 生成随机数并返回
+  return Math.floor(Math.random() * (max - min + 1)) + min;
+}
+
+export default generateRandomNumber;

package/lib/public/src/utils/Security/utils/storge.ts

@@ -0,0 +1,22 @@
+import capabilities from '../clientCapabilities';
+
+const storageUtil = {
+  /**
+   * 获取本地存储数据
+   * @param key 数据key
+   * @returns string 存储的数据值
+   */
+  get: (key: string): string => {
+    if (capabilities.localStorage) {
+      const v = localStorage.getItem(key);
+      return v === null ? '' : v;
+    }
+    if (capabilities.wxStorage) {
+      const v = wx.getStorageSync(key);
+      return typeof v === 'object' ? JSON.stringify(v) : String(v);
+    }
+    return '';
+  },
+};
+
+export default storageUtil;

package/lib/public/src/utils/Security/utils/url.ts

@@ -5,15 +5,20 @@
  */
 export const obj2QueryString = (params: any) => {
   const queryString = Object.keys(params)
-    .map(
-      (key) => `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`,
-    )
+    .map((key) => {
+      if (typeof params[key] === 'object') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(
+          JSON.stringify(params[key]),
+        )}`;
+      }
+      return `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`;
+    })
     .join('&');
   return queryString;
 };
 
 /**
- * 将url参数进行编码转换
+ * 将url参数进行编码转换(解码)
  * @param queryStr 待处理url参数
  * @returns
  */
@@ -45,7 +50,7 @@ export const getSearchObj = (url: string) => {
 
 /**
  * 移除URL指定参数
- * @param url url地址
+ * @param url 待处理的url地址
  * @param paramsToRemove 需要移除的参数列表
  * @returns 处理后的url
  */
@@ -76,3 +81,23 @@ export const removeURLParameters = (
 
   return result;
 };
+
+/**
+ * 往url地址添加参数
+ * @param url 待处理的url地址
+ * @param params 待添加的参数数据
+ */
+export const addUrlParameters = (
+  url: string,
+  params: Record<any, any>,
+): string => {
+  const paramsString = Object.keys(params)
+    .map((key) => {
+      if (typeof params[key] === 'object') {
+        return `${key}=${JSON.stringify(params[key])}`;
+      }
+      return `${key}=${params[key]}`;
+    })
+    .join('&');
+  return url + (url.indexOf('?') !== -1 ? '&' : '?') + paramsString;
+};

package/lib/public/src/utils/getSceneCode.ts

@@ -0,0 +1,51 @@
+/**
+ * getSceneCode.js
+ * params: 弹窗配置参数
+ * sceneCode: 组件直接传入的 sceneCode
+ * urlParam：url 参数
+ * pageData：页面数据中配置的参数
+ * modalInstId：弹窗实例 id，用于区分是一个弹窗实例，还是一个页面
+ */
+
+type getSceneCodeFn = (options: {
+  params?: {
+    sceneCode?: string;
+  };
+  sceneCode?: string;
+  urlParam?: {
+    sceneCode?: string;
+  };
+  pageData?: {
+    chooseSceneObjec?: {
+      sceneCode?: string;
+    };
+  };
+  modalInstId?: number | string;
+}) => string;
+
+const getSceneCode: getSceneCodeFn = (options) => {
+  const {
+    params: modalParams,
+    sceneCode: propsSceneCode,
+    urlParam,
+    pageData,
+    modalInstId,
+  } = options;
+  let newSceneCode = '';
+  if (modalInstId) {
+    newSceneCode =
+      modalParams?.sceneCode ||
+      propsSceneCode ||
+      pageData?.chooseSceneObjec?.sceneCode ||
+      '';
+  } else {
+    newSceneCode =
+      urlParam?.sceneCode ||
+      propsSceneCode ||
+      pageData?.chooseSceneObjec?.sceneCode ||
+      '';
+  }
+  return newSceneCode || '';
+};
+
+export default getSceneCode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingxiteam/ebe-utils",
-  "version": "0.0.33",
+  "version": "0.0.37",
   "description": "",
   "keywords": [],
   "author": "",
@@ -19,7 +19,7 @@
     "@babel/types": "^7.12.12",
     "cac": "^6.7.14",
     "fs-extra": "9.x",
-    "@lingxiteam/ebe": "0.0.33"
+    "@lingxiteam/ebe": "0.0.37"
   },
   "publishConfig": {
     "access": "public"