# crossmool

**Repository Path**: iilic/crossmool

## Basic Information

- **Project Name**: crossmool
- **Description**: crossmool是一个SM2/SM3/SM4的工具集，命名取自 cross sm tool，即cross [s]m [t]ool，它的作用有2个：
1.方便用户（即应用软件开发人员）直接使用，省去了用户基于基础函数库自己进行封装的时间；
2.支持跨编程语言互通，即用A语言加密的，可以使用B语言进行解密，这在实际生产活动中是一个非常劳累的活动，需要耗费大量精力和时间（因为，各种加密算法有各种模式m
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-12-23
- **Last Updated**: 2026-10-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# crossmool

![crossmool](crossmool-logo.png)

#### 介绍
crossmool是一个SM2/SM3/SM4的工具集，命名取自 cross sm tool，即cross [s]m [t]ool，它的作用有2个：
1.方便用户（即应用软件开发人员）直接使用，省去了用户基于基础函数库自己进行封装的时间；
2.支持跨编程语言互通，即用A语言加密的，可以使用B语言进行解密，这在实际生产活动中是一个非常劳累的活动，需要耗费大量精力和时间（因为，各种加密算法有各种模式mode、编码方式encode、默认传参、格式等，只要有一点配置不一致，就无法互通）。
总之就是：拿来主义，用户拿来就傻瓜式使用，不用自己去做各种封装和选择。
The crossmool is the short name of cross-[platform]-sm-tool-[kit]. It wanna provide the common tools for cross-languages-sm-encryption.
The first plan is to support Java, Python, JavaScript, Golang, Rust, C++, C, C#.

####Milestone
20260622 finish the Java, Python, Rust, Golang compile.
20260623 finish the C compile and build.
20260701 finished the build & test for the 8 languages.

#### 安装教程

1.  C & CPP(C++) just support the MSVC right now. (Stay tuned for GCC & Clang.)
2.  CSharp(C#) support the .net8 or upper.
3.  Java supports JDK21.
4.  Golang supports 1.24.0.
5.  Python requires 3.8.0 or upper.
6.  JavaScript requires nodejs-22 or upper.
7.  Rust supports 1.95.0 or upper.

#### 使用说明
Please read the /userdoc/public_function_split_by_functions.md

非对称算法SM2：
1.统一采用X.509公钥(PublicKey)数据结构，PKCS#8私钥(PrivateKey)数据结构;
2.编码规则（序列化方法）为DER；
3.密文拼接顺序（默认）只支持C1C3C2，具体格式C1(65字节: 04 + X坐标32字节 + Y坐标32字节) + C3(32字节: SM3哈希) + C2(与明文等长)；
4.原文本内容（默认）只支持UTF8；
5.SM2的USER_ID默认值为1234567812345678；
5.输出密文支持HEX和Base64，默认HEX，建议使用HEX，除非【期望获得的密文的长度较短】即网速或存储敏感性程序，如果密文需要在URL后缀中传播建议HEX。

杂凑算法SM3：
HMAC-SM3输出原始32字节

对称算法SM4:
1.根据官方建议，分组密码的工作模式只支持GCM(Galois/Counter Mode)；
2.GCM-IV为12字节；
3.

#### 参与贡献
just accepts issues & suggestions. (It means does not accept CODE right now, because It will change the LICENSE in the future.)


#### License
LGPL-v3 
（在初期阶段，为了减少碎片化的可能性，这个软件使用了LGPL-v3协议。我们的目标是将来切换为Apache协议）
(To reduce the probability of fragmentation issues, this software will use the LGPL-v3 license in its early stages. And the goal is to switch to the Apache License in the future.)