XJar Spring Boot JAR 安全加密運行工具

GitHub: https://github.com/core-lib/xjar

Spring Boot JAR 安全加密運行工具, 同時支持的原生JAR.

基於對JAR包內資源的加密以及拓展ClassLoader來構建的一套程序加密啓動, 動態解密運行的方案, 避免源碼泄露以及反編譯.

功能特性

無代碼侵入, 只需要把編譯好的JAR包通過工具加密即可.
完全內存解密, 降低源碼以及字節碼泄露或反編譯的風險.
支持所有JDK內置加解密算法.
可選擇需要加解密的字節碼或其他資源文件.
支持Maven插件, 加密更加便捷.
動態生成Go啓動器, 保護密碼不泄露.

使用步驟

1. 添加依賴

<project>
    <!-- 設置 jitpack.io 倉庫 -->
    <repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>
    <!-- 添加 XJar 依賴 -->
    <dependencies>
        <dependency>
            <groupId>com.github.core-lib</groupId>
            <artifactId>xjar</artifactId>
            <version>4.0.1</version>
            <!-- <scope>test</scope> -->
        </dependency>
    </dependencies>
</project>

必須添加 https://jitpack.io Maven倉庫.
如果使用 JUnit 測試類來運行加密可以將 XJar 依賴的 scope 設置爲 test.

2. 加密源碼

XCryptos.encryption()
        .from("/path/to/read/plaintext.jar")
        .use("io.xjar")
        .include("/io/xjar/**/*.class")
        .include("/mapper/**/*Mapper.xml")
        .exclude("/static/**/*")
        .exclude("/conf/*")
        .to("/path/to/save/encrypted.jar");

方法名稱	參數列表	是否必選	方法說明
from	(String jar)	二選一	指定待加密JAR包路徑
from	(File jar)	二選一	指定待加密JAR包文件
use	(String password)	二選一	指定加密密碼
use	(String algorithm, int keysize, int ivsize, String password)	二選一	指定加密算法及加密密碼
include	(String ant)	可多次調用	指定要加密的資源相對於classpath的ANT路徑表達式
include	(Pattern regex)	可多次調用	指定要加密的資源相對於classpath的正則路徑表達式
exclude	(String ant)	可多次調用	指定不加密的資源相對於classpath的ANT路徑表達式
exclude	(Pattern regex)	可多次調用	指定不加密的資源相對於classpath的正則路徑表達式
to	(String xJar)	二選一	指定加密後JAR包輸出路徑, 並執行加密.
to	(File xJar)	二選一	指定加密後JAR包輸出文件, 並執行加密.

指定加密算法的時候密鑰長度以及向量長度必須在算法可支持範圍內, 具體加密算法的密鑰及向量長度請自行百度或谷歌.
include 和 exclude 同時使用時即加密在include的範圍內且排除了exclude的資源.

3. 編譯腳本

安裝go語言環境下載地址：https://studygolang.com/dl

go build xjar.go

通過步驟2加密成功後XJar會在輸出的JAR包同目錄下生成一個名爲 xjar.go 的的Go啓動器源碼文件.
將 xjar.go 在不同的平臺進行編譯即可得到不同平臺的啓動器可執行文件, 其中Windows下文件名爲 xjar.exe 而Linux下爲 xjar.
用於編譯的機器需要安裝 Go 環境, 用於運行的機器則可不必安裝 Go 環境, 具體安裝教程請自行搜索.
由於啓動器自帶JAR包防篡改校驗, 故啓動器無法通用, 即便密碼相同也不行.

4. 啓動運行

xjar java -jar /path/to/encrypted.jar

xjar javaw -jar /path/to/encrypted.jar

nohup xjar java -jar /path/to/encrypted.jar

