✨ 核心特性

我们推崇极简与灵活并存的工程理念：

* 全栈覆盖：一套代码无缝运行于 Node.js (>= 18) 与浏览器环境，无需 polyfill。
* 双重范式：既支持现代的 纯函数式（Functional） 调用，也保留了传统的 面向对象（OOP） 封装。
* 按需加载：支持 Tree-shaking，你可以只导入 sm2，而不必引入整个库。
* 类型安全：内建完整的 .d.ts 类型定义，编码即文档。
* 标准对齐：严格遵循 GM/T 系列国密标准文档，兼容 OpenSSL 等主流实现的密文格式。

---

🚀 安装与环境

环境要求：Node.js >= 18 或任意支持 ES6+ 的现代浏览器。

``bash

npm

npm install gmkitx

pnpm (推荐)

pnpm add gmkitx

yarn

yarn add gmkitx
``

-----

⚡ 快速上手

$3

适合现代前端开发，利于 Tree-shaking，代码更简洁。

`ts
import {
digest, // SM3
sm4Encrypt, // SM4
sm4Decrypt,
sm2Encrypt, // SM2
sm2Decrypt,
generateKeyPair,
CipherMode,
PaddingMode
} from 'gmkitx';

// 1. SM3 摘要
const hash = digest('Hello, SM3!');

// 2. SM4 对称加密 (CBC模式)
const key = '0123456789abcdeffedcba9876543210'; // 128位密钥
const iv = 'fedcba98765432100123456789abcdef'; // 初始化向量

const ciphertext = sm4Encrypt(key, '我的机密数据', {
mode: CipherMode.CBC,
padding: PaddingMode.PKCS7,
iv,
});

// 3. SM2 非对称加密
const { publicKey, privateKey } = generateKeyPair();
const encData = sm2Encrypt(publicKey, 'Hello, SM2!');
const decData = sm2Decrypt(privateKey, encData);
`

$3

结构清晰，适合大型项目统一管理加密模块。

`ts
import { sm2, sm3, sm4, sha } from 'gmkitx';

// 统一入口调用
const hash = sm3.digest('Hello');
const sig = sm2.sign(privateKey, 'Message');
const verified = sm2.verify(publicKey, 'Message', sig);

// SHA 国际标准
const sha512Hash = sha.sha512('Hello World');
`

$3

通过 UMD 构建包，在 HTML 中直接使用全局变量 GMKit。

`html


`

-----

📚 API 深度指南

$3

- 加/解密、签名/验签、密钥对生成；默认 C1C3C2，可切换 C1C2C3。
- Node/浏览器同构，面向对象与函数式并行。

`ts
import { SM2, SM2CipherMode } from 'gmkitx';

const sm2 = SM2.fromPrivateKey(privateKey);
const signature = sm2.sign('核心指令');
const verified = sm2.verify('核心指令', signature);

const cipher = sm2.encrypt('数据', SM2CipherMode.C1C3C2);
const plain = sm2.decrypt(cipher);
`

$3

- 流式更新，Hex/Base64/Uint8Array 输出；与 SHA API 对齐。

`ts
import { SM3, OutputFormat } from 'gmkitx';

const sm3 = new SM3();
sm3.update('part-1');
sm3.update('part-2');

const hex = sm3.digest(); // 默认 Hex
const base64 = sm3.digest({ format: OutputFormat.BASE64 });
`

$3

- 支持 ECB | CBC | CTR | CFB | OFB | GCM，PKCS7/NoPadding 可选。

`ts
import { SM4, CipherMode, PaddingMode } from 'gmkitx';

const key = '0123456789abcdeffedcba9876543210';
const sm4 = new SM4(key, { mode: CipherMode.GCM, padding: PaddingMode.NONE });

const { ciphertext, tag } = sm4.encrypt('敏感信息', { iv: '00112233445566778899aabbccddeeff' });
const decrypted = sm4.decrypt({ ciphertext, tag, iv: '00112233445566778899aabbccddeeff' });
`

$3

- 覆盖 128-EEA3（机密性）与 128-EIA3（完整性）；流式密钥流可复用。

`ts
import { zucEncrypt, zucKeystream } from 'gmkitx';

const cipher = zucEncrypt(key, iv, 'Hello ZUC');
const keystream = zucKeystream(key, iv, 32); // 32 bytes keystream
`

$3

- SHA1/224/256/384/512 系列，API 与 SM3 一致，便于混合使用。

`ts
import { sha } from 'gmkitx';

const hash = sha.sha256('Hello World');
`

-----

🛠️ 工具箱 (Utils)

gmkitx 暴露了底层的数据处理函数，方便处理编码转换与 ASN.1 结构。

| 分类 | 函数 | 说明 |
|:-------|:---------------------------------|:-----------------|
| 编码 | hexToBytes, bytesToHex | Hex 字符串与字节数组互转 |
| 编码 | base64ToBytes, bytesToBase64 | Base64 与字节数组互转 |
| 编码 | stringToBytes, bytesToString | UTF-8 字符串处理 |
| 运算 | xor, rotl | 异或与循环左移 |
| 格式 | rawToDer, derToRaw` | 签名的 RAW/DER 格式转换 |

-----