Update README.md

NullArray · Mar 1, 2018 · Feb 7, 2018 · Feb 7, 2018 · Feb 7, 2018 · Feb 7, 2018
commit c85ebc197c0e1c5be58f231e34b87048a2eff98f
diff --git a/README.md b/README.md
@@ -1,44 +1,85 @@
 # AutoSploit
 
-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.
-
-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.
-
-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.
+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.
+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
 
 **Operational Security Consideration**
 
 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.
 
+The new version of AutoSploit has a feature that allows you to set a proxy before you connect and a custom user-agent.
+
 ## Usage
 
 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.
 
 `git clone https://github.com/NullArray/AutoSploit.git`
 
-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.
+Starting the program with `python autosploit.py` will open an AutoSploit terminal session. The options for which are as follows.
 
 ```
-+------------------+----------------------------------------------------+
-|     Option       |                   Summary                          |
-+------------------+----------------------------------------------------+
-|1\. Usage          | Display this informational message.                |
-|2\. Gather Hosts   | Query Shodan for a list of platform specific IPs.  |
-|3\. View Hosts     | Print gathered IPs/RHOSTS.                         |
-|4\. Exploit        | Configure MSF and Start exploiting gathered targets|
-|5\. Quit           | Exits AutoSploit.                                  |
-+------------------+----------------------------------------------------+
+1. Usage And Legal
+2. Gather Hosts
+3. Custom Hosts
+4. Add Single Host
+5. View Gathered Hosts
+6. Exploit Gathered Hosts
+99. Quit
 ```
 
-## Available Modules
+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.
 
-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.
+As of version 2.0 AutoSploit can be started with a number of command line arguments/flags as well. Type `python autosploit.py -h` 
+to display all the options available to you. I've posted the options below as well for reference.
 
 ```
-use exploit/linux/http/netgear_wnr2000_rce;exploit -j;
+usage: python autosploit.py -[c|z|s|a] -[q] QUERY
+                            [-C] WORKSPACE LHOST LPORT [-e]
+                            [--ruby-exec] [--msf-path] PATH [-E] EXPLOIT-FILE-PATH
+                            [--rand-agent] [--proxy] PROTO://IP:PORT [-P] AGENT
+
+optional arguments:
+  -h, --help            show this help message and exit
+
+search engines:
+  possible search engines to use
+
+  -c, --censys          use censys.io as the search engine to gather hosts
+  -z, --zoomeye         use zoomeye.org as the search engine to gather hosts
+  -s, --shodan          use shodan.io as the search engine to gather hosts
+  -a, --all             search all available search engines to gather hosts
+
+requests:
+  arguments to edit your requests
+
+  --proxy PROTO://IP:PORT
+                        run behind a proxy while performing the searches
+  --random-agent        use a random HTTP User-Agent header
+  -P USER-AGENT, --personal-agent USER-AGENT
+                        pass a personal User-Agent to use for HTTP requests
+  -q QUERY, --query QUERY
+                        pass your search query
+
+exploits:
+  arguments to edit your exploits
+
+  -E PATH, --exploit-file PATH
+                        provide a text file to convert into JSON and save for
+                        later use
+  -C WORKSPACE LHOST LPORT, --config WORKSPACE LHOST LPORT
+                        set the configuration for MSF (IE -C default 127.0.0.1
+                        8080)
+  -e, --exploit         start exploiting the already gathered hosts
+
+misc arguments:
+  arguments that don't fit anywhere else
+
+  --ruby-exec           if you need to run the Ruby executable with MSF use
+                        this
+  --msf-path MSF-PATH   pass the path to your framework if it is not in your
+                        ENV PATH
 ```
 
-With each new module on it's own line.
 
 ## Dependencies
 
@@ -65,6 +106,8 @@ Since the program invokes functionality from the Metasploit Framework you need t
 
 ### Note
 
-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)
+If you happen to encounter a bug please feel free to [Open a Ticket](https://github.com/NullArray/AutoSploit/issues).
+
+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.
 
-Thanks.
+Thanks in advance.