knight-web 2.0.3 → 2.0.5

package/frame/utility/CryptoUtility.d.ts

@@ -0,0 +1,215 @@
+import { Hasher, WordArray } from 'crypto-es';
+import { Format } from 'crypto-es/dist/cipher-core.cjs';
+import { Encoder, HasherCfg } from 'crypto-es/dist/core.cjs';
+/** 加密工具类
+ * npm install crypto-es
+ * npm install @types/crypto-es
+ * npm install jsonwebtoken
+ * npm install @types/jsonwebtoken
+ */
+export declare namespace CryptoUtility {
+    /** 常用Token加解密工具 */
+    class Token {
+        /**
+         * 验签及解析Token
+         * @param _cipherText
+         * @param _key
+         */
+        static CheckToken(_cipherText: string, _key?: string): ICheckResult;
+        /**
+         * 解析Base64URL
+         * @param _message
+         * @returns
+         */
+        static OnBase64UrlDecode(_message: string): string;
+    }
+    /** 检测结果 */
+    interface ICheckResult {
+        header: object;
+        payload: object;
+        signature: boolean;
+    }
+    /**
+     * AES（Advanced Encryption Standard）加密算法工具
+     * @introduce 最常用的对称加密算法，支持不同的密钥长度（128、192 和 256 位）
+     */
+    class _AES {
+        /** 获取编码转换器 */
+        private static OnGetEncoder;
+        /** 获取密文配置
+         * CBC、CFB、OFB、CTR模式必须提供IV,ECB模式不能提供IV
+         * IV长度通常为16字节（128位）
+         */
+        private static OnGetCipherCfg;
+        /**
+         * 加密
+         * @param context 待加密数据
+         * @param key 密钥
+         * @param cipherConfig 密文配置参数
+         * @returns 加密后数据
+         */
+        static Encrypt(context: string, key: string, cipherConfig?: CipherConfig): string;
+        /**
+         * 解密
+         * @param context 待解密数据
+         * @param key 密钥
+         * @param cipherConfig 配置参数
+         * @returns WordArray 密文参数
+         */
+        static Decrypt(context: string, key: string, cipherConfig?: CipherConfig): string;
+    }
+    /** 密文配置 */
+    interface CipherConfig {
+        /** 初始化向量(IV长度通常为16字节128位) */
+        iv?: string;
+        /** 分组密码模式 */
+        mode?: E_ModeType;
+        /** 填充策略 */
+        padding?: E_PaddingType;
+        /** 序列化格式化器 */
+        format?: Format;
+        /** 密钥派生函数 */
+        kdf?: KDF;
+        /** 用于密钥生成的盐值 */
+        salt?: string;
+        /** 用于密钥生成的哈希器 */
+        hasher?: new (cfg?: HasherCfg) => Hasher;
+        /** RC4 降值操作 */
+        drop?: number;
+    }
+    /** 编码转换类型 */
+    enum E_EncodeType {
+        Base64 = "base64",
+        Hex = "hex",
+        Latin1 = "latin1",
+        Utf16 = "utf16",
+        Utf16BE = "utf16BE",
+        Utf16LE = "utf16LE",
+        Utf8 = "utf8"
+    }
+    /** 加密模式类型 */
+    enum E_ModeType {
+        CBC = "cbc",
+        ECB = "ecb",
+        CFB = "cfb",
+        OFB = "ofb",
+        CTR = "ctr",
+        GCM = "gcm"
+    }
+    /** 填充方式类型 */
+    enum E_PaddingType {
+        PKCS7 = "pkcs7",
+        PKCS5 = "pkcs5",
+        ZeroPadding = "zeropadding",
+        ISO10126 = "iso10126",
+        ISO97971 = "iso97971",
+        Ansix923 = "ansix923",
+        NoPadding = "nopadding"
+    }
+    /** 编码转换 */
+    class Encode {
+        /**
+        * Base64编码
+        * @param data 输入数据
+        * @returns 编码后的字符集
+        */
+        static Base64: Encoder;
+        /**
+         * Base64url编码
+         * @param data 输入数据
+         * @returns 编码后的字符集
+         */
+        /**
+         * Hex编码
+         * @param data 输入数据
+         * @returns 编码后的字符集
+         */
+        static Hex: Encoder;
+        /**
+         * Latin1编码
+         * @param data 输入数据
+         * @returns 编码后的字符集
+         */
+        static Latin1: Encoder;
+        /**
+         * Utf16编码
+         * @param data 输入数据
+         * @returns 编码后的字符集
+         */
+        static Utf16: Encoder;
+        /**
+         * Utf16BE编码
+         * @param data 输入数据
+         * @returns 编码后的字符集
+         */
+        static Utf16BE: Encoder;
+        /**
+         * Utf16LE编码
+         * @param data 输入数据
+         * @returns 编码后的字符集
+         */
+        static Utf16LE: Encoder;
+        /**
+         * Utf16LE编码
+         * @param data 输入数据
+         * @returns 编码后的字符集
+         */
+        static Utf8: Encoder;
+    }
+    /**
+     * 格式化工具
+     */
+    class _Format {
+        /** Hex */
+        static Hex: Encoder;
+    }
+    /**
+     * KDF工具
+     */
+    class KDF {
+    }
+    /**
+     * 使用SHA256进行哈希计算
+     * @param message 输入数据
+     * @param cfg 哈希配置数据
+     * @returns 哈希后的值
+     * @example
+     *  const hash = CryptoUtility.SHA256('message');
+     *  const hash = CryptoUtility.SHA256(wordArray);
+     */
+    function _SHA256(message: WordArray | string, cfg?: HasherCfg): WordArray;
+    /**
+     * 使用MD5进行哈希计算
+     * @param message 输入数据
+     * @param cfg 哈希配置数据
+     * @returns 哈希后的值
+     * @example
+     * const hash = CryptoUtility.MD5('message');
+     * const hash = CryptoUtility.MD5(wordArray);
+     */
+    function _MD5(message: WordArray | string, cfg?: HasherCfg): WordArray;
+    /**
+     * HmacSHA256编码
+     * @param message 输入数据
+     * @param key 密钥
+     * @returns 编码后的值
+     * @example
+     * const hmac = CryptoUtility.HmacSHA256(message, key);
+     */
+    function _HmacSHA256(message: WordArray | string, key: WordArray | string): WordArray;
+    /**
+     * HmacSHA256编码
+     * @param message 输入数据
+     * @param key 密钥
+     * @returns 编码后的值
+     * @example
+     * const hmac = CryptoUtility.HmacMD5(message, key);
+     */
+    function _HmacMD5(message: WordArray | string, key: WordArray | string): WordArray;
+    /**
+     * 随机生成密钥
+     * @param length 密钥长度
+     * @returns 随机生成的密钥
+     */
+    function _RandomKey(length?: number): string;
+}