metasploit-framework/lib/msf/core/session_manager.rb

121 lines
2.9 KiB
Ruby

module Msf
###
#
# The purpose of the session manager is to keep track of sessions that are
# created during the course of a framework instance's lifetime. When
# exploits succeed, the payloads they use will create a session object,
# where applicable, there will implement zero or more of the core
# supplied interfaces for interacting with that session. For instance,
# if the payload supports reading and writing from an executed process,
# the session would implement SimpleCommandShell in a method that is
# applicable to the way that the command interpreter is communicated
# with.
#
###
class SessionManager < Hash
include Framework::Offspring
def initialize(framework)
self.framework = framework
self.sid_pool = 0
self.reaper_thread = framework.threads.spawn("SessionManager", true, self) do |manager|
while true
::IO.select(nil, nil, nil, 0.5)
manager.each_value do |s|
if not s.alive?
manager.deregister(s, "Died")
wlog("Session #{s.sid} has died")
next
end
end
end
end
end
#
# Enumerates the sorted list of keys.
#
def each_sorted(&block)
self.keys.sort.each(&block)
end
#
# Registers the supplied session object with the framework and returns
# a unique session identifier to the caller.
#
def register(session)
if (session.sid)
wlog("registered session passed to register again (sid #{session.sid}).")
return nil
end
next_sid = (self.sid_pool += 1)
# Insert the session into the session hash table
self[next_sid.to_i] = session
# Initialize the session's sid and framework instance pointer
session.sid = next_sid
session.framework = framework
# Notify the framework that we have a new session opening up...
framework.events.on_session_open(session)
if session.respond_to?("console")
session.console.on_command_proc = Proc.new { |command, error| framework.events.on_session_command(session, command) }
end
return next_sid
end
#
# Deregisters the supplied session object with the framework.
#
def deregister(session, reason='')
if (session.dead? and not self[session.sid.to_i])
return
end
# Tell the framework that we have a parting session
framework.events.on_session_close(session, reason)
# If this session implements the comm interface, remove any routes
# that have been created for it.
if (session.kind_of?(Msf::Session::Comm))
Rex::Socket::SwitchBoard.remove_by_comm(session)
end
if session.kind_of?(Msf::Session::Interactive)
session.interacting = false
end
# Remove it from the hash
self.delete(session.sid.to_i)
# Mark the session as dead
session.alive = false
# Close it down
session.cleanup
end
#
# Returns the session associated with the supplied sid, if any.
#
def get(sid)
return self[sid.to_i]
end
protected
attr_accessor :sid_pool, :sessions # :nodoc:
attr_accessor :reaper_thread # :nodoc:
end
end