| 参数 |
是否必填 |
说明 |
示例 |
| originJarOrWar |
是 |
指定要加密的jar/war文件
注：当使用maven插件进行自动加密时，此参数非必填，不填则自动获取。
注：当使用maven插件进行自动加密时，可结合maven相关占位符进行相对定位。如：${project.basedir}/../../your-project.jar |
originJarOrWar=/my-project.jar |
| includePrefix |
是 |
通过前缀匹配的形式定位要加密的class
注：也支持正则匹配（使用【.*】匹配所有而不用【*】）
注：多个通过逗号分割。
|
includePrefix=com
includePrefix=com,org
includePrefix=com.*.dao,org
|
| cca（依托于includePrefix） |
否 |
作为includePrefix的附加设置，设置是否清空类上的注解（写法同url后面设置参数） |
includePrefix=com?cca=true |
| cma（依托于includePrefix） |
否 |
作为includePrefix的附加设置，设置是否清空方法上的注解（写法同url后面设置参数） |
includePrefix=com?cca=true&cma=true |
| cfa（依托于includePrefix） |
否 |
作为includePrefix的附加设置，设置是否清空字段上的注解（写法同url后面设置参数） |
includePrefix=com?cca=true&cma=true&cfa=true |
| caPrefix（依托于cca、cma、cfa开关） |
否 |
作为includePrefix的附加设置，依托于cca、cma、cfa开关，清空类、方法、字段上的指定注解（写法同url后面设置参数）
注：多个通过|分割，注解请写完全路径例如：com.xx.anno.MyAnnotation
|
includePrefix=com?cca=true&cma=true&cfa=true&caPrefix=com.xx.anno.MyAnnotation|com.bb.anno.MyAnnotation |
| keepArgName（依托于includePrefix） |
否 |
作为includePrefix的附加设置，设置清空方法时，是否保留原始参数名，默认为true（写法同url后面设置参数）
注：keepArgName设置为false时，加密后方法的原始参数名信息将被擦除（不保证一定成功），反编译后查看到的将是形如var0, var1...之类的参数名（不同反编译工具的默认参数名可能不一样）
|
includePrefix=com?keepArgName=false |
| excludePrefix |
否 |
通过前缀匹配的形式排除class，不对其加密
注：也支持正则匹配（使用【.*】匹配所有而不用【*】）
注：多个通过逗号分割。
注：excludePrefix优先级高于includePrefix。
|
excludePrefix=com.example.service,com.example.util.*.class |
| includeXmlPrefix |
否 |
通过打出来的包中条目的entryName前缀匹配的形式定位要加密的xml
注：也支持正则匹配（使用【.*】匹配所有而不用【*】）
注：多个通过逗号分割。
注：如果您打出来的加密包是准备作为一个lib包提供给第三方使用的，那么请不要使用此参数，因为解密时是不会解密项目所依赖的lib包中的xml的。
|
includeXmlPrefix=BOOT-INF/classes/
includeXmlPrefix=BOOT-INF/classes/com/demo/mapper/,BOOT-INF/classes/com/*/dao/ |
| excludeXmlPrefix |
否 |
通过打出来的包中条目的entryName前缀匹配的形式排除xml，不对其加密
注：也支持正则匹配（使用【.*】匹配所有而不用【*】）
注：多个通过逗号分割。 |
excludeXmlPrefix=BOOT-INF/classes/com/demo/mapper/
excludeXmlPrefix=BOOT-INF/classes/com/demo/mapper/,BOOT-INF/classes/com/demo/*/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,c-.*.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 |
## 解密(启动)
> `class-winter`支持`JVM`参数校验，通过在JVM参数中加入`-XX:+DisableAttachMechanism`来防止其他工具连接到你的Java程序。这样可以阻止运行至dump class。
>
> 但是有些高级开发者可能会想要使用`sa-jdi` 的 `HSDB` 来 `dump` 字节码。从`2.8.8`版本开始，支持在启动Java解密时禁用了gHotSpotVMStructs函数，避免使用sa-jdi HSDB 来dump class，提高代码安全性。
- #### jar解密(启动)
```bash
# 假设your-project-encrypted.jar是由class-winter加密后的包，那么你可以这么启动
java -javaagent:/your-project-encrypted.jar -jar /your-project-encrypted.jar
# 也可以用class-winter-core-2.9.6.jar
# java -javaagent:/class-winter-core-2.9.6.jar -jar /your-project-encrypted.jar
# 或者指定参数
# java -javaagent:/your-project-encrypted.jar=debug=true,password=pwd12345 -jar /your-project-encrypted.jar
# 参数可以引起来(linux)
# java -javaagent:/your-project-encrypted.jar='debug=true,password=pwd12345' -jar /your-project-encrypted.jar
# 参数可以引起来(windows)
# java -javaagent:/your-project-encrypted.jar="debug=true,password=pwd12345" -jar /your-project-encrypted.jar
```
- #### war解密(启动)
> **以Tomcat9为例**
- linux方式一
编辑tomcat/bin/catalina.sh文件，在最上面加上
```bash
# 如果你有参数， 那么 -javaagent:/class-winter-core-2.9.6.jar=k1=v1,k2=v2
# tomcat启动往往需要通过decryptProjectPathPrefix指定要解密的路径
CATALINA_OPTS="$CATALINA_OPTS -javaagent:/class-winter-core-2.9.6.jar=debug=true,decryptProjectPathPrefix=/usr/local/xxx/";
export CATALINA_OPTS;
```
- linux方式二
在tomcat/bin目录下创建setenv.sh文件，并写上
```bash
# 如果你有参数， 那么 -javaagent:/class-winter-core-2.9.6.jar=k1=v1,k2=v2
# tomcat启动往往需要通过decryptProjectPathPrefix指定要解密的路径
JAVA_OPTS="$JAVA_OPTS -javaagent:/class-winter-core-2.9.6.jar=debug=true,decryptProjectPathPrefix=/usr/local/xxx/";
export JAVA_OPTS;
```
- windows方式一
编辑tomcat/bin/catalina.bat文件，在@echo off后加上catalina参数
```bash
rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-2.9.6.jar=k1=v1,k2=v2
rem tomcat启动往往需要通过decryptProjectPathPrefix指定要解密的路径
set CATALINA_OPTS="-javaagent:D:/class-winter-core-2.9.6.jar=decryptProjectPathPrefix=/D:/tmp/"
```
- windows方式二
在tomcat/bin目录下创建setenv.bat文件，并写上
```bash
rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-2.9.6.jar=k1=v1,k2=v2
rem tomcat启动往往需要通过decryptProjectPathPrefix指定要解密的路径
set JAVA_OPTS="-javaagent:D:/class-winter-core-2.9.6.jar=decryptProjectPathPrefix=/D:/tmp/"
```
- #### IDE解密(启动)
> 设置`-javaagent`参数指定class-winter-core或者任一加密包。有必要的话，再搭配`skipProjectPathPrefix`或者`decryptProjectPathPrefix`参数启动即可
## 解密参数
**郑重声明**
[**class-winter**](https://gitee.com/JustryDeng/class-winter) 是本人在学习完 [**class-final(v1.1.9)**](https://gitee.com/roseboy/classfinal) 后，仿照class-final进行编写的，部分思路与class-final一致
## 环境要求
- 支持jdk8（8、11、17、21等）语法环境
> **本人构建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