Merged development into master

Author: rastating

README.md

@@ -1,5 +1,5 @@
 # wordpress-exploit-framework
-[![Build Status](https://travis-ci.org/rastating/wordpress-exploit-framework.svg?branch=master)](https://travis-ci.org/rastating/wordpress-exploit-framework) [![Code Climate](https://codeclimate.com/github/rastating/wordpress-exploit-framework/badges/gpa.svg)](https://codeclimate.com/github/rastating/wordpress-exploit-framework) [![Dependency Status](https://gemnasium.com/rastating/wordpress-exploit-framework.svg)](https://gemnasium.com/rastating/wordpress-exploit-framework)
+[![Build Status](https://img.shields.io/travis/rastating/wordpress-exploit-framework/master.svg?colorB=007ec6)](https://travis-ci.org/rastating/wordpress-exploit-framework) [![Code Climate](https://img.shields.io/codeclimate/github/rastating/wordpress-exploit-framework.svg?colorB=007ec6)](https://codeclimate.com/github/rastating/wordpress-exploit-framework) [![Dependency Status](https://img.shields.io/gemnasium/rastating/wordpress-exploit-framework.svg?colorB=007ec6)](https://gemnasium.com/rastating/wordpress-exploit-framework) [![GitHub release](https://img.shields.io/github/release/rastating/wordpress-exploit-framework.svg)](https://github.com/rastating/wordpress-exploit-framework/releases/latest) [![License](https://img.shields.io/badge/license-GPL%20v3-blue.svg)](https://github.com/rastating/wordpress-exploit-framework/blob/master/LICENSE) [![Trello](https://img.shields.io/badge/trello-wordpress--exploit--framework-blue.svg)](https://trello.com/b/XuChenHg)
 
 A Ruby framework for developing and using modules which aid in the penetration testing of WordPress powered websites and systems.
 

VERSION

@@ -1 +1 @@
-1.4.1
+1.5

data/json/commands.json

@@ -12,6 +12,10 @@
       "cmd": "clear",
       "desc": "Clear the screen."
     },
+    {
+      "cmd": "exit",
+      "desc": "Exit the WordPress Exploit Framework prompt."
+    },
     {
       "cmd": "gset [option] [value]",
       "desc": "Set the [value] of [option] globally, so it is used by the current and future modules."

lib/cli/auto_complete.rb

@@ -28,19 +28,21 @@ def refresh_autocomplete_options
 
         if mod.exploit_module?
           opts_hash['payload'] = {}
-          Wpxf::Payloads.payload_list.each { |p| opts_hash['payload'][p] = {} }
+          Wpxf::Payloads.payload_list.each { |p| opts_hash['payload'][p[:name]] = {} }
         end
       end
 
       @autocomplete_list['set'] = opts_hash
       @autocomplete_list['unset'] = opts_hash
+      @autocomplete_list['gset'] = opts_hash
+      @autocomplete_list['gunset'] = opts_hash
     end
 
     def build_cmd_list
       cmds = {}
       permitted_commands.each { |c| cmds[c] = {} }
-      Wpxf::Auxiliary.module_list.each { |m| cmds['use'][m] = {} }
-      Wpxf::Exploit.module_list.each { |m| cmds['use'][m] = {} }
+      Wpxf::Auxiliary.module_list.each { |m| cmds['use'][m[:name]] = {} }
+      Wpxf::Exploit.module_list.each { |m| cmds['use'][m[:name]] = {} }
       cmds['show'] = {
         'options' => {},
         'advanced' => {},

lib/cli/console.rb

@@ -64,7 +64,10 @@ def prompt_for_input
 
       prompt += " [#{context.module_path}]" if context
       prompt += ' > '
-      Readline.readline(prompt, true)
+
+      input = Readline.readline(prompt, true).to_s
+      puts if input.empty?
+      input
     end
 
     def can_handle?(command)
@@ -103,6 +106,7 @@ def on_event_emitted(event)
     end
 
     def execute_user_command(command, args)
+      command = 'quit' if command == 'exit'
       if can_handle? command
         puts unless commands_without_output.include? command
         send(command, *args) if correct_number_of_args?(command, args)

lib/cli/context.rb

@@ -1,9 +1,6 @@
 module Cli
   # A context which modules will be used in.
   class Context
-    def initialize
-    end
-
     def class_name(path_name)
       return path_name if path_name !~ /_/ && path_name =~ /[A-Z]+.*/
       path_name.split('_').map(&:capitalize).join
@@ -14,22 +11,7 @@ def verbose?
     end
 
     def load_module(path)
-      match = path.match(/(auxiliary|exploit)\/(.+)/i)
-      raise 'Invalid module path' unless match
-
-      type = match.captures[0]
-      name = class_name(match.captures[1])
-
-      begin
-        if type.eql? 'auxiliary'
-          @module = Wpxf::Auxiliary.const_get(name).new
-        elsif type.eql? 'exploit'
-          @module = Wpxf::Exploit.const_get(name).new
-        end
-      rescue NameError
-        raise 'Invalid module name'
-      end
-
+      @module = Wpxf.load_module(path)
       @module_path = path
       @module
     end
@@ -45,19 +27,7 @@ def reload
     end
 
     def load_payload(name)
-      clsid = class_name(name)
-
-      if Wpxf::Payloads.const_defined?(clsid)
-        payload_class = Wpxf::Payloads.const_get(clsid)
-        if payload_class.is_a?(Class)
-          self.module.payload = payload_class.new
-        else
-          fail "\"#{name}\" is not a valid payload"
-        end
-      else
-        fail "\"#{name}\" is not a valid payload"
-      end
-
+      self.module.payload = Wpxf::Payloads.load_payload(name)
       self.module.payload.check(self.module)
       self.module.payload
     end

lib/cli/module_info.rb

@@ -13,7 +13,11 @@ def print_author
     def print_description
       print_std('Description:')
       indent_cursor do
-        print_std(wrap_text(context.module.module_desc))
+        if context.module.module_description_preformatted
+          print_std(indent_without_wrap(context.module.module_desc))
+        else
+          print_std(wrap_text(context.module.module_desc))
+        end
       end
     end
 

lib/cli/modules.rb

@@ -27,6 +27,7 @@ def use(module_path)
         mod = context.load_module(module_path)
         mod.event_emitter.subscribe(self)
         print_good "Loaded module: #{mod}"
+        mod.emit_usage_info
         @context_stack.push(context)
       rescue StandardError => e
         print_bad "Failed to load module: #{e}"
@@ -40,15 +41,20 @@ def use(module_path)
       refresh_autocomplete_options
     end
 
+    def module_name_from_class(klass)
+      klass.new.module_name
+    end
+
     def search_modules(args)
       pattern = /#{args.map { |m| Regexp.escape(m) }.join('|')}/i
       module_list = Wpxf::Auxiliary.module_list + Wpxf::Exploit.module_list
 
       results = []
-      module_list.select { |m| m =~ pattern }.each do |path|
-        context = Context.new
-        context.load_module(path)
-        results.push(path: path, title: context.module.module_name)
+      module_list.select { |m| m[:name] =~ pattern }.each do |mod|
+        results.push(
+          path: mod[:name],
+          title: module_name_from_class(mod[:class])
+        )
       end
 
       results

lib/cli/output.rb

@@ -12,6 +12,10 @@ def wrap_text(s, padding = 0, width = 78)
        .gsub(/\s+$/, '')
     end
 
+    def indent_without_wrap(s)
+      s.gsub(/\n/, "\n#{@indent * @indent_level}")
+    end
+
     def print_std(msg)
       puts "#{@indent * @indent_level}#{msg}"
     end

lib/wpxf/core/module_info.rb

@@ -17,7 +17,7 @@ def update_info(info)
 
       @info.merge!(info)
       @info[:date] = Date.parse(@info[:date].to_s)
-      @info[:desc] = @info[:desc].split.join(' ')
+      @info[:desc] = @info[:desc].gsub(/  +/, ' ')
       @info
     end
 
@@ -45,5 +45,15 @@ def module_author
     def module_date
       @info[:date]
     end
+
+    # @return [Boolean] true if the description is preformatted.
+    def module_description_preformatted
+      @info[:desc_preformatted]
+    end
+
+    # Emits any information that the user should be aware of before using the module.
+    def emit_usage_info
+      nil
+    end
   end
 end