@polyv/request-plugin-aes 2.0.0

package/README.md

@@ -0,0 +1,61 @@
+# AESRequestPlugin
+
+用途：AES 加密插件，可对请求和响应数据进行 AES 加密和解密处理。
+
+## 实例化参数
+
+| 参数名 | 用途 | 类型 | 默认值 |
+| - | - | - | - |
+| `appId` | 应用 ID | `string` | - |
+| `appSecret` | 应用密钥 | `string` | - |
+| `encryptPostAES` | 是否对 POST 请求主体进行 AES 加密 | `boolean` | `true` |
+
+## 请求选项
+
+| 参数名 | 用途 | 类型 | 默认值 |
+| - | - | - | - |
+| `useAES` | 是否使用 AES 加密 | `boolean` | `true` |
+| `encryptPostAES` | 是否对 POST 请求主体进行 AES 加密 | `boolean` | - |
+
+## 使用方式
+
+```js
+import { PolyvRequest } from '@polyv/request-core';
+import { AESRequestPlugin } from '@polyv/request-plugin-aes';
+
+// 基础用法
+const requester = new PolyvRequest({
+  requestPlugins: [
+    new AESRequestPlugin(),
+  ]
+});
+
+// 配置应用 ID 和密钥（用于某些特殊接口的加密）
+const requester = new PolyvRequest({
+  requestPlugins: [
+    new AESRequestPlugin({
+      appId: 'yourAppId',
+      appSecret: 'yourAppSecret',
+    }),
+  ]
+});
+
+// 禁用 POST 请求主体加密
+const requester = new PolyvRequest({
+  requestPlugins: [
+    new AESRequestPlugin({
+      encryptPostAES: false,
+    }),
+  ]
+});
+
+// 在某个请求中禁用 AES 加密
+requester.get('/api/data', {}, {
+  useAES: false,
+});
+
+// 在某个请求中禁用 POST 请求主体加密
+requester.post('/api/data', { name: 'test' }, {
+  encryptPostAES: false,
+});
+```

package/aes-plugin.d.ts

@@ -0,0 +1,32 @@
+import type { RequestOptions, RequestPlugin, RequestResult } from '@polyv/request-core';
+import { AESRequestPluginConfig } from './types';
+/**
+ * AES 请求插件
+ */
+export declare class AESRequestPlugin implements RequestPlugin {
+    private __config;
+    private __encryptPostAES;
+    constructor(__config?: AESRequestPluginConfig);
+    usePlugin(options: RequestOptions): boolean;
+    interceptIncludeParams(): object | void;
+    interceptEncryptRequest(options: RequestOptions): RequestOptions;
+    interceptDecryptResponse(result: RequestResult): RequestResult;
+    /**
+     * 处理 headers
+     * @param options 请求选项
+     */
+    private __handleHeaders;
+    /**
+     * 处理 data
+     * @param options 请求选项
+     */
+    private __handleData;
+    /**
+     * 获取解密 key
+     */
+    private __getDecryptKeyInfo;
+    /**
+     * 获取加密 key
+     */
+    private __getEncryptKeyInfo;
+}

package/aes-plugin.js

