Skip to content

Commit dd1224a

Browse files
committed
readme file modifications
1 parent 336bcdf commit dd1224a

File tree

1 file changed

+138
-63
lines changed

1 file changed

+138
-63
lines changed

README.md

Lines changed: 138 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,60 @@
2626

2727
Docker for pentest is an image with the more used tools to create an pentest environment easily and quickly.
2828

29+
### Table of Contents
30+
31+
- [Features](#features)
32+
- [Tools installed](#tools-installed)
33+
- [Operative system tools](#operative-system-tools)
34+
- [Network tools](#network-tools)
35+
- [Developer tools](#developer-tools)
36+
- [:hocho: Pentest tools](#hocho-pentest-tools)
37+
- [Port scanning](#port-scanning)
38+
- [:mag: Recon](#mag-recon)
39+
- [Subdomains](#subdomains)
40+
- [Subdomain takeover](#subdomain-takeover)
41+
- [DNS Lookups](#dns-lookups)
42+
- [:camera: Screenshot](#camera-screenshot)
43+
- [:spider_web: Crawler](#spider_web-crawler)
44+
- [:file_folder: Search directories](#file_folder-search-directories)
45+
- [Fuzzer](#fuzzer)
46+
- [Web Scanning](#web-scanning)
47+
- [CMS](#cms)
48+
- [Search JS](#search-js)
49+
- [Wordlist](#wordlist)
50+
- [Git repositories](#git-repositories)
51+
- [OWASP](#owasp)
52+
- [:iphone: Mobile](#iphone-mobile)
53+
- [Brute force](#brute-force)
54+
- [Cracking](#cracking)
55+
- [OS Enumeration](#os-enumeration)
56+
- [Exploits](#exploits)
57+
- [Windows](#windows)
58+
- [Reverse shell](#reverse-shell)
59+
- [Other resources](#other-resources)
60+
- [Custom functions](#custom-functions)
61+
- [Other services](#other-services)
62+
- [:memo: Documentation](#memo-documentation)
63+
- [:hammer_and_wrench: Usage](#hammer_and_wrench-usage)
64+
- [Prerequisites](#prerequisites)
65+
- [Option 1 - Use the github repository](#option-1---use-the-github-repository)
66+
- [Option 2 - Use the image from docker hub](#option-2---use-the-image-from-docker-hub)
67+
- [Considerations to run the container](#considerations-to-run-the-container)
68+
- [:gear: Nice configurations](#gear-nice-configurations)
69+
- [1. Configure credentials in the docker](#1-configure-credentials-in-the-docker)
70+
- [2. Alias to connect to HTB (Hack the Box) VPN](#2-alias-to-connect-to-htb-hack-the-box-vpn)
71+
- [Option 1 - HTB VPN using github repository](#option-1---htb-vpn-using-github-repository)
72+
- [Option 2 - HTB VPN using docker hub image](#option-2---htb-vpn-using-docker-hub-image)
73+
- [3. Save and load command history in your local environment](#3-save-and-load-command-history-in-your-local-environment)
74+
- [Option 1 - Command history using github repository](#option-1---command-history-using-github-repository)
75+
- [Option 2 - Command history using docker hub image](#option-2---command-history-using-docker-hub-image)
76+
- [:white_check_mark: Environment tested](#white_check_mark-environment-tested)
77+
- [:warning: Warning](#warning-warning)
78+
- [:coffee: Donations](#coffee-donations)
79+
- [Contributing](#contributing)
80+
- [:chart_with_upwards_trend: Stargazers over time](#chart_with_upwards_trend-stargazers-over-time)
81+
- [License](#license)
82+
2983
## Features
3084

3185
- OS, networking, developing and pentesting tools installed.
@@ -82,67 +136,86 @@ Docker for pentest is an image with the more used tools to create an pentest env
82136
- [tojson](https://github.com/tomnomnom/hacks/tree/master/tojson)
83137
- nodejs
84138

85-
### 🔪 Pentest tools
139+
### :hocho: Pentest tools
86140

87141
#### Port scanning
88142

89143
- [nmap](https://github.com/nmap/nmap)
90144
- [masscan](https://github.com/robertdavidgraham/masscan)
91145
- [ScanPorts](https://github.com/aaaguirrep/scanPorts) created by [@s4vitar](https://github.com/s4vitar) with some improvements
92146

93-
#### 🔍 Recon
94-
95-
- **Subdomains**
96-
- [Amass](https://github.com/OWASP/Amass)
97-
- [GoBuster](https://github.com/OJ/gobuster)
98-
- [Knock](https://github.com/guelfoweb/knock)
99-
- [MassDNS](https://github.com/blechschmidt/massdns)
100-
- [Altdns](https://github.com/infosec-au/altdns)
101-
- [spyse](https://github.com/zeropwn/spyse.py)
102-
- [Sublist3r](https://github.com/aboul3la/Sublist3r)
103-
- [findomain](https://github.com/Edu4rdSHL/findomain)
104-
- [subfinder](https://github.com/projectdiscovery/subfinder)
105-
- [spiderfoot](https://github.com/smicallef/spiderfoot)
106-
- [haktldextract](https://github.com/hakluke/haktldextract)
107-
- **Subdomain takeover**
108-
- [subjack](https://github.com/haccer/subjack)
109-
- [SubOver](https://github.com/Ice3man543/SubOver)
110-
- [tko-subs](https://github.com/anshumanbh/tko-subs)
111-
- **DNS Lookups**
112-
- [hakrevdns](https://github.com/hakluke/hakrevdns)
113-
- 📷 **Screenshot**
114-
- [gowitness](https://github.com/sensepost/gowitness)
115-
- [aquatone](https://github.com/michenriksen/aquatone)
116-
- 🕸️ **Crawler**
117-
- [hakrawler](https://github.com/hakluke/hakrawler)
118-
- [Photon](https://github.com/s0md3v/Photon)
119-
- [gospider](https://github.com/jaeles-project/gospider)
120-
- [gau](https://github.com/lc/gau)
121-
- [otxurls](https://github.com/lc/otxurls)
122-
- [waybackurls](https://github.com/tomnomnom/waybackurls)
123-
- 📁 **Search directories**
124-
- [dirsearch](https://github.com/maurosoria/dirsearch)
125-
- **Fuzzer**
126-
- [wfuzz](https://github.com/xmendez/wfuzz)
127-
- [ffuf](https://github.com/ffuf/ffuf)
128-
- **Web Scanning**
129-
- [whatweb](https://github.com/urbanadventurer/WhatWeb)
130-
- [wafw00z](https://github.com/EnableSecurity/wafw00f)
131-
- [nikto](https://github.com/sullo/nikto)
132-
- [arjun](https://github.com/s0md3v/Arjun)
133-
- [httprobe](https://github.com/tomnomnom/httprobe)
134-
- [striker](https://github.com/s0md3v/Striker)
135-
- [hakcheckurl](https://github.com/hakluke/hakcheckurl)
136-
- [httpx](https://github.com/projectdiscovery/httpx)
137-
- **CMS**
138-
- [wpscan](https://github.com/wpscanteam/wpscan)
139-
- [joomscan](https://github.com/rezasp/joomscan)
140-
- [droopescan](https://github.com/droope/droopescan)
141-
- [cmseek](https://github.com/Tuhinshubhra/CMSeeK)
142-
- **Search JS**
143-
- [LinkFinder](https://github.com/GerbenJavado/LinkFinder)
144-
- [getJS](https://github.com/003random/getJS)
145-
- [subjs](https://github.com/lc/subjs)
147+
#### :mag: Recon
148+
149+
##### Subdomains
150+
151+
- [Amass](https://github.com/OWASP/Amass)
152+
- [GoBuster](https://github.com/OJ/gobuster)
153+
- [Knock](https://github.com/guelfoweb/knock)
154+
- [MassDNS](https://github.com/blechschmidt/massdns)
155+
- [Altdns](https://github.com/infosec-au/altdns)
156+
- [spyse](https://github.com/zeropwn/spyse.py)
157+
- [Sublist3r](https://github.com/aboul3la/Sublist3r)
158+
- [findomain](https://github.com/Edu4rdSHL/findomain)
159+
- [subfinder](https://github.com/projectdiscovery/subfinder)
160+
- [spiderfoot](https://github.com/smicallef/spiderfoot)
161+
- [haktldextract](https://github.com/hakluke/haktldextract)
162+
163+
##### Subdomain takeover
164+
165+
- [subjack](https://github.com/haccer/subjack)
166+
- [SubOver](https://github.com/Ice3man543/SubOver)
167+
- [tko-subs](https://github.com/anshumanbh/tko-subs)
168+
169+
##### DNS Lookups
170+
171+
- [hakrevdns](https://github.com/hakluke/hakrevdns)
172+
173+
##### :camera: Screenshot
174+
175+
- [gowitness](https://github.com/sensepost/gowitness)
176+
- [aquatone](https://github.com/michenriksen/aquatone)
177+
178+
##### :spider_web: Crawler
179+
180+
- [hakrawler](https://github.com/hakluke/hakrawler)
181+
- [Photon](https://github.com/s0md3v/Photon)
182+
- [gospider](https://github.com/jaeles-project/gospider)
183+
- [gau](https://github.com/lc/gau)
184+
- [otxurls](https://github.com/lc/otxurls)
185+
- [waybackurls](https://github.com/tomnomnom/waybackurls)
186+
187+
##### :file_folder: Search directories
188+
189+
- [dirsearch](https://github.com/maurosoria/dirsearch)
190+
191+
##### Fuzzer
192+
193+
- [wfuzz](https://github.com/xmendez/wfuzz)
194+
- [ffuf](https://github.com/ffuf/ffuf)
195+
196+
##### Web Scanning
197+
198+
- [whatweb](https://github.com/urbanadventurer/WhatWeb)
199+
- [wafw00z](https://github.com/EnableSecurity/wafw00f)
200+
- [nikto](https://github.com/sullo/nikto)
201+
- [arjun](https://github.com/s0md3v/Arjun)
202+
- [httprobe](https://github.com/tomnomnom/httprobe)
203+
- [striker](https://github.com/s0md3v/Striker)
204+
- [hakcheckurl](https://github.com/hakluke/hakcheckurl)
205+
- [httpx](https://github.com/projectdiscovery/httpx)
206+
207+
##### CMS
208+
209+
- [wpscan](https://github.com/wpscanteam/wpscan)
210+
- [joomscan](https://github.com/rezasp/joomscan)
211+
- [droopescan](https://github.com/droope/droopescan)
212+
- [cmseek](https://github.com/Tuhinshubhra/CMSeeK)
213+
214+
##### Search JS
215+
216+
- [LinkFinder](https://github.com/GerbenJavado/LinkFinder)
217+
- [getJS](https://github.com/003random/getJS)
218+
- [subjs](https://github.com/lc/subjs)
146219

147220
#### Wordlist
148221

@@ -173,7 +246,7 @@ Docker for pentest is an image with the more used tools to create an pentest env
173246
- [dalfox](https://github.com/hahwul/dalfox)
174247
- [jwt_tool](https://github.com/ticarpi/jwt_tool)
175248

176-
#### 📱 Mobile
249+
#### :iphone: Mobile
177250

178251
- [apktool](https://ibotpeaches.github.io/Apktool/)
179252

@@ -243,11 +316,11 @@ Docker for pentest is an image with the more used tools to create an pentest env
243316
- apache2
244317
- squid
245318

246-
## 📝 Documentation
319+
## :memo: Documentation
247320

248321
See the project's [wiki](https://github.com/aaaguirrep/pentest/wiki) for documentation.
249322

250-
## 🛠️ Usage
323+
## :hammer_and_wrench: Usage
251324

252325
### Prerequisites
253326

@@ -296,7 +369,7 @@ There are differents use cases for use the image and you should know how to run
296369

297370
5. Tools are downloaded in /tools directory.
298371

299-
## ⚙️ Nice configurations
372+
## :gear: Nice configurations
300373

301374
You can set up the docker image with nice configurations like as:
302375

@@ -345,15 +418,17 @@ Create a new Dockerfile with the next steps, build a new image and run a new con
345418
# Save and load command history in your local environment
346419
RUN sed -i '1i export HISTFILE="/pentest/.zsh_history"' /root/.zshrc
347420

348-
## Environment tested
421+
## :white_check_mark: Environment tested
349422

350423
The image was tested in the following environments:
351424

352425
- Docker service for Mac: Docker version 19.03.5, build 633a0ea
353426

354427
- Docker service for Linux instance on Google Cloud Platform: Docker version 19.03.6, build 369ce74a3c
355428

356-
## ⚠️ Warning
429+
- Docker service for Linux droplet on Digital Ocean: Docker version 19.03.6, build 369ce74a3c
430+
431+
## :warning: Warning
357432

358433
- Do not save information on container directories because it will be lost after delete the container, you should save information in your local environment using the parameter -v when you run the container. For instance:
359434

@@ -363,19 +438,19 @@ The image was tested in the following environments:
363438

364439
- Use hashcat and john the ripper on controlled environments as CTF. You can experiment issues.
365440

366-
## Donations
441+
## :coffee: Donations
367442

368443
Thanks for your donations, are always appreciated.
369444

370445
While I drink the coffee I check more tools to add in the docker image.
371446

372-
<a href="https://www.buymeacoffee.com/aaaguirrep" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" style="height: 40px !important; width: 174px !important;" ></a>
447+
<a href="https://www.buymeacoffee.com/aaaguirrep" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" style="height: 23px !important; width: 100px !important;" ></a>
373448

374449
## Contributing
375450

376451
[Contributing Guide](CONTRIBUTING.md)
377452

378-
## Stargazers over time
453+
## :chart_with_upwards_trend: Stargazers over time
379454

380455
[![Stargazers over time](https://starchart.cc/aaaguirrep/pentest.svg)](https://starchart.cc/aaaguirrep/pentest)
381456

0 commit comments

Comments
 (0)