Skip to content

Commit c85ebc1

Browse files
NullArrayNullArray
authored
Update README.md
1 parent 7d3af30 commit c85ebc1

File tree

1 file changed

+64
-21
lines changed

1 file changed

+64
-21
lines changed

‎README.md

Lines changed: 64 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,85 @@
11
# AutoSploit
22

3-
As the name might suggest AutoSploit attempts to automate the exploitation of remote hosts. Targets are collected automatically as well by employing the Shodan.io API. The program allows the user to enter their platform specific search query such as; `Apache`, `IIS`, etc, upon which a list of candidates will be retrieved.
4-
5-
After this operation has been completed the 'Exploit' component of the program will go about the business of attempting to exploit these targets by running a series of Metasploit modules against them. Which Metasploit modules will be employed in this manner is determined by programmatically comparing the name of the module to the initial search query. However, I have added functionality to run all available modules against the targets in a 'Hail Mary' type of attack as well.
6-
7-
The available Metasploit modules have been selected to facilitate Remote Code Execution and to attempt to gain Reverse TCP Shells and/or Meterpreter sessions. Workspace, local host and local port for MSF facilitated back connections are configured through the dialog that comes up before the 'Exploit' component is started.
3+
As the name might suggest AutoSploit attempts to automate the exploitation of remote hosts. Targets can be collected automatically through Shodan, Censys or Zoomeye. But options to add your custom targets and host lists have been included as well.
4+
The available Metasploit modules have been selected to facilitate Remote Code Execution and to attempt to gain Reverse TCP Shells and/or Meterpreter sessions. Workspace, local host and local port for MSF facilitated back connections are configured by filling out the dialog that comes up before the exploit component is started
85

96
**Operational Security Consideration**
107

118
Receiving back connections on your local machine might not be the best idea from an OPSEC standpoint. Instead consider running this tool from a VPS that has all the dependencies required, available.
129

10+
The new version of AutoSploit has a feature that allows you to set a proxy before you connect and a custom user-agent.
11+
1312
## Usage
1413

1514
Clone the repo. Or deploy via Docker. Details for which can be found [here](https://github.com/NullArray/AutoSploit/tree/master/Docker) Special thanks to [Khast3x](https://github.com/khast3x) for their contribution in this regard.
1615

1716
`git clone https://github.com/NullArray/AutoSploit.git`
1817

19-
After which it can be started from the terminal with `python autosploit.py`. After which you can select one of five actions. Please see the option summary below.
18+
Starting the program with `python autosploit.py` will open an AutoSploit terminal session. The options for which are as follows.
2019

2120
```
22-
+------------------+----------------------------------------------------+
23-
| Option | Summary |
24-
+------------------+----------------------------------------------------+
25-
|1\. Usage | Display this informational message. |
26-
|2\. Gather Hosts | Query Shodan for a list of platform specific IPs. |
27-
|3\. View Hosts | Print gathered IPs/RHOSTS. |
28-
|4\. Exploit | Configure MSF and Start exploiting gathered targets|
29-
|5\. Quit | Exits AutoSploit. |
30-
+------------------+----------------------------------------------------+
21+
1. Usage And Legal
22+
2. Gather Hosts
23+
3. Custom Hosts
24+
4. Add Single Host
25+
5. View Gathered Hosts
26+
6. Exploit Gathered Hosts
27+
99. Quit
3128
```
3229

33-
## Available Modules
30+
Choosing option `2` will prompt you for a platform specific search query. Enter `IIS` or `Apache` in example and choose a search engine. After doing so the collected hosts will be saved to be used in the `Exploit` component.
3431

35-
The Metasploit modules available with this tool are selected for RCE. You can find them in the `modules.txt` file that is included in this repo. Should you wish to add more or other modules please do so in the following format.
32+
As of version 2.0 AutoSploit can be started with a number of command line arguments/flags as well. Type `python autosploit.py -h`
33+
to display all the options available to you. I've posted the options below as well for reference.
3634

3735
```
38-
use exploit/linux/http/netgear_wnr2000_rce;exploit -j;
36+
usage: python autosploit.py -[c|z|s|a] -[q] QUERY
37+
[-C] WORKSPACE LHOST LPORT [-e]
38+
[--ruby-exec] [--msf-path] PATH [-E] EXPLOIT-FILE-PATH
39+
[--rand-agent] [--proxy] PROTO://IP:PORT [-P] AGENT
40+
41+
optional arguments:
42+
-h, --help show this help message and exit
43+
44+
search engines:
45+
possible search engines to use
46+
47+
-c, --censys use censys.io as the search engine to gather hosts
48+
-z, --zoomeye use zoomeye.org as the search engine to gather hosts
49+
-s, --shodan use shodan.io as the search engine to gather hosts
50+
-a, --all search all available search engines to gather hosts
51+
52+
requests:
53+
arguments to edit your requests
54+
55+
--proxy PROTO://IP:PORT
56+
run behind a proxy while performing the searches
57+
--random-agent use a random HTTP User-Agent header
58+
-P USER-AGENT, --personal-agent USER-AGENT
59+
pass a personal User-Agent to use for HTTP requests
60+
-q QUERY, --query QUERY
61+
pass your search query
62+
63+
exploits:
64+
arguments to edit your exploits
65+
66+
-E PATH, --exploit-file PATH
67+
provide a text file to convert into JSON and save for
68+
later use
69+
-C WORKSPACE LHOST LPORT, --config WORKSPACE LHOST LPORT
70+
set the configuration for MSF (IE -C default 127.0.0.1
71+
8080)
72+
-e, --exploit start exploiting the already gathered hosts
73+
74+
misc arguments:
75+
arguments that don't fit anywhere else
76+
77+
--ruby-exec if you need to run the Ruby executable with MSF use
78+
this
79+
--msf-path MSF-PATH pass the path to your framework if it is not in your
80+
ENV PATH
3981
```
4082

41-
With each new module on it's own line.
4283

4384
## Dependencies
4485

@@ -65,6 +106,8 @@ Since the program invokes functionality from the Metasploit Framework you need t
65106

66107
### Note
67108

68-
While this isn't exactly a Beta release it is an early release nonetheless as such the tool might be subject to changes in the future. If you happen to encounter a bug or would like to contribute to the tool's improvement please feel free to [Open a Ticket](https://github.com/NullArray/AutoSploit/issues) or [Submit a Pull Request](https://github.com/NullArray/AutoSploit/pulls)
109+
If you happen to encounter a bug please feel free to [Open a Ticket](https://github.com/NullArray/AutoSploit/issues).
110+
111+
If you wish to contribute to the development of this project please be sure to read [CONTRIBUTING.md](https://github.com/NullArray/AutoSploit/blob/master/CONTRIBUTING.md) before you get started as it contains our contribution guidelines.
69112

70-
Thanks.
113+
Thanks in advance.

0 commit comments

Comments
 (0)