Class: Wpxf::Module

Inherits:
Object
  • Object
show all
Includes:
Db::Credentials, ModuleAuthentication, ModuleInfo, Net::HttpClient, Options, OutputEmitters, WordPress::Fingerprint, WordPress::Login, WordPress::Options, WordPress::Urls
Defined in:
lib/wpxf/core/module.rb

Overview

The base class for all modules.

Constant Summary

Constants included from WordPress::Options

WordPress::Options::WP_OPTION_CONTENT_DIR

Instance Attribute Summary collapse

Attributes included from Options

#datastore, #options

Instance Method Summary collapse

Methods included from Db::Credentials

#store_credentials

Methods included from ModuleAuthentication

#authenticate_with_wordpress, #requires_authentication

Methods included from WordPress::Urls

#wordpress_url_admin, #wordpress_url_admin_ajax, #wordpress_url_admin_options, #wordpress_url_admin_post, #wordpress_url_admin_profile, #wordpress_url_admin_update, #wordpress_url_atom, #wordpress_url_author, #wordpress_url_comments_post, #wordpress_url_login, #wordpress_url_new_user, #wordpress_url_opml, #wordpress_url_plugin_install, #wordpress_url_plugin_upload, #wordpress_url_plugins, #wordpress_url_post, #wordpress_url_rdf, #wordpress_url_readme, #wordpress_url_rest_api, #wordpress_url_rss, #wordpress_url_sitemap, #wordpress_url_themes, #wordpress_url_uploads, #wordpress_url_wp_content, #wordpress_url_xmlrpc

Methods included from WordPress::Options

#wp_content_dir

Methods included from WordPress::Login

#valid_wordpress_cookie?, #wordpress_login, #wordpress_login_post_body

Methods included from WordPress::Fingerprint

#check_plugin_version_from_changelog, #check_plugin_version_from_readme, #check_theme_version_from_readme, #check_theme_version_from_style, #check_version_from_custom_file, #wordpress_and_online?, #wordpress_version

Methods included from Net::HttpClient

#base_http_headers, #base_uri, #download_file, #execute_delete_request, #execute_get_request, #execute_post_request, #execute_put_request, #execute_queued_requests, #execute_request, #full_uri, #initialize_advanced_options, #initialize_options, #max_http_concurrency, #normalize_relative_uri, #normalize_uri, #queue_request, #target_host, #target_port, #target_uri

Methods included from Net::UserAgent

#clients_by_frequency, #random_browser_and_os, #random_chrome_platform_string, #random_firefox_platform_string, #random_firefox_version_string, #random_iexplorer_platform_string, #random_opera_platform_string, #random_processor_string, #random_safari_platform_string, #random_time_string, #random_user_agent

Methods included from Versioning::OSVersions

#random_nt_version, #random_osx_version

Methods included from Versioning::BrowserVersions

#random_chrome_build_number, #random_chrome_version, #random_ie_version, #random_opera_version, #random_presto_version, #random_presto_version2, #random_safari_build_number, #random_safari_version, #random_trident_version

Methods included from Options

#all_options_valid?, #get_option, #get_option_value, #normalized_option_value, #option_valid?, #option_value?, #register_advanced_options, #register_evasion_options, #register_option, #register_options, #scoped_option_change, #unregister_option

Methods included from OutputEmitters

#emit_error, #emit_info, #emit_success, #emit_table, #emit_warning

Methods included from ModuleInfo

#emit_usage_info, #module_author, #module_date, #module_desc, #module_description_preformatted, #module_name, #module_references, #update_info

Constructor Details

#initialize ⇒ Module

Returns a new instance of Module



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/wpxf/core/module.rb', line 17

def initialize
  super

  register_option(
    BooleanOption.new(
      name: 'verbose',
      desc: 'Enable verbose output',
      required: true,
      default: false
    )
  )

  register_advanced_options([
    BooleanOption.new(
      name: 'check_wordpress_and_online',
      desc: 'Check that the target is running WordPress and is online',
      required: true,
      default: true
    )
  ])

  self.event_emitter = EventEmitter.new
end

Instance Attribute Details

#active_workspace ⇒ Models::Workspace

Returns the currently active Wpxf::Models::Workspace.

Returns:



135
136
137
 
# File 'lib/wpxf/core/module.rb', line 135

