Module Msf::Session
In: lib/msf/core/session/provider/multi_command_shell.rb
lib/msf/core/session/provider/single_command_execution.rb
lib/msf/core/session/provider/single_command_shell.rb
lib/msf/core/session/provider/multi_command_execution.rb
lib/msf/core/session/interactive.rb
lib/msf/core/session/basic.rb
lib/msf/core/session/comm.rb
lib/msf/core/session.rb

The session class represents a post-exploitation, uh, session. Sessions can be written to, read from, and interacted with. The underlying medium on which they are backed is arbitrary. For instance, when an exploit is provided with a command shell, either through a network connection or locally, the session‘s read and write operations end up reading from and writing to the shell that was spawned. The session object can be seen as a general means of interacting with various post-exploitation payloads through a common interface that is not necessarily tied to a network connection.

Methods

Included Modules

Framework::Offspring

Classes and Modules

Module Msf::Session::Basic
Module Msf::Session::Comm
Module Msf::Session::Interactive
Module Msf::Session::Provider

Attributes

framework  [RW]  The framework instance that created this session.
sid  [RW]  The session unique identifier.
sname  [RW]  The session name.

Public Class methods

Public Instance methods

Perform session-specific cleanup.

Returns the description of the session.

By default, sessions are not interactive.

Allow the user to terminate this session

Returns the suggested name of the log file for this session.

This method logs the supplied buffer as coming from the local side of the session.

This method logs the supplied buffer as coming from the remote side of the session.

Returns the log source that should be used for this session.

Returns the session‘s name if it‘s been assigned one, otherwise the sid is returned.

Sets the session‘s name.

Sets the vector through which this session was realized.

Returns the local side of the tunnel.

Returns the peer side of the tunnel.

Returns a pretty representation of the tunnel.

Returns the type of session in use.

Returns the exploit module name through which this session was created.

Returns the payload module name through which this session was created.

[Validate]