# class-winter
**Repository Path**: tts2/class-winter
## Basic Information
- **Project Name**: class-winter
- **Description**: jar/war代码加密混淆,基于javaagent
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 18
- **Forks**: 101
- **Created**: 2023-06-10
- **Last Updated**: 2025-08-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 代码混淆之class-winter
- [代码混淆之class-winter](#代码混淆之class-winter)
- [环境要求](#环境要求)
- [功能与特性](#功能与特性)
- [加密](#加密)
- [加密参数](#加密参数)
- [解密(启动)](#解密启动)
- [解密参数](#解密参数)
- [对class-winter本身进行加密](#对class-winter本身进行加密)
- [将已加密的包提供给客户使用](#将已加密的包提供给客户使用)
- [方案](#方案)
- [示例](#示例)
- [QQ群](#QQ群)
---
**郑重声明**
[**class-winter**](https://gitee.com/JustryDeng/class-winter) 是本人在学习完 [**class-final(v1.1.9)**](https://gitee.com/roseboy/classfinal) 后,仿照class-final进行编写的,部分思路与class-final一致
## 环境要求
- 支持jdk8语法的环境即可
> **本人构建class-winter时,用的jdk版本为:`1.8.0_281`**
注:tomcat版本不能低于8(部分小版本低的tomcat8可能也不行),否则可能报错
```bash
org.apache.catalina.LifecycleException: Failed to start component [StandardEngine[Catalina].StandardHost...
```
注:如果有兼容低版本jdk的需求,可以自己下载master分支代码,进行对应修改
## 功能与特性
- 支持war(普通war+可执行war)加密
- 支持jar(普通jar+可执行jar)加密
- 支持xml加密(掩耳盗铃版)
## 加密
- #### **方式一**:通过maven插件自动加密
```xml
参数 | 是否必填 | 说明 | 示例 |
originJarOrWar | 是 | 指定要加密的jar/war文件
注:当使用maven插件进行自动加密时,此参数非必填,不填则自动获取。 注:当使用maven插件进行自动加密时,可结合maven相关占位符进行相对定位。如:${project.basedir}/../../your-project.jar |
originJarOrWar=/my-project.jar |
includePrefix | 是 | 通过前缀匹配的形式定位要加密的class
注:多个通过逗号分割。 |
includePrefix=com
includePrefix=com,org |
excludePrefix | 否 | 通过前缀匹配的形式排除class,不对其加密
注:多个通过逗号分割。 注:excludePrefix优先级高于includePrefix。 |
excludePrefix=com.example.service,com.example.util.StrUtil.class |
includeXmlPrefix | 否 | 通过打出来的包中条目的entryName前缀匹配的形式定位要加密的xml
注:多个通过逗号分割。 注:如果您打出来的加密包是准备作为一个lib包提供给第三方使用的,那么请不要使用此参数,因为解密时是不会解密项目所依赖的lib包中的xml的。 |
includeXmlPrefix=BOOT-INF/classes/
includeXmlPrefix=BOOT-INF/classes/com/demo/mapper/,BOOT-INF/classes/com/demo/dao/ |
excludeXmlPrefix | 否 | 通过打出来的包中条目的entryName前缀匹配的形式排除xml,不对其加密
注:多个通过逗号分割。 |
excludeXmlPrefix=BOOT-INF/classes/com/demo/mapper/
excludeXmlPrefix=BOOT-INF/classes/com/demo/mapper/,BOOT-INF/classes/com/demo/dao/UserDao.xml |
toCleanXmlChildElementName | 否 | 加密xml中的哪些一级元素
注:默认值为resultMap,sql,insert,update,delete,select 注:多个通过逗号分割。 |
toCleanXmlChildElementName=select,delete,resultMap |
finalName | 否 | 指定加密后生成的jar包名
注:若finalName与加密的包一致,那么生成的加密后的包会覆盖原来的包。 注:支持相对路径。 比如:../../tmp/my-project 就会在相对目录../../tmp下生成加密包my-project.jar。 |
finalName=mine-project |
password | 否 | 主动指定密码
注:密码不能包含空格和逗号。 |
password=123456 |
includeLibs | 否 | 指定将lib包也纳入加密范围内
注:多个通过逗号分割。 注:lib中的class是否会被加密,还得由includePrefix和excludePrefix决定。 |
includeLibs=a.jar,b.jar |
alreadyProtectedRootDir | 否 | 指明已加密lib包所在根目录(,可为空,为空时自动根据当前是jar还是war,去包内对应找lib)
注:当指定此参数时,也会优先去jar/war内部找对应的lib包,找不到时,才会去此参数指定的根目录下找lib包。 注:在一些外置lib的项目中,可能需要用到此参数;如果是内置lib,忽略此参数即可。 注:此参数由2.7.0版本开始支持 |
alreadyProtectedRootDir=/lib |
alreadyProtectedLibs | 否 | 指明项目所依赖的lib中,哪些lib本身就已经是被class-winter加密了的
注:多个通过逗号分割。 注:主要用于处理第三方提供的由class-winter加密了的依赖包的场景。 注:若lib需要密码,那么需要在指定lib的同时通过冒号接上密码。 注:如果lib有密码,那么密码不能包含逗号。 |
alreadyProtectedLibs=a.jar,b-1.0.0.jar
alreadyProtectedLibs=a.jar,b-1.0.0.jar:pwd123 alreadyProtectedLibs=a.jar:pwd1,b-1.0.0.jar:pwd2 |
supportFile | 否 | 指定一个加密辅助jar文件(或jar文件所在的目录)
注:当为目录时,该目录(含子孙目录)下的所有jar都会被采集作为辅助文件。 注:主要用于解决因ClassNotFound导致的加密失败问题。 |
supportFile=/abc.jar
supportFile=/libs |
jvmArgCheck | 否 | 设置当启动混淆包时,必须要有的jvm参数
注:多个通过逗号分割。 注:大小写不敏感。 如:通过设置-XX:+DisableAttachMechanism防止运行时dump class,以提高安全性。 |
jvmArgCheck=-XX:+DisableAttachMechanism,-Xms2048M |
tips | 否 | 指定提示语。
注:当直接使用加密后的jar/war时,用到了加密了的类后,会先System.err.println输出此tips,然后System.exit退出程序。 |
windows示例:tips="请不要直接使用混淆后的jar/war"
linux示例:tips='请不要直接使用混淆后的jar/war' |
debug | 否 | 是否开启debug模式 | debug=true |
参数 | 是否必填 | 说明 | 示例 |
password | 否 | 指定解密密码 | password=pwd123 |
passwordFromFile | 否 | 从指定文件中读取文本作为解密密码 注:此参数由2.4.0版本开始支持 |
passwordFromFile=/my-pwd-file.txt |
passwordFromShell | 否 | 执行shell文件中的代码,并以其返回值作为解密密码 注:此参数由2.4.0版本开始支持 |
passwordFromShell=/my-pwd-file.shell |
skipProjectPathPrefix | 否 | 是否跳过指定前缀的项目路径(当class-winter解密逻辑试图解析那些进入premain但是非class-winter加密项目时,会因为获取印章失败Obtain project seal fail而停止,此时如果确认这个项目没有加密文件的话,可以使用此参数跳过) 注:值中的路径分隔符请统一使用/ 注:不知道此值怎么填的,可以把debug代开, 观察日志 Exist projectPath -> xxx 或输出所有的projectPath 注:此参数由2.6.4版本开始支持 |
skipProjectPathPrefix=/D:/apache-tomcat-9.0.71/bin/
多个通过___符号拼接:skipProjectPathPrefix=/D:/apache-tomcat-9.0.71/bin/___/D:/jd/classpath/lib/ |
decryptProjectPathPrefix | 否 | 是否仅解密指定前缀的项目路径(优先级低于skipProjectPathPrefix) 注:值中的路径分隔符请统一使用/ 注:不知道此值怎么填的,可以把debug代开, 观察日志 Exist projectPath -> xxx 或输出所有的projectPath 注:此参数由2.6.6版本开始支持 |
decryptProjectPathPrefix=/D:/apache-tomcat-9.0.71/bin/
多个通过___符号拼接:decryptProjectPathPrefix=/D:/apache-tomcat-9.0.71/bin/___/D:/jd/classpath/lib/ |
debug | 否 | 是否开启debug模式 | debug=true |