class-winter

郑重声明

  class-winter是本人在学习完class-final(v1.1.9) 后，仿照class-final进行编写的，整体思路与class-final一致，代码部分(约20%~30%)复用了class-final中的代码。可将class-winter看作是class-final的一个分支。

功能与特性

• 支持war加密。
• 支持jar(普通jar+可执行jar)加密。

加密

• 方式一：通过maven插件自动加密。

  <!--
    class-winter插件
    注:自Maven3.0.3起, 绑定到同一phase的Maven插件将按照pom.xml中声明的顺序执行
    注:此插件最好放置在同一phase的最后执行。
  -->
  <plugin>
    <groupId>com.idea-aedi</groupId>
    <artifactId>class-winter-maven-plugin</artifactId>
    <version>最新版本号</version>
    <!-- 相关配置 -->
    <configuration>
        <!-- <finalName></finalName>-->
        <includePrefix>加密范围</includePrefix>
        <!-- <excludePrefix></excludePrefix>-->
        <!-- <password></password>-->
        <!-- <includeLibs></includeLibs>-->
        <!-- <alreadyProtectedLibs></alreadyProtectedLibs>-->
        <!-- <supportFile></supportFile>-->
        <!-- <tips></tips>-->
        <!-- <debug></debug>-->
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>class-winter</goal>
            </goals>
        </execution>
    </executions>
  </plugin>
  

  注：不必担心信息泄漏问题，使用此方式生成混淆的jar包时，会擦除pom.xml中关于class-winter-plugin的信息。

• 方式二：通过class-winter-core.jar 主动加密。

  java -jar class-winter-core-${version}.jar originJarOrWar=${要加密的项目.jar或.war包} includePrefix=${加密范围} [k3=v3 k4=v4 ...]
  # 对于复杂的参数值，可以使用引号引起来
  # linux
  java -jar class-winter-core-${version}.jar k1='v1' k2='v2'
  # windows
  java -jar class-winter-core-${version}.jar k1="v1" k2="v2"
  

加密参数

参数	是否必填	说明	示例
originJarOrWar	是	指定要加密的jar/war文件 注：当使用maven插件进行自动加密时，无此参数。	originJarOrWar=/my-project.jar
includePrefix	是	通过前缀匹配的形式定位要加密的class 注：多个通过逗号分割。	includePrefix=com includePrefix=com,org
excludePrefix	否	通过前缀匹配的形式排除class，不对其加密 注：多个通过逗号分割。 注:excludePrefix优先级高于includePrefix。	excludePrefix=com.example.service,com.example.util.StrUtil.class
finalName	否	指定加密后生成的jar包名 注：若finalName与加密的包一致，那么生成的加密后的包会覆盖原来的包。	finalName=mine-project
password	否	主动指定密码 注：密码不能包含空格和逗号。	password=123456
includeLibs	否	指定将lib包也纳入加密范围内 注:多个通过逗号分割。 注：lib中的class是否会被加密，还得由includePrefix和excludePrefix决定。	includeLibs=a.jar,b.jar
alreadyProtectedLibs	否	指明项目所以来的lib中，哪些lib本身就已经是被class-winter加密了的 注：多个通过逗号分割。 注:主要用于处理第三方提供的由class-winter加密了的依赖包的场景。 注：若lib需要密码，那么需要在指定lib的同时通过冒号接上密码。 注：如果lib有密码，那么密码不能包含逗号。	alreadyProtectedLibs=a.jar,b.jar alreadyProtectedLibs=a.jar,b.jar:pwd123 alreadyProtectedLibs=a.jar:pwd1,b.jar:2
supportFile	否	指定一个加密辅助jar文件（或jar文件所在的目录） 注：当为目录时，该目录(含子孙目录)下的所有jar都会被作采集作为辅助文件。 注:主要用于解决因ClassNotFound导致的加密失败问题。	supportFile=/abc.jar supportFile=/libs
tips	否	指定提示语。 注：当直接使用加密后的jar/war时，用到了加密了的类后，会先System.err.println输出此tips,然后System.exit退出程序。	windows示例：tips="请不要直接使用混淆后的jar/war" linux示例：tips='请不要直接使用混淆后的jar/war'
debug	否	是否开启debug模式	debug=true

解密(启动)

通过-javaagent指定代理进行解密启动。

• jar解密(启动)

  # 假设your-project-encrypted.jar是由class-winter加密后的包，那么你可以这么启动
  java -javaagent:/your-project-encrypted.jar -jar /your-project-encrypted.jar
  # 也可以用class-winter-core-1.0.0.jar
  # java -javaagent:/class-winter-core-1.0.0.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文件，在最上面加上

  # 如果你有参数， 那么 -javaagent:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
  CATALINA_OPTS="$CATALINA_OPTS -javaagent:/class-winter-core-1.0.0.jar=debug=true";
  export CATALINA_OPTS;
  

  • linux方式二

  在tomcat/bin目录下创建setenv.sh文件，并写上

  # 如果你有参数， 那么 -javaagent:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
  JAVA_OPTS="$JAVA_OPTS -javaagent:/class-winter-core-1.0.0.jar=debug=true";
  export JAVA_OPTS;
  

  • windows方式一

  编辑tomcat/bin/catalina.bat文件，在@echo off后加上catalina参数

  rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
  set CATALINA_OPTS="-javaagent:D:/class-winter-core-1.0.0.jar"
  

  • windows方式二

  在tomcat/bin目录下创建setenv.bat文件，并写上

  rem 如果你有参数， 那么 -javaagent:D:/class-winter-core-1.0.0.jar=k1=v1,k2=v2
  set JAVA_OPTS="-javaagent:D:/class-winter-core-1.0.0.jar"
  

解密参数

参数	是否必填	说明	示例
password	否	指定解密密码	password=pwd123
debug	否	是否开启debug模式	debug=true