Skip to content

Commit ad44bf5

Browse files
authoredOct 9, 2024
Update readme
Updated readme
1 parent cc52b3b commit ad44bf5

File tree

1 file changed

+63
-17
lines changed

1 file changed

+63
-17
lines changed
 

‎readme

+63-17
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,69 @@
1-
The set of scripts included in this package will create a lightweight technical testing environment for the performing of Vulnerability Assessments and Penetration Testing.
1+
The VAPT Toolkit Installer is designed as a lightweight, portable toolset installer, built specifically for Ubuntu 22.04. It enables quick and streamlined installation of a comprehensive suite of security tools for vulnerability assessment, penetration testing, and digital forensics. Ideal for both beginners and experienced security professionals, this toolkit allows you to set up a fully functional and portable security tool environment that can be moved and replicated across multiple systems.
22

3-
The goal of this project was to allow a portable set of tools to be installed onto an Ubuntu 20 system.
3+
Purpose
4+
This installer is intended to make it easy to deploy a broad range of security tools without requiring individual installation and configuration steps for each tool.
45

5-
Contents of the project
6-
-------------------------------------------------------------------------------------------------------------------------
7-
static.sh - Downloads static applications which are not svn capable
8-
svn.sh - SVN repository scripts to checkout and update the various tools
9-
update-tools.sh - update script for all the tools that have git/svn functionality or that I created an update script for.
10-
install.sh - The script that makes it all happen
11-
readme - You're looking at it
6+
The toolkit covers a wide spectrum of functionality, including but not limited to:
127

13-
All tools are loaded into the /vapt directory.
8+
Exploitation frameworks
9+
Web application testing tools
10+
Network scanning and enumeration tools
11+
OSINT (Open Source Intelligence) and reconnaissance tools
12+
Password cracking and fuzzing tools
13+
Forensic and auditing tools
1414

15-
How To
16-
------
17-
To start, run the installer: sudo ./install.sh
18-
Install the dependencies first via option 1) Install/Check Dependencies
19-
Once the deps scripts has completed, walk through the remaining install options. Install the svn/git and static tools and finally the wordlists.
15+
Features
16+
Portable: Simply copy the installer and deploy the entire toolset on any Ubuntu 22.04 system.
17+
Lightweight: Designed to run smoothly on Ubuntu 22.04 with minimal setup overhead.
18+
Comprehensive Toolset: Provides a robust suite of tools in various categories necessary for ethical hacking, penetration testing, and system security auditing.
19+
Easy Updates: Includes a menu option to update all installed tools to ensure that you always have the latest versions.
2020

21-
Any problems, comments or requests, feel free to contact me via email or twitter.
21+
Installation
22+
Download the Installer: Clone or download the installer to the target Ubuntu 22.04 machine.
2223

23-
- @sec0ps
24+
git clone <repository-url>
25+
cd <repository-directory>
26+
27+
Run the Installer Script:
28+
29+
python3 installer_script.py
30+
31+
Note: The script should not be run as root. It will automatically use sudo where necessary to install required packages and manage permissions.
32+
33+
Choose Installation Options: After starting the installer, you will see a menu with the following options:
34+
35+
Install Base Toolkit Dependencies: Installs essential packages required by various tools (e.g., Git, Python, etc.).
36+
Install Toolkit Packages: Installs the main toolkit components, including exploitation frameworks, web testing tools, and more.
37+
Install Wordlist Files for Password Cracking: Downloads and extracts commonly used wordlists for password cracking activities.
38+
Install OpenVAS: Installs and sets up OpenVAS, a popular vulnerability scanner.
39+
Update Toolsets: Checks each installed tool for updates and applies them as necessary.
40+
Exit: Exits the installer.
41+
42+
Tools Included
43+
The toolkit includes a wide variety of tools organized into categories:
44+
45+
Exploitation Frameworks: Metasploit, Social-Engineer Toolkit, and more.
46+
Web Testing Tools: Nikto, ZAP Proxy, Arachni, and others.
47+
Network Scanners: Nmap, DNSRecon, and SQLMap.
48+
OSINT/Intel Tools: Recon-ng, theHarvester, Spiderfoot, etc.
49+
Password Tools: John the Ripper, Hashcat, and CeWL.
50+
Forensics & Audit Tools: PowerSploit, Nessus, OpenVAS, and more.
51+
52+
Updating Tools
53+
Select the Update Toolsets option in the menu to update all installed tools. The script will:
54+
55+
Pull the latest code from each tool’s repository.
56+
Reinstall or rebuild the tools as necessary to apply updates.
57+
Update specific tools like OpenVAS and Nessus if they are installed on the system.
58+
59+
Requirements
60+
Operating System: Ubuntu 22.04
61+
Python 3: Required for running the installer script.
62+
Sudo Access: Certain installations require elevated permissions.
63+
64+
Notes
65+
The installer is designed for Ubuntu 22.04 and may not be compatible with earlier versions or other distributions.
66+
It is recommended to keep the toolkit up-to-date by periodically selecting the Update Toolsets option to ensure all tools are current.
67+
68+
License
69+
This project is released under the MIT License. See the LICENSE file for more details.

0 commit comments

Comments
 (0)
Please sign in to comment.