Skip to content

Commit 28182ae

Browse files
committed
docs: migrate documentation from wiki-latest to local
1 parent 3b7e012 commit 28182ae

46 files changed

Lines changed: 9772 additions & 271 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 64 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,105 +1,104 @@
11
# Malice Network
22

3-
blog posts:
3+
Malice Network 是 Internet of Malice(IoM)项目中的控制平面仓库,包含 `server``client``listener`。项目文档位于 `docs/` 目录。
4+
5+
## Blog Posts
46

57
- [v0.0.1 next generation C2 project](https://chainreactors.github.io/wiki/blog/2024/08/16/%E4%B8%80%E4%B8%8B%E4%BB%A3c2%E8%AE%A1%E5%88%92-----internal-of-malice/)
68
- [v0.0.2 the Real Beginning](https://chainreactors.github.io/wiki/blog/2024/09/23/IoM_v0.0.2/)
79
- [v0.0.3 RedTeam Infra&C2 framework](https://chainreactors.github.io/wiki/blog/2024/11/20/IoM_v0.0.3/)
810
- [v0.0.4 Bootstrapping](https://chainreactors.github.io/wiki/blog/2025/01/02/IoM_v0.0.4/)
9-
- [v0.1.0 代替CobaltStrike的最后四块碎片](https://chainreactors.github.io/wiki/blog/2025/04/14/IoM_v0.1.0/)
10-
11-
## Introduce
12-
13-
IoM 是一个复杂而强大的基础设施, 包含了大量组件。
14-
15-
introduce: https://wiki.chainreactors.red/IoM/
16-
17-
基本使用: https://chainreactors.github.io/wiki/IoM/quickstart/
11+
- [v0.1.0 代替 Cobalt Strike 的最后四块碎片](https://chainreactors.github.io/wiki/blog/2025/04/14/IoM_v0.1.0/)
1812

19-
VScode GUI 安装: https://wiki.chainreactors.red/IoM/guideline/deploy/#%E5%AE%89%E8%A3%85gui
13+
## Docs
2014

21-
插件编写 quickstart: https://chainreactors.github.io/wiki/IoM/manual/mal/quickstart/
15+
- 架构概览: [docs/architecture.md](docs/architecture.md)
16+
- 快速开始: [docs/getting-started.md](docs/getting-started.md)
17+
- Listener 与 Pipeline: [docs/server/listeners.md](docs/server/listeners.md)
18+
- 构建与 Profile: [docs/server/build.md](docs/server/build.md)
19+
- Client 命令总览: [docs/client/commands.md](docs/client/commands.md)
20+
- MAL 插件开发: [docs/development/mal/](docs/development/mal/)
21+
- Implant 说明: [docs/implant/overview.md](docs/implant/overview.md)
22+
- 路线图: [docs/roadmap.md](docs/roadmap.md)
23+
- 部署指南: [docs/deployment.md](docs/deployment.md)
24+
- 后渗透操作: [docs/post-exploitation.md](docs/post-exploitation.md)
2225

23-
implant 仓库: https://github.com/chainreactors/malefic
26+
## References
2427

25-
implant 基本介绍: https://chainreactors.github.io/wiki/IoM/manual/implant/
26-
27-
## Roadmap
28-
29-
https://chainreactors.github.io/wiki/IoM/roadmap/
28+
- Releases: <https://github.com/chainreactors/malice-network/releases/latest>
29+
- Implant repo: <https://github.com/chainreactors/malefic>
30+
- 自定义 Listener / LLM Bridge: [docs/custom-pipeline-guide.md](docs/custom-pipeline-guide.md)
3031

3132
## Showcases
3233

33-
### WEBUI
34+
### Web UI
35+
3436
<summary>Dashboard</summary>
35-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/WEBUI/dashboard.png"/>
37+
<img src="docs/assets/showcase/webui/dashboard.png"/>
3638

37-
<summary>sessions</summary>
38-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/WEBUI/sessions.png"/>
39+
<summary>Sessions</summary>
40+
<img src="docs/assets/showcase/webui/sessions.png"/>
3941

40-
<summary>listeners</summary>
41-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/WEBUI/listeners.png"/>
42+
<summary>Listeners</summary>
43+
<img src="docs/assets/showcase/webui/listeners.png"/>
4244

4345
<summary>Interactive</summary>
44-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/WEBUI/interactive.png"/>
46+
<img src="docs/assets/showcase/webui/interactive.png"/>
4547

46-
<summary>artifacts</summary>
47-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/WEBUI/artifacts.png"/>
48+
<summary>Artifacts</summary>
49+
<img src="docs/assets/showcase/webui/artifacts.png"/>
4850

49-
<summary>settings</summary>
50-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/WEBUI/settings.png"/>
51+
<summary>Settings</summary>
52+
<img src="docs/assets/showcase/webui/settings.png"/>
5153

54+
### VSCode GUI
5255

53-
### VScode GUI
54-
<summary>session</summary>
55-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/session_gui.jpg"/>
56+
<summary>Session</summary>
57+
<img src="docs/assets/showcase/vscode/session_gui.jpg"/>
5658

57-
<summary>pipeline</summary>
58-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/pipeline_gui.png"/>
59+
<summary>Pipeline</summary>
60+
<img src="docs/assets/showcase/vscode/pipeline_gui.png"/>
5961

60-
<summary>website</summary>
61-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/website_gui.png"/>
62+
<summary>Website</summary>
63+
<img src="docs/assets/showcase/vscode/website_gui.png"/>
6264

63-
<summary>artifact</summary>
64-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/artifact_gui.png"/>
65+
<summary>Artifact</summary>
66+
<img src="docs/assets/showcase/vscode/artifact_gui.png"/>
6567

66-
<summary>third party</summary>
67-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/third_party_gui.png"/>
68+
<summary>Third Party</summary>
69+
<img src="docs/assets/showcase/vscode/third_party_gui.png"/>
6870

69-
<summary>use session</summary>
70-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/use_session_gui.png"/>
71+
<summary>Use Session</summary>
72+
<img src="docs/assets/showcase/vscode/use_session_gui.png"/>
7173

72-
<summary>task</summary>
73-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/task_gui.png"/>
74+
<summary>Task</summary>
75+
<img src="docs/assets/showcase/vscode/task_gui.png"/>
7476

75-
<summary>netstat</summary>
76-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/netstat_gui.png"/>
77+
<summary>Netstat</summary>
78+
<img src="docs/assets/showcase/vscode/netstat_gui.png"/>
7779

78-
<summary>services</summary>
79-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/services_gui.png"/>
80-
81-
------
80+
<summary>Services</summary>
81+
<img src="docs/assets/showcase/vscode/services_gui.png"/>
8282

8383
### TUI
8484

85-
<summary>console</summary>
86-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/completion.gif"/>
87-
88-
<summary>login</summary>
89-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/login.gif"/>
85+
<summary>Console</summary>
86+
<img src="docs/assets/showcase/tui/completion.gif"/>
9087

91-
<summary>tcp</summary>
92-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/tcp.gif"/>
88+
<summary>Login</summary>
89+
<img src="docs/assets/showcase/tui/login.gif"/>
9390

94-
<summary>website</summary>
95-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/website.gif"/>
91+
<summary>TCP</summary>
92+
<img src="docs/assets/showcase/tui/tcp.gif"/>
9693

97-
<summary>execute_exe</summary>
98-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/execute_exe.gif"/>
94+
<summary>Website</summary>
95+
<img src="docs/assets/showcase/tui/website.gif"/>
9996

100-
<summary>load_addon</summary>
101-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/load_addon.gif"/>
97+
<summary>Execute EXE</summary>
98+
<img src="docs/assets/showcase/tui/execute_exe.gif"/>
10299

103-
<summary>armory</summary>
104-
<img src="https://github.com/chainreactors/wiki/blob/master/docs/IoM/assets/armory.gif"/>
100+
<summary>Load Addon</summary>
101+
<img src="docs/assets/showcase/tui/load_addon.gif"/>
105102

103+
<summary>Armory</summary>
104+
<img src="docs/assets/showcase/tui/armory.gif"/>

docs/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Malice Network 文档
2+
3+
本目录包含 Malice Network 的完整文档。
4+
5+
## 核心文档
6+
7+
- [架构概览](architecture.md) - 系统架构与组件说明
8+
- [快速开始](getting-started.md) - 安装部署与首次使用
9+
- [部署指南](deployment.md) - Server/Client 详细部署说明
10+
- [路线图](roadmap.md) - 项目方向与里程碑
11+
12+
## 使用指南
13+
14+
- [后渗透操作](post-exploitation.md) - 会话管理与后渗透命令完整手册
15+
- [Client 命令](client/commands.md) - Client 命令总览
16+
- [Listener 与 Pipeline](server/listeners.md) - Listener 配置与管理
17+
- [构建与 Profile](server/build.md) - Artifact 构建流程
18+
- [Implant 概览](implant/overview.md) - Implant 家族说明
19+
20+
## 开发文档
21+
22+
- [MAL 插件开发](development/mal/) - 完整的 MAL 插件开发文档
23+
- 快速开始、Builtin API、Beacon API、RPC API、Embed API
24+
- [自定义 Pipeline](custom-pipeline-guide.md) - 自定义 Pipeline 开发指南
25+
26+
## 高级主题
27+
28+
- [Agent Skills 提案](proposal-agent-skills.md)
29+
- [LLM C2 提案](proposal-llm-c2-zh.md)
30+
- [Agent Bridge 协议](protocol/agent-bridge.md)
31+
32+
## 测试文档
33+
34+
- [测试文档](tests/) - 测试相关文档与记录

docs/architecture.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Malice Network 架构概览
2+
3+
本文档描述 `malice-network` 当前已实现的控制平面架构。
4+
5+
`malice-network` 不是浏览器前端驱动的系统,其核心由 `CLI/TUI Client``gRPC/mTLS``Server``Listener``Implant` 组成。
6+
7+
## 相关文档
8+
9+
- 快速开始: [getting-started.md](getting-started.md)
10+
- Listener 与 Pipeline: [server/listeners.md](server/listeners.md)
11+
- 构建与 Profile: [server/build.md](server/build.md)
12+
- Client 命令总览: [client/commands.md](client/commands.md)
13+
- Implant 概览: [implant/overview.md](implant/overview.md)
14+
15+
## 组件速览
16+
17+
| 组件 | 作用 | 仓库位置 |
18+
| --- | --- | --- |
19+
| Client | CLI/TUI 操作入口,负责登录、命令派发、会话切换、插件和本地集成 | `client/` |
20+
| Server | 状态管理、任务编排、RPC 服务、审计、通知、构建控制 | `server/` |
21+
| Listener | 与 implant 建立实际通信,承载 TCP/HTTP/REM/Website/Custom 等 Pipeline | `server/listener/` |
22+
| Pipeline | Listener 下的具体传输实现,负责协议封装、解析和路由 | `server/listener/*.go` |
23+
| Implant | 目标侧执行体,当前默认是 `malefic` 家族 | 外部仓库 `chainreactors/malefic` |
24+
| Session | 单个 implant 的运行时状态、任务、缓存和连接生命周期 | `server/internal/core/` |
25+
| MAL | client 侧脚本 / 插件扩展机制,用于自动化、命令编排和集成 | `client/command/mal``client/plugin/` |
26+
27+
## 应用层架构
28+
29+
```text
30+
【操作层】【红队操作员】【自动化脚本】【MCP Client】【AI 调用方】
31+
32+
【接入层】【CLI/TUI Client】【LocalRPC】【MCP SSE】【登录认证】【上下文切换】
33+
34+
【控制层】【Cobra 命令树】【Session 管理】【Listener/Pipeline 管理】【Build/Profile/Artifact】【Plugin/MAL/Addon】
35+
36+
【接口层】【MaliceRPC】【RootRPC】【ListenerRPC】【gRPC/mTLS】【Proto/IoM-go】
37+
38+
【服务层】【RPC Handlers】【Core Runtime】【Task/Session 状态机】【Audit/Notify】【LLM Bridge】【Config/Cert】
39+
40+
【执行层】【TCP/HTTP/Bind/REM/Website Listener】【Spite/Parser】【Implant Module 调度】【Mutant/Generate】【任务落盘】
41+
42+
【资源层】【SQLite/PostgreSQL】【Context 目录】【证书资产】【嵌入式 intl/mal 资源】【external 子模块】
43+
```
44+
45+
### 应用层说明
46+
47+
- `client/` 承担接入层和控制层职责,负责命令树、交互界面、会话切换、插件调用、`MCP`/`LocalRPC` 暴露。
48+
- `server/rpc/` 是接口层入口,对外提供 `MaliceRPC``RootRPC``ListenerRPC` 三类 gRPC 服务。
49+
- `server/internal/core/` 是服务层核心,负责 `Session``Task``Pipeline`、缓存、回调和运行时编排。
50+
- `server/listener/` 属于执行层,负责 `TCP``HTTP``Bind``REM``Website` 等管线的注册与启动。
51+
- `server/internal/db/` 和上下文目录共同构成资源层,分别承载结构化状态和运行时文件资产。
52+
- `helper/intl/``helper/intermediate/``helper/cryptography/` 等为全局共享能力,贯穿控制层到执行层。
53+
54+
## 数据层架构
55+
56+
```text
57+
【数据来源层】【Operator 命令】【Implant 注册/心跳】【任务结果】【插件输出】【构建产物】【Website 内容】
58+
59+
【协议封装层】【Proto Message】【Event】【TaskContext】【Spite】【LocalRPC/MCP Payload】
60+
61+
【缓冲层】【Session Cache】【Task 回调映射】【Pipeline Channel】【gRPC Stream】【上下文缓存目录】
62+
63+
【处理层】【RPC Handler】【Core Session/Task Runtime】【Parser/Intermediate Callback】【Audit/Notify】【LLM Proxy】
64+
65+
【持久化层】【Session/Task/Pipeline/Profile/Artifact/Context/Website】【SQLite/PostgreSQL】【磁盘缓存与下载目录】
66+
67+
【访问层】【CLI/TUI 输出】【LocalRPC】【MCP Tool/Resource】【Listener 控制流】【配置与证书读取】
68+
69+
【消费层】【操作员终端】【自动化脚本】【外部集成】【AI Agent】【插件生态】
70+
```
71+
72+
### 数据层说明
73+
74+
- 操作命令、implant 回连、任务执行结果、插件输出和构建结果,都会进入统一的协议封装路径。
75+
- 协议主干以 `Proto + Spite + Event + TaskContext` 为中心,在 `gRPC``Listener Stream``LocalRPC` 之间流转。
76+
- `server/internal/core/` 在处理中承担“状态机 + 回调路由 + 任务编排”的角色,是数据流的中枢。
77+
- `server/internal/parser/``helper/intermediate/` 负责将底层返回结果转成可展示、可消费的数据。
78+
- `server/internal/db/` 存结构化对象,`server/internal/configs.ContextPath` 下的目录存缓存、下载、截图、请求、任务等文件型数据。
79+
- 最终消费方并不只是 CLI,还包括 `MCP` 客户端、自动化脚本和基于 `LocalRPC` 的外部程序集成。
80+
81+
## Mermaid 视图
82+
83+
### 应用层 Mermaid
84+
85+
```mermaid
86+
flowchart TB
87+
A[操作层<br/>Operator / Script / MCP / AI] --> B[接入层<br/>CLI/TUI Client<br/>LocalRPC / MCP SSE]
88+
B --> C[控制层<br/>Command Tree / Session / Listener / Build / Plugin]
89+
C --> D[接口层<br/>MaliceRPC / RootRPC / ListenerRPC<br/>gRPC + mTLS]
90+
D --> E[服务层<br/>RPC Handlers / Core Runtime<br/>Audit / Notify / LLM Bridge]
91+
E --> F[执行层<br/>Listener Runtime / Parser / Implant Dispatch]
92+
F --> G[资源层<br/>SQLite or PostgreSQL<br/>Context Files / Certs / Embedded Resources]
93+
```
94+
95+
### 数据层 Mermaid
96+
97+
```mermaid
98+
flowchart LR
99+
A[数据来源层<br/>Operator / Implant / Plugin / Artifact] --> B[协议封装层<br/>Proto / Spite / Event / TaskContext]
100+
B --> C[缓冲层<br/>Cache / Callback Map / Stream / Pipeline Channel]
101+
C --> D[处理层<br/>RPC / Core / Parser / Audit / Notify / LLM]
102+
D --> E[持久化层<br/>DB Models / Context Files]
103+
E --> F[访问层<br/>CLI/TUI / LocalRPC / MCP / Listener Control]
104+
F --> G[消费层<br/>Operator / Script / Integration / AI Agent]
105+
```
106+
107+
## 目录到架构层映射
108+
109+
| 目录 | 主要职责 | 对应层 |
110+
| --- | --- | --- |
111+
| `client/cmd/cli` | 客户端启动入口与命令装配 | 接入层 |
112+
| `client/command` | Cobra 命令树与交互控制 | 控制层 |
113+
| `client/core` | 客户端状态、事件处理、`LocalRPC``MCP`、AI 调用 | 接入层 / 控制层 |
114+
| `client/plugin` | 插件运行时、Lua/Yaegi 桥接 | 控制层 |
115+
| `server/rpc` | gRPC 服务注册与 RPC Handler | 接口层 / 服务层 |
116+
| `server/internal/core` | `Session``Task``Pipeline`、缓存、运行时状态机 | 服务层 |
117+
| `server/listener` | Listener 生命周期与执行管线 | 执行层 |
118+
| `server/internal/parser` | 协议解析与消息转换 | 执行层 / 数据处理层 |
119+
| `server/internal/db` | 数据模型、持久化、迁移、数据库适配 | 持久化层 / 资源层 |
120+
| `server/internal/audit` | 审计记录聚合 | 服务层 / 数据处理层 |
121+
| `server/internal/notify` | 外部通知分发 | 服务层 |
122+
| `server/internal/llm` | LLM Provider 代理桥接 | 服务层 |
123+
| `helper/intl` | 内置 `mal` 插件与资源 | 控制层 / 资源层 |
124+
| `helper/intermediate` | 任务输出回调与中间层函数 | 数据处理层 |
125+
| `helper/cryptography` | 加密与证书相关能力 | 服务层 / 资源层 |
126+
| `external/IoM-go` | Proto、gRPC stub、常量与客户端依赖 | 接口层基础设施 |
127+
128+
## 一句话总结
129+
130+
`malice-network` 的核心形态可以概括成一句话:`Client` 负责操作与编排,`Server` 负责控制与状态,`Listener/Pipeline` 负责投递与连接,`Implant` 负责执行,`DB + Context Files` 负责沉淀结果。
1.73 MB
Loading
1.9 MB
Loading
133 KB
Loading
113 KB
Loading

docs/assets/showcase/tui/login.gif

264 KB
Loading

docs/assets/showcase/tui/tcp.gif

69.6 KB
Loading
69.5 KB
Loading

0 commit comments

Comments
 (0)