@@ -0,0 +1,111 @@
+import { INTERNAL_AES_DECRYPT_IV, INTERNAL_AES_DECRYPT_SIGN, INTERNAL_AES_ENCRYPT_IV, INTERNAL_AES_ENCRYPT_SIGN } from './config';
+import { encryptTextCBC } from './utils';
+import { decryptTextAES, AESDecryptType } from '@polyv/request-plugin-aes-decrypt';
+// 1. 插件会在请求中自动添加 `encryptResponseType: 1` 参数，告知服务端需要返回加密数据
+// 2. 对于 POST 请求，默认会对请求体进行 AES CBC 模式的加密，并添加 `x-e-type: 1` 请求头
+// 3. 当服务端返回加密数据时（`encryption: true`），插件会自动对响应数据进行解密
+// 4. 插件内部使用固定的加密和解密密钥，但如果请求中包含 `appId` 参数且与初始化配置的 `appId` 一致，则会使用配置的 `appSecret` 作为加密密钥
+/**
+ * AES 请求插件
+ */
+export class AESRequestPlugin {
+    __config;
+    __encryptPostAES;
+    constructor(__config = {}) {
+        this.__config = __config;
+        this.__encryptPostAES = __config.encryptPostAES ?? true;
+    }
+    usePlugin(options) {
+        const { useAES = true } = options;
+        return useAES;
+    }
+    interceptIncludeParams() {
+        return {
+            // 插入 encryptResponseType 为 1，表示需要进行 aes 加密
+            encryptResponseType: 1,
+        };
+    }
+    interceptEncryptRequest(options) {
+        // 处理 data
+        const data = this.__handleData(options);
+        // 处理 header
+        const headers = this.__handleHeaders(options);
+        return {
+            ...options,
+            data,
+            headers,
+        };
+    }
+    interceptDecryptResponse(result) {
+        const res = result.data;
+        if (!res.encryption || typeof res.data !== 'string') {
+            return result;
+        }
+        const data = res.data;
+        const decryptKeyInfo = this.__getDecryptKeyInfo();
+        res.data = decryptTextAES(data, decryptKeyInfo, AESDecryptType.Base64);
+        return result;
+    }
+    /**
+     * 处理 headers
+     * @param options 请求选项
+     */
+    __handleHeaders(options) {
+        const headers = (options.headers || {});
+        const { encryptPostAES = this.__encryptPostAES } = options;
+        if (options.method?.toLocaleUpperCase() === 'POST' && encryptPostAES) {
+            headers['x-e-type'] = 1;
+        }
+        return headers;
+    }
+    /**
+     * 处理 data
+     * @param options 请求选项
+     */
+    __handleData(options) {
+        const data = options.data || {};
+        if (options.method?.toLocaleUpperCase() !== 'POST') {
+            return data;
+        }
+        let newData = data;
+        const { encryptPostAES = this.__encryptPostAES } = options;
+        if (encryptPostAES) {
+            // 强制使用 json 提交
+            options.requestType = 'json';
+            let targetText = '';
+            if (typeof data === 'string') {
+                targetText = data;
+            }
+            else if (typeof data === 'object') {
+                targetText = JSON.stringify(data);
+            }
+            const encryptKeyInfo = this.__getEncryptKeyInfo(options);
+            newData = encryptTextCBC(targetText, encryptKeyInfo);
+        }
+        return newData;
+    }
+    /**
+     * 获取解密 key
+     */
+    __getDecryptKeyInfo() {
+        return {
+            sign: INTERNAL_AES_DECRYPT_SIGN,
+            iv: INTERNAL_AES_DECRYPT_IV,
+        };
+    }
+    /**
+     * 获取加密 key
+     */
+    __getEncryptKeyInfo(options) {
+        const params = (options.params || {});
+        let sign = INTERNAL_AES_ENCRYPT_SIGN;
+        // 对于在 params 中传入了 appId 时，后端使用对应的 appSecret 进行解密
+        if ('appId' in params && params.appId === this.__config.appId && this.__config.appSecret) {
+            sign = this.__config.appSecret;
+        }
+        return {
+            sign,
+            iv: INTERNAL_AES_ENCRYPT_IV,
+        };
+    }
+}

package/config.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @ignore
+ */
+export declare const INTERNAL_AES_ENCRYPT_SIGN: string;
+/**
+ * @ignore
+ */
+export declare const INTERNAL_AES_ENCRYPT_IV: string;
+/**
+ * @ignore
+ */
+export declare const INTERNAL_AES_DECRYPT_SIGN: string;
+/**
+ * @ignore
+ */
+export declare const INTERNAL_AES_DECRYPT_IV: string;

package/config.js