def active_workspace
  @active_workspace
end

#event_emitter ⇒ EventEmitter

Returns the EventEmitter for the module's events.

Returns:



132
133
134
 
# File 'lib/wpxf/core/module.rb', line 132

def event_emitter
  @event_emitter
end

#payload ⇒ Payload

Returns the Payload to use with the current module.

Returns:



129
130
131
 
# File 'lib/wpxf/core/module.rb', line 129

def payload
  @payload
end

#session_cookie ⇒ String? (readonly)

Returns the current session cookie, if authenticated with the target.

Returns:

  • (String, nil) —

    the current session cookie, if authenticated with the target.



138
139
140
 
# File 'lib/wpxf/core/module.rb', line 138

def session_cookie
  @session_cookie
end

Instance Method Details

#aux_module? ⇒ Boolean

Returns true if the module is an auxiliary module.

Returns:

  • (Boolean) —

    true if the module is an auxiliary module.



119
120
121
 
# File 'lib/wpxf/core/module.rb', line 119

def aux_module?
  to_s.split('::')[-2].eql? 'Auxiliary'
end

#can_execute? ⇒ Boolean

Returns true if all the required options are set.

Returns:

  • (Boolean) —

    true if all the required options are set.



42
43
44
 
# File 'lib/wpxf/core/module.rb', line 42

def can_execute?
  all_options_valid? && (aux_module? || (payload&.all_options_valid?))
end

#check ⇒ Symbol

Check if the target is vulnerable.

Returns:

  • (Symbol) —

    :unknown, :vulnerable or :safe.



114
115
116
 
# File 'lib/wpxf/core/module.rb', line 114

def check
  :unknown
end

#check_wordpress_and_online ⇒ Boolean

Returns true if the target is running WordPress.

Returns:

  • (Boolean) —

    true if the target is running WordPress.



47
48
49
50
51
52
53
54
 
# File 'lib/wpxf/core/module.rb', line 47

def check_wordpress_and_online
  unless wordpress_and_online?
    emit_error "#{full_uri} does not appear to be running WordPress"
    return false
  end

  true
end

#cleanup ⇒ Object

Cleanup any allocated resource to the module.



108
109
110
 
# File 'lib/wpxf/core/module.rb', line 108

def cleanup
  payload&.cleanup
end

#exploit_module? ⇒ Boolean

Returns true if the module is an exploit module.

Returns:

  • (Boolean) —

    true if the module is an exploit module.



124
125
126
 
# File 'lib/wpxf/core/module.rb', line 124

def exploit_module?
  to_s.split('::')[-2].eql? 'Exploit'
end

#missing_options ⇒ Array

Returns an array of missing option names that are required.

Returns:

  • (Array) —

    an array of missing option names that are required.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/wpxf/core/module.rb', line 57

def missing_options
  opts = super
  opts.push('payload') if exploit_module? && !payload

  if payload
    payload_opts = payload.missing_options
    opts = [*opts, *payload_opts] unless payload_opts.empty?
  end

  opts
end

#run ⇒ Boolean

Run the module.

Returns:

  • (Boolean) —

    true if successful.



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/wpxf/core/module.rb', line 94

def run
  if normalized_option_value('check_wordpress_and_online')
    return false unless check_wordpress_and_online
  end

  if requires_authentication
    @session_cookie = authenticate_with_wordpress(datastore['username'], datastore['password'])
    return false unless @session_cookie
  end

  true
end

#set_option_value(name, value) ⇒ String, Symbol

Set the value of a module option.

Parameters:

  • name —

    the name of the option to set.

  • value —

    the value to use.

Returns:

  • (String, Symbol) —

    the normalized value, :invalid if the specified value is invalid or :not_found if the name is invalid.



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/wpxf/core/module.rb', line 74

def set_option_value(name, value)
  res = super(name, value)

  if payload
    return payload.set_option_value(name, value) if res == :not_found
    payload.set_option_value(name, value)
  end

  res
end

#unset_option(name) ⇒ Object

Unset an option or reset it back to its default value.

Parameters:

  • name (String) —

    the name of the option to unset.



87
88
89
90
 
# File 'lib/wpxf/core/module.rb', line 87

def unset_option(name)
  super(name)
  payload&.unset_option(name)
end