@alibarbar/common 1.1.2 → 1.1.4

package/dist/crypto.d.mts

@@ -1,12 +1,9 @@
+import CryptoJS from 'crypto-js';
+
 /**
  * 加密工具函数
  */
-/**
- * SHA256加密
- * @param data - 要加密的数据（字符串或ArrayBuffer）
- * @returns Promise<string> 加密后的十六进制字符串
- */
-declare function sha256(data: string | ArrayBuffer): Promise<string>;
+
 /**
  * Base64编码
  * @param data - 要编码的数据（字符串或ArrayBuffer）
@@ -14,126 +11,76 @@ declare function sha256(data: string | ArrayBuffer): Promise<string>;
  */
 declare function base64Encode(data: string | ArrayBuffer): string;
 /**
- * Base64解码
- * @param data - Base64编码字符串
- * @returns 解码后的字符串
+ * 生成随机 AES 密钥（字符串形式）
+ * 注意：仅用于对称加密场景（例如 SecureStorage），不直接作为 RSA 密钥使用
  */
-declare function base64Decode(data: string): string;
+declare function generateRandomAESKeyString(): string;
 /**
- * 生成UUID v4
- * @returns UUID字符串
+ * 使用 AES 加密任意可序列化数据（内部使用 CryptoJS）
+ * @param data - 任意可 JSON 序列化的数据
+ * @param aesKey - AES 密钥字符串
+ * @returns 密文字符串
  */
-declare function generateUUID(): string;
+declare function encryptJsonWithAES(data: unknown, aesKey: string): string;
 /**
- * 生成随机字符串
- * @param length - 字符串长度
- * @param charset - 字符集，默认为 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
- * @returns 随机字符串
+ * 使用 AES 解密为 JSON 数据（内部使用 CryptoJS）
+ * @param encryptedData - 密文字符串
+ * @param aesKey - AES 密钥字符串
+ * @returns 还原后的数据
  */
-declare function generateRandomString(length: number, charset?: string): string;
+declare function decryptJsonWithAES<T = unknown>(encryptedData: string, aesKey: string): T;
 /**
- * 通用哈希函数（简单实现）
- * @param data - 要哈希的数据
- * @returns 哈希值
+ * 字符串形式的 RSA 密钥对（用于浏览器端加解密）
+ * - publicKey / privateKey 均为字符串（PEM 或 Base64 格式）
+ * - 主要用于生成和配置环境变量（例如 VITE_RSA_PUBLIC_KEY / VITE_RSA_PRIVATE_KEY）
  */
