Guomi

国密算法 Elixir 实现。本库优先使用 Erlang/OTP :crypto 能力，并在运行时探测算法可用性。

支持状态

依赖

• Elixir 1.14+
• Erlang/OTP 24+
• OpenSSL 3.0+（用于更完整国密算法支持）

兼容性矩阵

| SM2 密钥/签名 | OpenSSL/Erlang 暴露 :sm2 曲线与 SM3 | 当前使用 SM3 预哈希和 OTP ECDSA 原语，签名格式为 64 字节 raw r || s | | SM2 加密/解密 | OpenSSL/Erlang 暴露 :sm2 曲线与 SM3 | 当前为 Guomi 内部 C1 || C2 || C3 格式，不声明与 OpenSSL 密文互通 |

运行时能力取决于 Erlang/OTP 编译时链接的 OpenSSL 版本和配置。生产环境应在启动或调用前使用 Guomi.supported/0 或各模块的 supported?/0 检测。

安装

从 Hex 安装

def deps do
  [
    {:guomi, "~> 0.4.2"}
  ]
end

从 GitHub 安装 (开发版)

def deps do
  [
    {:guomi, git: "https://github.com/ZeroMarker/guomi.git", branch: "main"}
  ]
end

本地开发

def deps do
  [
    {:guomi, path: "../guomi"}
  ]
end

使用

SM3 哈希

# 十六进制输出
Guomi.SM3.hash_hex("abc")
#=> "66c7f0f462eeedd9d1f2d46bdc10e4e24167c4875cf2f7a2297da02b8f4ba8e0"

# 二进制输出
Guomi.SM3.hash("abc")
#=> <<102, 199, 240, 244, 98, 238, 221, 217, ...>>

# 检查运行时支持
Guomi.SM3.supported?()
#=> true | false

SM4 加密

安全提示：ECB 模式只适合测试或兼容场景，不建议用于新数据加密。CBC 模式必须为每次加密使用不可预测且不复用的 16 字节 IV。

key = Base.decode16!("0123456789ABCDEFFEDCBA9876543210", case: :mixed)
plain = Base.decode16!("0123456789ABCDEFFEDCBA9876543210", case: :mixed)

# ECB 模式（无填充）
{:ok, cipher} = Guomi.SM4.encrypt(plain, key, padding: :none)
{:ok, back} = Guomi.SM4.decrypt(cipher, key, padding: :none)

# ECB 模式（PKCS7 填充）
{:ok, cipher} = Guomi.SM4.encrypt("Hello, Guomi!", key)
{:ok, back} = Guomi.SM4.decrypt(cipher, key)

# CBC 模式
iv = <<0::128>>
{:ok, cipher} = Guomi.SM4.encrypt_cbc("Hello, Guomi!", key, iv)
{:ok, back} = Guomi.SM4.decrypt_cbc(cipher, key, iv)

# 检查运行时支持
Guomi.SM4.supported?()
#=> true | false

SM2 签名和加密

兼容性提示：当前 SM2 签名使用 SM3 预哈希和 raw r || s 签名格式，未暴露用户 ID/ZA 参数。SM2 加密使用本库内部格式，适合 Guomi 自身加解密往返，不应假定可与 OpenSSL 或其他 SM2 实现互通。

# 生成密钥对
case Guomi.SM2.generate_keypair() do
  {:ok, private_key, public_key} ->
    # 签名
    {:ok, signature} = Guomi.SM2.sign("message", private_key)

    # 验签
    {:ok, valid?} = Guomi.SM2.verify("message", signature, public_key)
    valid?

    # 加密
    {:ok, ciphertext} = Guomi.SM2.encrypt("secret message", public_key)

    # 解密
    {:ok, plaintext} = Guomi.SM2.decrypt(ciphertext, private_key)

  {:error, :unsupported} ->
    :runtime_not_supported
end

# 检查运行时支持
Guomi.SM2.supported?()
#=> true | false

CLI 工具

Guomi 提供命令行工具，可直接执行国密算法操作。

安装

mix escript.build
./guomi version

命令

使用示例

# SM3 哈希
echo -n "hello" | guomi sm3 --hex
#=> 5897d5a782929dcdbf5e8fdb8e23d2781b5a1f5e8236e1c48e11c7b730a1e8f0

# SM4 加密，输出 hex 密文
echo "secret" | guomi sm4 --key 0123456789abcdef0123456789abcdef --hex

# SM4 解密，读取 hex 密文并输出明文
guomi sm4 --decrypt --hex --key 0123456789abcdef0123456789abcdef < ciphertext.hex