在 Java 啓動命令前加上編譯好的Go啓動器可執行文件名(xjar)即可啓動運行加密後的JAR包.
若使用 nohup 方式啓動則 nohup 要放在Go啓動器可執行文件名(xjar)之前.
若Go啓動器可執行文件名(xjar)不在當前命令行所在目錄則要通過絕對路徑或相對路徑指定.
僅支持通過 -jar 方式啓動, 不支持-cp或-classpath的方式.

注意事項

1. 不兼容 spring-boot-maven-plugin 的 executable = true 以及 embeddedLaunchScript

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <!-- 需要將executable和embeddedLaunchScript參數刪除, 目前還不能支持對該模式Jar的加密！後面可能會支持該方式的打包. 
    <configuration>
        <executable>true</executable>
        <embeddedLaunchScript>...</embeddedLaunchScript>
    </configuration>
    -->
</plugin>

2. Spring Boot + JPA(Hibernate) 啓動報錯問題

如果項目中使用了 JPA 且實現爲Hibernate時, 由於Hibernate自己解析加密後的Jar文件, 所以無法正常啓動, 可以採用以下解決方案:

clone XJar-Agent-Hibernate , 使用 mvn clean package 編譯出 xjar-agent-hibernate-${version}.jar 文件
採用 xjar java -javaagent:xjar-agent-hibernate-${version}.jar -jar your-spring-boot-app.jar 命令啓動

3. 靜態文件瀏覽器無法加載完成問題

由於靜態文件被加密後文件體積變大, Spring Boot 會採用文件的大小作爲 Content-Length 頭返回給瀏覽器, 但實際上通過 XJar 加載解密後文件大小恢復了原本的大小, 所以瀏覽器認爲還沒接收完導致一直等待服務端. 由此我們需要在加密時忽略靜態文件的加密, 實際上靜態文件也沒加密的必要, 因爲即便加密了用戶在瀏覽器查看源代碼也是能看到完整的源碼.通常情況下靜態文件都會放在 static/ 和 META-INF/resources/ 目錄下, 我們只需要在加密時通過 exclude 方法排除這些資源即可, 可以參考以下例子：

XCryptos.encryption()
        .from("/path/to/read/plaintext.jar")
        .use("io.xjar")
        .exclude("/static/**/*")
        .exclude("/META-INF/resources/**/*")
        .to("/path/to/save/encrypted.jar");

4. JDK-9及以上版本由於模塊化導致XJar無法使用 jdk.internal.loader 包的問題解決方案

在啓動時添加參數 --add-opens java.base/jdk.internal.loader=ALL-UNNAMED

xjar java --add-opens java.base/jdk.internal.loader=ALL-UNNAMED -jar /path/to/encrypted.jar

5. 由於使用了阿里雲Maven鏡像導致無法從 jitpack.io 下載 XJar 依賴的問題

參考如下設置, 在鏡像配置的 mirrorOf 元素中加入 ,!jitpack.io 結尾.

<mirror>
    <id>alimaven</id>
    <mirrorOf>central,!jitpack.io</mirrorOf>
    <name>aliyun maven</name>
    <url>http://maven.aliyun.com/nexus/content/repositories/central/</url>
</mirror>

插件集成

Maven項目可通過集成 xjar-maven-plugin 以免去每次加密都要執行一次上述的代碼, 隨着Maven構建自動生成加密後的JAR和Go啓動器源碼文件.

xjar-maven-plugin GitHub: https://github.com/core-lib/xjar-maven-plugin

<project>
    <!-- 設置 jitpack.io 插件倉庫 -->
    <pluginRepositories>
        <pluginRepository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </pluginRepository>
    </pluginRepositories>
    <!-- 添加 XJar Maven 插件 -->
    <build>
        <plugins>
            <plugin>
                <groupId>com.github.core-lib</groupId>
                <artifactId>xjar-maven-plugin</artifactId>
                <version>4.0.1</version>
                <executions>
                    <execution>
                        <goals>
                            <goal>build</goal>
                        </goals>
                        <phase>package</phase>
                        <!-- 或使用
                        <phase>install</phase>
                        -->
                        <configuration>
                            <password>io.xjar</password>
                            <!-- optional
                            <algorithm/>
                            <keySize/>
                            <ivSize/>
                            <includes>
                                <include/>
                            </includes>
                            <excludes>
                                <exclude/>
                            </excludes>
                            <sourceDir/>
                            <sourceJar/>
                            <targetDir/>
                            <targetJar/>
                            -->
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