-declare function hash(data: string): number;
-/**
- * RSA密钥对类型
- */
-interface RSAKeyPair {
-    publicKey: CryptoKey;
-    privateKey: CryptoKey;
+interface RSAKeyPairStrings {
+    publicKey: string;
+    privateKey: string;
 }
 /**
- * 生成RSA密钥对
- * @param modulusLength - 密钥长度，默认为 2048
- * @returns Promise<RSAKeyPair> RSA密钥对
- */
-declare function generateRSAKeyPair(modulusLength?: number): Promise<RSAKeyPair>;
-/**
- * RSA加密
- * @param data - 要加密的数据（字符串）
- * @param publicKey - 公钥
- * @returns Promise<string> Base64编码的加密数据
- */
-declare function rsaEncrypt(data: string, publicKey: CryptoKey): Promise<string>;
-/**
- * RSA解密
- * @param encryptedData - Base64编码的加密数据
- * @param privateKey - 私钥
- * @returns Promise<string> 解密后的字符串
- */
-declare function rsaDecrypt(encryptedData: string, privateKey: CryptoKey): Promise<string>;
-/**
- * 导出公钥为Base64字符串
- * @param publicKey - 公钥
- * @returns Promise<string> Base64编码的公钥
- */
-declare function exportPublicKey(publicKey: CryptoKey): Promise<string>;
-/**
- * 导出私钥为Base64字符串
- * @param privateKey - 私钥
- * @returns Promise<string> Base64编码的私钥
- */
-declare function exportPrivateKey(privateKey: CryptoKey): Promise<string>;
-/**
- * 从Base64字符串导入公钥
- * @param keyData - Base64编码的公钥
- * @returns Promise<CryptoKey> 公钥对象
+ * 从环境变量中读取 RSA 公钥
  */
-declare function importPublicKey(keyData: string): Promise<CryptoKey>;
+declare function getEnvPublicKey(): string;
 /**
- * 从Base64字符串导入私钥
- * @param keyData - Base64编码的私钥
- * @returns Promise<CryptoKey> 私钥对象
+ * 从环境变量中读取 RSA 私钥
  */
-declare function importPrivateKey(keyData: string): Promise<CryptoKey>;
+declare function getEnvPrivateKey(): string;
 /**
- * 生成 HMAC 密钥
- * @returns Promise<CryptoKey> HMAC 密钥
+ * 使用指定公钥进行 RSA 加密（内部工具函数）
  */
-declare function generateHMACKey(): Promise<CryptoKey>;
+declare function rsaEncrypt(plain: string, publicKeyPem: string | CryptoJS.lib.WordArray | CryptoKey): Promise<string>;
 /**
- * 计算 HMAC 签名
- * @param data - 要签名的数据（字符串或ArrayBuffer）
- * @param key - HMAC密钥
- * @returns Promise<string> Base64编码的HMAC签名
+ * 使用指定私钥进行 RSA 解密（内部工具函数）
  */
-declare function computeHMAC(data: string | ArrayBuffer, key: CryptoKey): Promise<string>;
+declare function rsaDecrypt(cipher: string, privateKeyPem: string | CryptoJS.lib.WordArray | CryptoKey): Promise<string>;
 /**
- * 验证 HMAC 签名
- * @param data - 原始数据（字符串或ArrayBuffer）
- * @param signature - Base64编码的HMAC签名
- * @param key - HMAC密钥
- * @returns Promise<boolean> 签名是否有效
+ * 使用环境变量中的公钥进行 RSA 加密
  */
-declare function verifyHMAC(data: string | ArrayBuffer, signature: string, key: CryptoKey): Promise<boolean>;
+declare function encryptWithEnvPublicKey(plain: string): Promise<string>;
 /**
- * 使用 PBKDF2 派生密钥
- * @param password - 密码（字符串）
- * @param salt - 盐值（ArrayBuffer 或字符串）
- * @param iterations - 迭代次数，默认为 100000
- * @param keyLength - 密钥长度（位），默认为 256
- * @returns Promise<CryptoKey> 派生的密钥
+ * 使用环境变量中的私钥进行 RSA 解密
  */
-declare function deriveKeyFromPassword(password: string, salt: ArrayBuffer | string, iterations?: number, keyLength?: number): Promise<CryptoKey>;
+declare function decryptWithEnvPrivateKey(cipher: string): Promise<string>;
 /**
- * 使用 AES-GCM 加密数据
- * @param data - 要加密的数据（字符串或ArrayBuffer）
- * @param key - AES密钥
- * @returns Promise<{encrypted: string, iv: string}> 加密后的数据和初始向量（Base64编码）
+ * 生成 RSA 密钥对（导出为 PEM 格式字符串）
+ * 注意：JSEncrypt 不支持直接生成密钥对，需要使用 WebCrypto 生成后导出为 PEM
+ * 该函数仅用于在构建/初始化阶段生成一对密钥，供配置到环境变量中使用
  */
-declare function aesGCMEncrypt(data: string | ArrayBuffer, key: CryptoKey): Promise<{
-    encrypted: string;
-    iv: string;
+declare function generateRSAKeyPair(modulusLength?: number): Promise<{
+    publicKey: string;
+    privateKey: string;
 }>;
 /**
- * 使用 AES-GCM 解密数据
- * @param encryptedData - Base64编码的加密数据
- * @param iv - Base64编码的初始向量
- * @param key - AES密钥
- * @returns Promise<string> 解密后的字符串
+ * 默认导出一个简单的函数集合，方便按实例方式使用（非必须）
+ * - encrypt: 使用环境变量公钥加密
+ * - decrypt: 使用环境变量私钥解密
  */
-declare function aesGCMDecrypt(encryptedData: string, iv: string, key: CryptoKey): Promise<string>;
+declare const rsaEnv: {
+    encrypt: typeof encryptWithEnvPublicKey;
+    decrypt: typeof decryptWithEnvPrivateKey;
+    getPublicKey: typeof getEnvPublicKey;
+    getPrivateKey: typeof getEnvPrivateKey;
+};
 
-export { type RSAKeyPair, aesGCMDecrypt, aesGCMEncrypt, base64Decode, base64Encode, computeHMAC, deriveKeyFromPassword, exportPrivateKey, exportPublicKey, generateHMACKey, generateRSAKeyPair, generateRandomString, generateUUID, hash, importPrivateKey, importPublicKey, rsaDecrypt, rsaEncrypt, sha256, verifyHMAC };
+export { type RSAKeyPairStrings, base64Encode, decryptJsonWithAES, decryptWithEnvPrivateKey, rsaEnv as default, encryptJsonWithAES, encryptWithEnvPublicKey, generateRSAKeyPair, generateRandomAESKeyString, getEnvPrivateKey, getEnvPublicKey, rsaDecrypt, rsaEncrypt };

package/dist/crypto.d.ts

@@ -1,12 +1,9 @@
+import CryptoJS from 'crypto-js';
+
 /**
  * 加密工具函数
  */
-/**
- * SHA256加密
- * @param data - 要加密的数据（字符串或ArrayBuffer）
- * @returns Promise<string> 加密后的十六进制字符串
- */
-declare function sha256(data: string | ArrayBuffer): Promise<string>;
+
 /**
  * Base64编码
  * @param data - 要编码的数据（字符串或ArrayBuffer）
@@ -14,126 +11,76 @@ declare function sha256(data: string | ArrayBuffer): Promise<string>;
  */
 declare function base64Encode(data: string | ArrayBuffer): string;
 /**
- * Base64解码
- * @param data - Base64编码字符串
- * @returns 解码后的字符串
+ * 生成随机 AES 密钥（字符串形式）
+ * 注意：仅用于对称加密场景（例如 SecureStorage），不直接作为 RSA 密钥使用
  */
-declare function base64Decode(data: string): string;
+declare function generateRandomAESKeyString(): string;
 /**
- * 生成UUID v4
- * @returns UUID字符串
+ * 使用 AES 加密任意可序列化数据（内部使用 CryptoJS）
+ * @param data - 任意可 JSON 序列化的数据
+ * @param aesKey - AES 密钥字符串
+ * @returns 密文字符串
  */
-declare function generateUUID(): string;
+declare function encryptJsonWithAES(data: unknown, aesKey: string): string;
 /**
- * 生成随机字符串
- * @param length - 字符串长度
- * @param charset - 字符集，默认为 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'
- * @returns 随机字符串
+ * 使用 AES 解密为 JSON 数据（内部使用 CryptoJS）
+ * @param encryptedData - 密文字符串
+ * @param aesKey - AES 密钥字符串
+ * @returns 还原后的数据
  */
-declare function generateRandomString(length: number, charset?: string): string;
+declare function decryptJsonWithAES<T = unknown>(encryptedData: string, aesKey: string): T;
 /**
- * 通用哈希函数（简单实现）
- * @param data - 要哈希的数据
- * @returns 哈希值
+ * 字符串形式的 RSA 密钥对（用于浏览器端加解密）
+ * - publicKey / privateKey 均为字符串（PEM 或 Base64 格式）
+ * - 主要用于生成和配置环境变量（例如 VITE_RSA_PUBLIC_KEY / VITE_RSA_PRIVATE_KEY）
  */
-declare function hash(data: string): number;
-/**
- * RSA密钥对类型
- */
-interface RSAKeyPair {
-    publicKey: CryptoKey;
-    privateKey: CryptoKey;
+interface RSAKeyPairStrings {
+    publicKey: string;
+    privateKey: string;
 }
 /**
- * 生成RSA密钥对
- * @param modulusLength - 密钥长度，默认为 2048
- * @returns Promise<RSAKeyPair> RSA密钥对
- */
-declare function generateRSAKeyPair(modulusLength?: number): Promise<RSAKeyPair>;
-/**
- * RSA加密
- * @param data - 要加密的数据（字符串）
- * @param publicKey - 公钥
- * @returns Promise<string> Base64编码的加密数据
- */
-declare function rsaEncrypt(data: string, publicKey: CryptoKey): Promise<string>;
-/**
- * RSA解密
- * @param encryptedData - Base64编码的加密数据
- * @param privateKey - 私钥
- * @returns Promise<string> 解密后的字符串
- */
-declare function rsaDecrypt(encryptedData: string, privateKey: CryptoKey): Promise<string>;
-/**
- * 导出公钥为Base64字符串
- * @param publicKey - 公钥
- * @returns Promise<string> Base64编码的公钥
- */
-declare function exportPublicKey(publicKey: CryptoKey): Promise<string>;
-/**
- * 导出私钥为Base64字符串
- * @param privateKey - 私钥
- * @returns Promise<string> Base64编码的私钥
- */
-declare function exportPrivateKey(privateKey: CryptoKey): Promise<string>;
-/**
- * 从Base64字符串导入公钥
- * @param keyData - Base64编码的公钥
- * @returns Promise<CryptoKey> 公钥对象
+ * 从环境变量中读取 RSA 公钥
  */
-declare function importPublicKey(keyData: string): Promise<CryptoKey>;
+declare function getEnvPublicKey(): string;
 /**
- * 从Base64字符串导入私钥
- * @param keyData - Base64编码的私钥
- * @returns Promise<CryptoKey> 私钥对象
+ * 从环境变量中读取 RSA 私钥
  */
-declare function importPrivateKey(keyData: string): Promise<CryptoKey>;
+declare function getEnvPrivateKey(): string;
 /**
- * 生成 HMAC 密钥
- * @returns Promise<CryptoKey> HMAC 密钥
+ * 使用指定公钥进行 RSA 加密（内部工具函数）
  */
-declare function generateHMACKey(): Promise<CryptoKey>;
+declare function rsaEncrypt(plain: string, publicKeyPem: string | CryptoJS.lib.WordArray | CryptoKey): Promise<string>;
 /**
- * 计算 HMAC 签名
- * @param data - 要签名的数据（字符串或ArrayBuffer）
- * @param key - HMAC密钥
- * @returns Promise<string> Base64编码的HMAC签名
+ * 使用指定私钥进行 RSA 解密（内部工具函数）
  */
-declare function computeHMAC(data: string | ArrayBuffer, key: CryptoKey): Promise<string>;
+declare function rsaDecrypt(cipher: string, privateKeyPem: string | CryptoJS.lib.WordArray | CryptoKey): Promise<string>;
 /**
- * 验证 HMAC 签名
- * @param data - 原始数据（字符串或ArrayBuffer）
- * @param signature - Base64编码的HMAC签名
- * @param key - HMAC密钥
- * @returns Promise<boolean> 签名是否有效
+ * 使用环境变量中的公钥进行 RSA 加密
  */
-declare function verifyHMAC(data: string | ArrayBuffer, signature: string, key: CryptoKey): Promise<boolean>;
+declare function encryptWithEnvPublicKey(plain: string): Promise<string>;
 /**
- * 使用 PBKDF2 派生密钥
- * @param password - 密码（字符串）
- * @param salt - 盐值（ArrayBuffer 或字符串）
- * @param iterations - 迭代次数，默认为 100000
- * @param keyLength - 密钥长度（位），默认为 256
- * @returns Promise<CryptoKey> 派生的密钥
+ * 使用环境变量中的私钥进行 RSA 解密
  */
-declare function deriveKeyFromPassword(password: string, salt: ArrayBuffer | string, iterations?: number, keyLength?: number): Promise<CryptoKey>;
+declare function decryptWithEnvPrivateKey(cipher: string): Promise<string>;
 /**
- * 使用 AES-GCM 加密数据
- * @param data - 要加密的数据（字符串或ArrayBuffer）
- * @param key - AES密钥
- * @returns Promise<{encrypted: string, iv: string}> 加密后的数据和初始向量（Base64编码）
+ * 生成 RSA 密钥对（导出为 PEM 格式字符串）
+ * 注意：JSEncrypt 不支持直接生成密钥对，需要使用 WebCrypto 生成后导出为 PEM
+ * 该函数仅用于在构建/初始化阶段生成一对密钥，供配置到环境变量中使用
  */
-declare function aesGCMEncrypt(data: string | ArrayBuffer, key: CryptoKey): Promise<{
-    encrypted: string;
-    iv: string;
+declare function generateRSAKeyPair(modulusLength?: number): Promise<{
+    publicKey: string;
+    privateKey: string;
 }>;
 /**
- * 使用 AES-GCM 解密数据
- * @param encryptedData - Base64编码的加密数据
- * @param iv - Base64编码的初始向量
- * @param key - AES密钥
- * @returns Promise<string> 解密后的字符串
+ * 默认导出一个简单的函数集合，方便按实例方式使用（非必须）
+ * - encrypt: 使用环境变量公钥加密
+ * - decrypt: 使用环境变量私钥解密
  */
-declare function aesGCMDecrypt(encryptedData: string, iv: string, key: CryptoKey): Promise<string>;
+declare const rsaEnv: {
+    encrypt: typeof encryptWithEnvPublicKey;
+    decrypt: typeof decryptWithEnvPrivateKey;
+    getPublicKey: typeof getEnvPublicKey;
+    getPrivateKey: typeof getEnvPrivateKey;
+};
 
-export { type RSAKeyPair, aesGCMDecrypt, aesGCMEncrypt, base64Decode, base64Encode, computeHMAC, deriveKeyFromPassword, exportPrivateKey, exportPublicKey, generateHMACKey, generateRSAKeyPair, generateRandomString, generateUUID, hash, importPrivateKey, importPublicKey, rsaDecrypt, rsaEncrypt, sha256, verifyHMAC };
+export { type RSAKeyPairStrings, base64Encode, decryptJsonWithAES, decryptWithEnvPrivateKey, rsaEnv as default, encryptJsonWithAES, encryptWithEnvPublicKey, generateRSAKeyPair, generateRandomAESKeyString, getEnvPrivateKey, getEnvPublicKey, rsaDecrypt, rsaEncrypt };