@@ -0,0 +1,21 @@
+import { decode } from 'js-base64';
+/**
+ * @ignore
+ */
+// 内部的 AES 加密签名：KLfO7ZnfQC8jIvEX
+export const INTERNAL_AES_ENCRYPT_SIGN = decode('S0xmTzdabmZRQzhqSXZFWA==');
+/**
+ * @ignore
+ */
+// 内部的 AES 加密偏移量：VTRe7SmdllRsJ7Cb
+export const INTERNAL_AES_ENCRYPT_IV = decode('VlRSZTdTbWRsbFJzSjdDYg==');
+/**
+ * @ignore
+ */
+// 内部的 AES 解密签名：PolyvApiResponse
+export const INTERNAL_AES_DECRYPT_SIGN = decode('UG9seXZBcGlSZXNwb25zZQ==');
+/**
+ * @ignore
+ */
+// 内部的 AES 解密偏移量：PolyvLiveEncrypt
+export const INTERNAL_AES_DECRYPT_IV = decode('UG9seXZMaXZlRW5jcnlwdA==');

package/index.d.ts

@@ -0,0 +1,4 @@
+export * from './aes-plugin';
+export * from './types';
+export * from './utils';
+export * from './request-options';

package/index.js

@@ -0,0 +1,4 @@
+export * from './aes-plugin';
+export * from './types';
+export * from './utils';
+export * from './request-options';

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@polyv/request-plugin-aes",
+  "version": "2.0.0",
+  "main": "./index.js",
+  "dependencies": {
+    "@polyv/request-core": "2.0.0",
+    "@polyv/request-plugin-aes-decrypt": "2.0.0",
+    "aes-js": "^3.1.2",
+    "crypto-js": "^4.1.1",
+    "js-base64": "^3.7.5"
+  },
+  "types": "./index.d.ts"
+}

package/request-options.d.ts

@@ -0,0 +1,21 @@
+export interface AESRequestOptions {
+    /**
+     * 是否使用 aes 加密
+     * @default true
+     * @plugin `AESRequestPlugin`
+     */
+    useAES?: boolean;
+    /**
+     * 是否对 post 请求主体进行 aes 加密
+     * @plugin `AESRequestPlugin`
+     */
+    encryptPostAES?: boolean;
+}
+declare module '@polyv/request-core' {
+    interface RequestCustomOptions extends AESRequestOptions {
+    }
+}
+declare module 'axios' {
+    interface AxiosRequestConfig extends AESRequestOptions {
+    }
+}

package/request-options.js

@@ -0,0 +1 @@
+export {};

package/types.d.ts

@@ -0,0 +1,19 @@
+export interface AESRequestPluginConfig {
+    /**
+     * 应用 id
+     */
+    appId?: string;
+    /**
+     * 应用密钥
+     */
+    appSecret?: string;
+    /**
+     * 是否对 post 请求主体进行 aes 加密
+     * @default true
+     */
+    encryptPostAES?: boolean;
+}
+export interface AESInnerResData {
+    encryption: boolean;
+    data: unknown;
+}

package/types.js

@@ -0,0 +1 @@
+export {};

package/utils.d.ts

@@ -0,0 +1,8 @@
+import { AESKeyInfo } from '@polyv/request-plugin-aes-decrypt';
+/**
+ * 加密数据（CBC 方式）
+ * @param targetText 目标文本
+ * @param encryptKeys 加密 key 信息
+ * @returns 加密后的密文
+ */
+export declare function encryptTextCBC(targetText: string, encryptKeys: AESKeyInfo): string;

package/utils.js

@@ -0,0 +1,17 @@
+import CryptoJS from 'crypto-js';
+/**
+ * 加密数据（CBC 方式）
+ * @param targetText 目标文本
+ * @param encryptKeys 加密 key 信息
+ * @returns 加密后的密文
+ */
+export function encryptTextCBC(targetText, encryptKeys) {
+    const { sign, iv } = encryptKeys;
+    const cryptoKey = CryptoJS.enc.Utf8.parse(sign);
+    const secretData = CryptoJS.enc.Utf8.parse(targetText);
+    return CryptoJS.AES.encrypt(secretData, cryptoKey, {
+        iv: CryptoJS.enc.Utf8.parse(iv),
+        mode: CryptoJS.mode.CBC,
+        padding: CryptoJS.pad.Pkcs7
+    }).toString();
+}