Class: Msf::Framework

Inherits:
Object
  • Object
show all
Includes:
MonitorMixin
Defined in:
lib/msf/core/framework.rb

Overview

This class is the primary context that modules, scripts, and user interfaces interact with. It ties everything together.

Defined Under Namespace

Modules: Offspring

Constant Summary collapse

Major =

Versioning information

Metasploit::Framework::Version::MAJOR
Minor =
Metasploit::Framework::Version::MINOR
Point =
Metasploit::Framework::Version::PATCH
Release =
"-#{Metasploit::Framework::Version::PRERELEASE}"
Version =
Metasploit::Framework::VERSION
Revision =
"$Revision$"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Framework

Creates an instance of the framework context.


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/msf/core/framework.rb', line 57

def initialize(options={})
  self.options = options
  # call super to initialize MonitorMixin.  #synchronize won't work without this.
  super()

  # Allow specific module types to be loaded
  types = options[:module_types] || Msf::MODULE_TYPES

  self.events    = EventDispatcher.new(self)
  self.modules   = ModuleManager.new(self,types)
  self.datastore = DataStore.new
  self.jobs      = Rex::JobContainer.new
  self.analyze   = Analyze.new(self)
  self.plugins   = PluginManager.new(self)
  self.browser_profiles = Hash.new
  self.features = FeatureManager.instance

  # Configure the thread factory
  Rex::ThreadFactory.provider = Metasploit::Framework::ThreadFactoryProvider.new(framework: self)

  # Configure the SSL certificate generator
  require 'msf/core/cert_provider'
  Rex::Socket::Ssl.cert_provider = Msf::Ssl::CertProvider

  subscriber = FrameworkEventSubscriber.new(self)
  events.add_exploit_subscriber(subscriber)
  events.add_session_subscriber(subscriber)
  events.add_general_subscriber(subscriber)
  events.add_db_subscriber(subscriber)
  events.add_ui_subscriber(subscriber)
end

Instance Attribute Details

#analyzeObject

The framework instance's analysis utility. Provide method to analyze framework objects to offer related objects/actions available.


187
188
189
# File 'lib/msf/core/framework.rb', line 187

def analyze
  @analyze
end

#auxmgrObject

The framework instance's aux manager. The aux manager is responsible for collecting and cataloging all aux information that comes in from aux modules.


165
166
167
# File 'lib/msf/core/framework.rb', line 165

def auxmgr
  @auxmgr
end

#browser_profilesObject

The framework instance's browser profile store. These profiles are generated by client-side modules and need to be shared across different contexts.


182
183
184
# File 'lib/msf/core/framework.rb', line 182

def browser_profiles
  @browser_profiles
end

#datastoreObject

The global framework datastore that can be used by modules.


159
160
161
# File 'lib/msf/core/framework.rb', line 159

def datastore
  @datastore
end

#dbMetasploit::Framework::DataService::DataProxy

The framework instance's data service proxy


204
205
206
207
208
# File 'lib/msf/core/framework.rb', line 204

def db
  synchronize {
    @db ||= get_db
  }
end

#eventsObject

Event management interface for registering event handler subscribers and for interacting with the correlation engine.


150
151
152
# File 'lib/msf/core/framework.rb', line 150

def events
  @events
end

#featuresObject

The framework instance's feature manager. The feature manager is responsible for configuring feature flags that can change characteristics of framework.


192
193
194
# File 'lib/msf/core/framework.rb', line 192

def features
  @features
end

#has_mingwObject

The framework instance's dependency


198
199
200
# File 'lib/msf/core/framework.rb', line 198

def has_mingw
  @has_mingw
end

#jobsObject

Background job management specific to things spawned from this instance of the framework.


170
171
172
# File 'lib/msf/core/framework.rb', line 170

def jobs
  @jobs
end

#modulesObject

Module manager that contains information about all loaded modules, regardless of type.


