GMKit - 国密算法多语言工具库

GMKit 是一个 Java + TypeScript monorepo，维护 JVM 后端与前端/Node.js 侧的国密算法实现。两个语言拥有独立 API，通过共享互操作向量核对已登记的密文、签名、摘要和 MAC 协议字段；测试结论只覆盖向量和场景中明确列出的参数。

当前 0.x 版本为公开测试版，允许在 CHANGELOG 和迁移说明明确记录后调整接口；进入 1.x 后才按正式稳定版本承诺兼容窗口。

gmkit/
├── packages/
│   ├── ts/        # npm 包 gmkitx；SM2/SM3/SM4/ZUC/SHA，纯 TypeScript
│   └── java/      # Maven 多模块；主包 gmkit，SM9 独立 JNI/GmSSL 模块
├── docs/
│   ├── site/      # VuePress 全项目文档门户与可执行示例
│   └── API_STABILITY.md # 项目级 API 稳定性策略
├── apps/
│   └── gmkit-studio/  # Vue3 + Vite 工具站；V5 三栏工具工作台
├── vectors/       # Java / TypeScript 共享互操作测试向量
├── scripts/       # 本地校验与 SM9 native 构建脚本
└── .github/       # monorepo CI、发布、文档和 SM9 native 工作流

npm ci
npm run verify          # TS/Java/parity/build + npm tarball 消费；不含 lint/包体积审计/docs
npm run test:ts
npm run test:java
npm run parity
npm run build:ts
npm run docs:build
npm run studio:type-check
npm run studio:build    # 构建 GMKit Studio V5 工具站

Java 单独校验：

mvn -f packages/java/pom.xml -B -ntp test
mvn -f packages/java/pom.xml -B -ntp -Prelease "-Dgpg.skip=true" -DskipTests verify

SM9 Java native runtime 可在需要时本地构建：

./scripts/sm9-native.ps1 -Platform current -Stage -PackageRuntime -Test

普通本地验收不要求 GmSSL/JNI。gmkit-sm9 JAR 同时携带五个平台的 runtime 文件，运行时只解压和加载当前平台。正式发布由 GitHub Actions 在 Linux、macOS、Windows 矩阵中构建并强制测试同一个聚合 JAR；本地脚本仅用于维护者调试。

• ci.yml：TS 与普通 Java 测试；不强制 SM9 native。
• parity.yml：运行共享 vectors/interop.json 互操作校验。
• sm9-native.yml：在 Linux、macOS、Windows 上编译 GmSSL/JNI runtime，并强制运行当前平台的 SM9 native 测试。
• docs.yml：生成 TypeDoc/Javadoc，执行文档和多语言 fixture 门禁，并从同一 artifact 部署 HK/CN 源站、刷新 EdgeOne 和核对规范域名。
• release.yml：手动选择 Java 或 TypeScript，从源码版本自动创建对应 tag，并启动正式发布工作流。
• publish-ts.yml：发布 ts-v* 标签，通过 npm Trusted Publisher 和 GitHub OIDC 发布。
• publish-java.yml：发布 java-v* 标签，聚合五个平台 runtime、消费测试同一个 gmkit-sm9 JAR，再发布 Maven Central。

• 五分钟快速入门
• TypeScript 使用手册
• Java 使用手册
• 跨语言协议接入
• TypeScript API 说明书
• Java API 说明书
• TypeScript 包说明
• Java 包说明
• 共享向量说明
• API 稳定性策略
• VuePress 文档门户
• GMKit Studio V5 工具站

Apache License 2.0，见 LICENSE。gmkitx 内联第三方代码的版权与许可证见 packages/ts/THIRD_PARTY_NOTICES.md，该文件随 npm 包发布。