# 显式控制 SM4 hex 输入/输出
echo -n "736563726574" | guomi sm4 --input-hex --output-hex --key 0123456789abcdef0123456789abcdef

# SM2 生成密钥对
guomi sm2 --generate

# SM2 签名
echo "message" | guomi sm2 --sign --private-key <hex-key>

# SM2 验签
guomi sm2 --verify --public-key <hex-key> --signature <hex-sig> message.txt

完整文档

运行 guomi help 或 guomi <command> --help 查看更多选项。

开发

安装依赖

mix deps.get

运行测试

mix test

代码格式化

mix format

静态分析

# 运行 Credo 代码检查
mix credo

# 运行 Dialyzer 类型检查
mix dialyzer

生成文档

mix docs

许可证

MIT License. See LICENSE for details.

Changelog

See CHANGELOG.md for a detailed list of changes.

Recent Versions

0.4.2 - 2026-05-16

• Fixed Credo strict warnings in CLI, SM2, SM4, and OpenSSL compatibility tests
• Normalized source line endings for Credo consistency checks

0.4.1 - 2026-05-16

• Made SM3/SM4 tests runtime-aware when CI OpenSSL lacks Guomi algorithms
• Added friendly SM3 CLI unsupported-runtime errors

0.4.0 - 2026-05-16

• Unified Hex workflow for CI checks and release publishing
• Improved CLI validation and explicit SM4 hex input/output flags
• Added ExUnit CLI and OpenSSL compatibility tests
• Documented SM2 compatibility limits and SM4 security caveats

0.3.0 - 2026-04-05

• CLI tool with commands for SM2, SM3, and SM4 operations
• Version and help commands for CLI

0.2.0 - 2026-04-01

• SM2 encryption and decryption functionality

0.1.0 - 2026-03-28

• Initial release
• SM2/SM3/SM4 implementations

与其他库对比

注：通用 crypto 库指 :crypto、:public_key 等 OTP 内置模块

已知问题

1. SM2 运行时依赖 - 需要 OpenSSL 3.0+ 且编译时启用 SM2 曲线支持
2. Windows 兼容性 - 部分 OpenSSL 功能在 Windows 上可能受限
3. SM2 互操作性 - 当前 SM2 签名与加密 API 固定为本库支持的格式，未覆盖完整标准互通参数
4. SM2 加密性能 - 当前实现使用简化 KDF，长消息加密性能有待优化

安全注意事项

• 不要在新设计中使用 ECB 模式保护敏感数据。
• CBC 模式必须为每次加密使用新的 16 字节 IV，且同一 key 下不得复用 IV。
• SM2 支持依赖运行时 OpenSSL 能力；部署前应检测 supported?/0。
• 当前 SM2 加密格式用于 Guomi 内部往返，不应作为跨实现标准 SM2 密文格式。

FAQ

Q: 为什么 Guomi.SM2.supported?() 返回 false？

A: SM2 需要 OpenSSL 3.0+ 且在编译时启用了国密算法支持。请检查：

# 检查 OpenSSL 版本
openssl version

# 检查 Erlang 是否识别 SM2 曲线
elixir -e "IO.inspect(:crypto.supports(:curves))"

Q: 如何在生产环境使用？

A: 确保部署环境满足：

• Erlang/OTP 24+
• OpenSSL 3.0+（推荐系统级安装）
• 在运行时调用 supported?/0 检测可用性

Q: 性能如何？

A: 基于 OTP :crypto NIF 实现，性能接近原生 C 实现。参考基准（M1 Max, OTP 26）：

实际性能取决于硬件和 OpenSSL 版本

Contributing

欢迎贡献！请遵循以下步骤：

1. Fork 本仓库
2. 创建特性分支 (git checkout -b feature/amazing-feature)
3. 提交变更 (git commit -m 'Add amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 提交 Pull Request

开发要求

• 新增功能需附带测试
• 代码需通过 mix format 格式化
• 代码需通过 mix credo 检查
• 文档需同步更新

Code of Conduct

本项目采用 Contributor Covenant 行为准则。

致谢

• Erlang/OTP - 基础加密能力
• OpenSSL - 国密算法实现

相关链接

• Hex 包
• 文档
• 问题追踪

Roadmap

v0.2.0

• [ ] 添加 SM4 CTR 模式
• [ ] 增加性能基准测试
• [ ] 优化 SM2 加密 KDF 实现

v0.3.0

• [ ] 支持 SM9 算法（基于身份的加密）
• [ ] 添加密钥派生函数 (KDF)
• [ ] 支持硬件加密模块 (HSM)

未来版本

• [ ] SM1 算法支持（需硬件合作）
• [ ] 国密 SSL/TLS 支持
• [ ] 国密证书解析