Skip to content

Commit 4611dc6

Browse files
committed
docs: update README
1 parent b6c7d45 commit 4611dc6

File tree

5 files changed

+320
-321
lines changed

5 files changed

+320
-321
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
1+
## Contribute
2+
3+
> 你的任何反馈以及 issue 交流都是对当前项目的贡献
4+
5+
> It will be so nice if you want to contribute. 🎉
6+
7+
1. 如果你有高超的 Docker 环境构建技术,可以尝试添加 CVE 相关的集成测试用例。
8+
2. 如果你有高超的内存马编写技术,可以尝试添加一个内存马试试。
9+
3. 如果你有丰富的实战经验,可以尝试写写 issue 来提提建议。
10+
111
### 目录结构
212

3-
- bom: 依赖版本管理,不用写到处写版本号就是舒服
413
- boot:使用 SpringBoot 为 UI 提供生成服务
5-
- common:bytebuddy 等工具类存放
14+
- memshell-party-common:bytebuddy/asm 等工具类存放
615
- generator:内存马生成核心
7-
- deserialize:反序列化相关 gadget
16+
- packer:常见漏洞 payload 生成
817
- integration-test:集成测试用例
9-
- memshell:内存功能类以及注入器(为保证兼容性够高,所以单独弄出来)
10-
- memshell-java8:Spring 相关的存在 lambda 表达式所以单独弄出来
11-
- tools/behinder:冰蝎简易连接器
12-
- tools/godzilla:哥斯拉简易连接器
13-
- tools/suo5:Suo5 简易连接器
18+
- memshell:内存功能类以及注入器
19+
- memshell-agent:Agent 内存马 playground,可参考 asm/javassist/bytebuddy 编写 Agent 内存马
20+
- tools/*:内存马简易连接器,用于测试内存马注入之后是否可用
1421
- web:使用 react 开发的 Web UI
1522
- vul/vul-webapp:简易的 javax.servlet 靶场
1623
- vul/vul-webapp-expression:简易的表达式注入、SSTI 注入相关靶场
24+
- vul/vul-webapp-deserialize:简易的反序列化相关靶场
1725
- vul/vul-webapp-jakarta:简易的 jakarta.servlet 靶场
1826
- vul/springboot*: springboot 相关靶场
1927

@@ -28,12 +36,15 @@
2836
# 运行集成测试用例,谨慎运行,用例太多了
2937
./gradlew :integration-test:test --info
3038

31-
# 仅运行 tomcat 下的集成测试用例
39+
# 仅运行 tomcat 下的集成测试用例(需要先构建靶场)
40+
./gradlew :vul:vul-webapp:war :vul:vul-webapp-expression:war :vul:vul-webapp-deserialize:war :vul:vul-webapp-jakarta:war
3241
./gradlew :integration-test:test --tests '*.tomcat.*'
33-
# 仅运行 jetty 下的集成测试用例
42+
43+
# 仅运行 jetty 下的集成测试用例(需要先构建靶场)
44+
./gradlew :vul:vul-webapp:war :vul:vul-webapp-jakarta:war
3445
./gradlew :integration-test:test --tests '*.jetty.*'
3546

36-
# 构建 war 包
47+
# 构建靶场 war 包
3748
./gradlew :vul:vul-webapp:war
3849
./gradlew :vul:vul-webapp-jakarta:war
3950
./gradlew :vul:vul-webapp-expression:war
@@ -57,7 +68,7 @@ UI 采用的 React SPA + SpringBoot,构建时需要先将 React 前端项目
5768

5869
### Contribute Code
5970

60-
> 参考 GitHub Docs, https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project
71+
> 参考 GitHub Docs,https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project
6172
6273
1. fork 当前项目
6374
2. git clone 自己 fork 后的项目

0 commit comments

Comments
 (0)