Skip to content

Commit 3de3432

Browse files
committed
README changes
1 parent be48158 commit 3de3432

File tree

3 files changed

+247
-122
lines changed

3 files changed

+247
-122
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## What is ExploitFarm?
88

9-
Exploit Farm is an attack distributed platform that allows you to easly (share `in the future`) and execute exploits in a distributed way in A/D competitions.
9+
Exploit Farm is an attack distributed platform that allows you to easly share and execute exploits in a distributed way in A/D competitions.
1010
The aim of this attacker is to provide an easy way to replicate attacks and submitting flags to the competition platform, collecting as many data from attacks as possible to
1111
allow players to analyze and improve their exploits and have a clear view of the attack status, and where them could fails.
1212

@@ -99,7 +99,7 @@ NOTES:
9999
Install the client with the following command:
100100

101101
```bash
102-
pip3 install -U exploitfarm && xfarm --install-completion
102+
pip3 install -U xfarm && xfarm --install-completion
103103
```
104104

105105
On windows remember to use `python -m xfarm` instead of `xfarm`.
@@ -142,7 +142,7 @@ xfarm start
142142
This will start the TUI and replicate the attack to all the teams registered on exploitfarm server.
143143
if the TUI is heavy for your system, you can use `xfarm -I start`to start the exploit showing only the logs in the output.
144144

145-
xfarm start will by default use `cpu_count*10` thread pool to manage the attacks, and apply an execution timeout based on the time available for the attack allowing all teams to be attacked, and limit the workers to execute if the RAM goes over the 95% of use to avoid `trashing` on the system (in this case the attack timeout will decreese). If you have some problems with the ram usage, is highly recommended to `zram` on linux to compress the ram and avoid trashing.
145+
xfarm start will by default use `cpu_count*10` thread pool to manage the attacks and apply an execution timeout based on the time available for the attack allowing all teams to be attacked. For problems with the ram usage, is highly recommended to use `zram` on linux to compress the ram to avoid trashing.
146146

147147
If you write the exploit on python you can use also exploitfarm library. Is highly recommended to use `from exploitfarm import *`, this will set the print python function by default to flush=True.
148148

@@ -179,12 +179,9 @@ try_tcp_connection(
179179

180180
```
181181

182+
See advanced features of exploitfarm in the xfarm PyPi page [here](./client/README.md)
182183

183-
### Next Points/Bugs/Features:
184-
185-
XFARM CLIENT:
186-
187-
- xfarm fix close on windows
184+
All the docs you can find on [docs](docs) folder is writter for a university project at [Polytechnic of Bari](https://www.poliba.it) of [Domingo Dirutigliano](https://domy.sh) and are in italian except the plantuml generated images. That documentation was realized for the 1.0.0 release of exploitfarm where all the initial features were implemented.
188185

189186
---
190187

0 commit comments

Comments
 (0)