155
156
157
# File 'lib/msf/core/framework.rb', line 155

def modules
  @modules
end

#optionsHash (protected)

Options passed to #initialize

Returns:

  • (Hash)

270
271
272
# File 'lib/msf/core/framework.rb', line 270

def options
  @options
end

#pluginsObject

The framework instance's plugin manager. The plugin manager is responsible for exposing an interface that allows for the loading and unloading of plugins.


176
177
178
# File 'lib/msf/core/framework.rb', line 176

def plugins
  @plugins
end

Instance Method Details

#auxiliaryObject

Returns the module set for auxiliary modules


124
125
126
# File 'lib/msf/core/framework.rb', line 124

def auxiliary
  return modules.auxiliary
end

#eicar_corrupted?Boolean

EICAR Canary

Returns:

  • (Boolean)

    Should return true if the EICAR file has been corrupted


248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/msf/core/framework.rb', line 248

def eicar_corrupted?
  path = ::File.expand_path(::File.join(
    ::File.dirname(__FILE__),"..", "..", "..", "data", "eicar.com")
  )
  return true unless ::File.exist?(path)

  data = ::File.read(path)
  return true unless Digest::SHA1.hexdigest(data) == "3395856ce81f2b7382dee72602f798b642f14140"

  false

# If anything goes wrong assume AV got us
rescue ::Exception
  true
end

#encodersObject

Returns the module set for encoders.


96
97
98
# File 'lib/msf/core/framework.rb', line 96

def encoders
  return modules.encoders
end

#evasionObject


135
136
137
# File 'lib/msf/core/framework.rb', line 135

def evasion
  return modules.evasion
end

#exploitsObject

Returns the module set for exploits.


103
104
105
# File 'lib/msf/core/framework.rb', line 103

def exploits
  return modules.exploits
end

#inspectObject


89
90
91
# File 'lib/msf/core/framework.rb', line 89

def inspect
  "#<Framework (#{sessions.length} sessions, #{jobs.length} jobs, #{plugins.length} plugins#{db.active ? ", #{db.driver} database active" : ""})>"
end

#nopsObject

Returns the module set for nops


110
111
112
# File 'lib/msf/core/framework.rb', line 110

def nops
  return modules.nops
end

#payloadsObject

Returns the module set for payloads


117
118
119
# File 'lib/msf/core/framework.rb', line 117

def payloads
  return modules.payloads
end

#postObject

Returns the module set for post modules


131
132
133
# File 'lib/msf/core/framework.rb', line 131

def post
  return modules.post
end

#search(search_string) ⇒ Object


240
241
242
243
# File 'lib/msf/core/framework.rb', line 240

def search(search_string)
  search_params = Msf::Modules::Metadata::Search.parse_search_string(search_string)
  Msf::Modules::Metadata::Cache.instance.find(search_params)
end

#sessionsMsf::SessionManager

Session manager that tracks sessions associated with this framework instance over the course of their lifetime.

Returns:


214
215
216
217
218
# File 'lib/msf/core/framework.rb', line 214

def sessions
  synchronize {
    @sessions ||= Msf::SessionManager.new(self)
  }
end

#threadsMsf::ThreadManager

The framework instance's thread manager. The thread manager provides a cleaner way to manage spawned threads

Returns:


224
225
226
227
228
# File 'lib/msf/core/framework.rb', line 224

def threads
  synchronize {
    @threads ||= Msf::ThreadManager.new(self)
  }
end

#threads?true, false

Whether #threads has been initialized

Returns:

  • (true)

    if #threads has been initialized

  • (false)

    otherwise


234
235
236
237
238
# File 'lib/msf/core/framework.rb', line 234

def threads?
  synchronize {
    instance_variable_defined? :@threads
  }
end

#versionObject

Returns the framework version in Major.Minor format.


142
143
144
# File 'lib/msf/core/framework.rb', line 142

def version
  Version
end