對於Spring Boot 項目或模塊, 該插件要後於 spring-boot-maven-plugin 插件執行, 有兩種方式：

將插件放置於 spring-boot-maven-plugin 的後面, 因爲其插件的默認 phase 也是 package
將插件的 phase 設置爲 install（默認值爲：package）, 打包命令採用 mvn clean install

也可以通過Maven命令執行

mvn xjar:build -Dxjar.password=io.xjar
mvn xjar:build -Dxjar.password=io.xjar -Dxjar.targetDir=/directory/to/save/target.xjar

但通常情況下是讓XJar插件綁定到指定的phase中自動執行, 這樣就能在項目構建的時候自動構建出加密的包.

mvn clean package -Dxjar.password=io.xjar
mvn clean install -Dxjar.password=io.xjar -Dxjar.targetDir=/directory/to/save/target.xjar

強烈建議

強烈建議不要在 pom.xml 的 xjar-maven-plugin 配置中寫上密碼，這樣會導致打包出來的 xjar 包中的 pom.xml 文件保留着密碼，極其容易暴露密碼！強烈推薦通過 mvn 命令來指定加密密鑰！

參數說明

參數名稱	命令參數名稱	參數說明	參數類型	缺省值	示例值
password	-Dxjar.password	密碼字符串	String	必須	任意字符串, io.xjar
algorithm	-Dxjar.algorithm	加密算法名稱	String	AES/CBC/PKCS5Padding	JDK內置加密算法, 如：AES/CBC/PKCS5Padding 和 DES/CBC/PKCS5Padding
keySize	-Dxjar.keySize	密鑰長度	int	128	根據加密算法而定, 56, 128, 256
ivSize	-Dxjar.ivSize	密鑰向量長度	int	128	根據加密算法而定, 128
sourceDir	-Dxjar.sourceDir	源jar所在目錄	File	${project.build.directory}	文件目錄
sourceJar	-Dxjar.sourceJar	源jar名稱	String	${project.build.finalName}.jar	文件名稱
targetDir	-Dxjar.targetDir	目標jar存放目錄	File	${project.build.directory}	文件目錄
targetJar	-Dxjar.targetJar	目標jar名稱	String	${project.build.finalName}.xjar	文件名稱
includes	-Dxjar.includes	需要加密的資源路徑表達式	String[]	無	io/xjar/** , mapper/*Mapper.xml , 支持Ant表達式
excludes	-Dxjar.excludes	無需加密的資源路徑表達式	String[]	無	static/ , META-INF/resources/ , 支持Ant表達式

指定加密算法的時候密鑰長度以及向量長度必須在算法可支持範圍內, 具體加密算法的密鑰及向量長度請自行百度或谷歌.
當 includes 和 excludes 同時使用時即加密在includes的範圍內且排除了excludes的資源.

XJar Spring Boot JAR 安全加密運行工具

Spring Boot JAR 安全加密運行工具, 同時支持的原生JAR.

基於對JAR包內資源的加密以及拓展ClassLoader來構建的一套程序加密啓動, 動態解密運行的方案, 避免源碼泄露以及反編譯.

功能特性

使用步驟

注意事項

插件集成

強烈建議

參數說明

前端使用 Konva 實現可視化設計器（13）- 折線 - 最優路徑應用【思路篇】

centos7 mysql實現主從同步

java http獲取真實ip 防止僞造ip

centos7 openldap2.4.44安裝

SM4 js,java加解密

Maven-使用nexus搭建私服

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結