english doc

Author: 4ra1n

CHANGELOG.MD

@@ -36,4 +36,5 @@ GUI 版本的使用和 CLI 版本基本一致，具体参考 README 文件
 
 ## 0.3
 
-todo
+更新日志：
+- 加入了英文版本文档

README.md

@@ -5,6 +5,8 @@
 
 ## 介绍
 
+[English Doc](doc/README.md)
+
 使用`JNI`加密字节码，通过`JVMTI`解密字节码以保护代码
 
 提供两份`DLL`文件，一份加密一份解密，实际运行只需使用解密`DLL`文件，支持自定义密钥和包名
@@ -17,34 +19,6 @@
 
 ![hex](img/003.png)
 
-## 更新日志
-
-### 0.2
-
-更新日志：
-- 基于`gcc`和`nasm`支持`linux x86_64 (amd64)`
-- 支持`Windows`和`Linux`任意密钥加密解密
-- 使用`execstack`为`so`库修改堆栈可执行属性
-- 汇编中部分寄存器忘记恢复状态导致某些`JVM`崩溃
-- 修复`linux`中字符串处理函数的缓冲区溢出问题
-- 修改`README`部分应该使用`-agentpath`启动
-- 优化重构`Java`层代码，抽出工具类等
-- 避免重复宏定义的问题
-
-## 特点
-
-本项目相比于网上公开的文章/代码，优势和特点有以下几条：
-- 原文章固定了包名，用户想加密自己的包名需要重新编译`DLL`
-- 原文章加密和解密`DLL`是同一个，这样只用`JNI`调用下加密即可破解
-- 原文章的代码仅是`Demo`级别，无法直接上手测试和使用
-- 原文章没有加入具体的加密算法，仅是简单的运算，需要加强
-- 原文章的代码存在一些`BUG`和优化空间
-
-目前的加密解密算法：
-- 汇编实现的多层位运算，交换字节等
-- 三次`XXTEA`算法，抽取`10-34`位字节
-- 支持自定义密钥
-
 ## 快速开始
 
 加密解密部分使用`C`做一层加密，使用`汇编`二层加密，已提供编译好的`Release`版本`DLL/SO`文件嵌入`Jar`包中
@@ -81,6 +55,20 @@ java -agentpath:D:\abs-path\decrypter.dll=PACKAGE_NAME=com.your.pack,KEY=your-ke
 
 ![screenshot](img/001.png)
 
+## 特点
+
+本项目相比于网上公开的文章/代码，优势和特点有以下几条：
+- 原文章固定了包名，用户想加密自己的包名需要重新编译`DLL`
+- 原文章加密和解密`DLL`是同一个，这样只用`JNI`调用下加密即可破解
+- 原文章的代码仅是`Demo`级别，无法直接上手测试和使用
+- 原文章没有加入具体的加密算法，仅是简单的运算，需要加强
+- 原文章的代码存在一些`BUG`和优化空间
+
+目前的加密解密算法：
+- 汇编实现的多次位运算，交换字节等
+- 基于`XXTEA`算法，多轮加密
+- 支持自定义密钥，进一步保护
+
 ## 构建
 
 编译环境：

doc/README.md

@@ -0,0 +1,99 @@
+# code-encryptor-plus
+
+[![](https://img.shields.io/github/v/release/Y4Sec-Team/code-encryptor-plus)](https://github.com/Y4Sec-Team/code-encryptor-plus/releases/latest)
+![](https://img.shields.io/github/downloads/Y4Sec-Team/code-encryptor-plus/total)
+
+## Introduce
+
+This project uses `JNI` to encrypt bytecode and `JVMTI` to decrypt bytecode in order to protect code.
+
+It provides two `DLL` files: one for encryption and one for decryption. During actual execution, only the decryption `DLL` file is used. It supports custom keys and package names.
+
+The encrypted `Class` files become malformed and cannot be parsed.
+
+![jd-gui](../img/002.png)
+
+Apart from retaining the `Magic` part at the beginning, the rest becomes unrecognizable bytes.
+
+![hex](../img/003.png)
+
+## Quick Start
+
+The encryption and decryption process involves two layers of encryption: the first layer in `C` and the second layer in `assembly`. Precompiled `Release` versions of `DLL/SO` files are included in the `Jar` package.
+
+Built-in support is for `JDK-8`, but other versions of `JDK` only require replacing the `JNI.h` header file and recompiling. The new version also supports both `Windows` and `Linux`.
+
+To encrypt your `Jar` package (specify the `Jar` package, the package name to encrypt, and the encryption key):
+
+```shell
+java -jar code-encryptor-plus.jar patch --jar your-jar.jar --package com.your.pack --key your-key
+```
+
+![](../img/004.png)
+
+When exporting the decryption `DLL/SO` files, they will be placed in the default export directory, which is `code-encryptor-plus-temp`. It is not recommended to modify this directory.
+
+```shell
+java -jar code-encryptor-plus.jar export
+```
+
+![](../img/005.png)
+
+Launching the Jar Package with Decryption DLL/SO: (Using the `-agentpath` Parameter)
+
+Please note that you must provide two parameters: `PACKAGE_NAME` and `KEY`.
+```shell
+java -agentpath:D:\abs-path\decrypter.dll=PACKAGE_NAME=com.your.pack,KEY=your-key --jar your-jar.jar
+```
+
+![](../img/006.png)
+
+We also offer a straightforward GUI version that allows you to encrypt your chosen `Jar` file with a single click. (Available for Windows only)
+
+![screenshot](../img/001.png)
+
+## Features
+
+Compared to publicly available articles/code online, this project has several advantages and features:
+
+- The original article had a fixed package name, and users who want to encrypt their own package names need to recompile the `DLL`.
+- The original article used the same encryption and decryption `DLL`, making it easier to crack by simply calling encryption using `JNI`.
+- The original article's code was only at a demo level, making it difficult for users to test and use directly.
+- The original article did not include specific encryption algorithms; it only involved simple operations and needed enhancement.
+- The original article's code had some bugs and room for optimization.
+
+The current encryption and decryption algorithm includes:
+
+- Multiple bitwise operations implemented in assembly, byte swapping, and more.
+- Based on the `XXTEA` algorithm with multiple rounds of encryption.
+- Supports custom keys for further protection.
+
+## Building
+
+Compilation Environment:
+- Windows 11 / Ubuntu 22.04
+- JDK 8 / Maven
+- MSVC + ml64 (Windows) / gcc + nasm (Linux)
+- CMake 3.x
+- Python 3.x
+
+The `native` directory is built using `cmake`, generating `dll` and `so` files that are then moved to the `resources` directory for Maven to build.
+
+## Notes
+
+This solution is not suitable for `SpringBoot` scenarios due to two issues:
+- `SpringBoot` does not allow the compression of `lib` dependencies (there are workarounds).
+- `SpringBoot` startup scanning will analyze `class` files, leading to errors when encrypted.
+
+Two solutions are available online, which you can refer to:
+
+Reference: https://zhuanlan.zhihu.com/p/545268749
+
+Similarly, this encryption method cannot be used with code that scans `class` files during startup.
+
+## References
+
+Thanks to the following projects or articles for providing insights:
+- https://juejin.cn/post/6844903487784894477
+- https://github.com/sea-boat/ByteCodeEncrypt
+