Class: Msf::PayloadSet

Attributes

singles	[R]	The list of singles that have been loaded.
sizes	[R]	The sizes of all the built payloads thus far.
stages	[R]	The list of stages that have been loaded.

Public Class methods

new(manager)

Creates an instance of a payload set which is just a specialized module set class that has custom handling for payloads.

Public Instance methods

add_blob_cache(key, blob, offsets)

Adds a blob to the blob cache so that the payload does not have to be recompiled in the future

add_module(pmodule, name, modinfo = nil)

This method is called when a new payload module class is loaded up. For the payload set we simply create an instance of the class and do some magic to figure out if it‘s a single, stager, or stage. Depending on which it is, we add it to the appropriate list.

add_single(p, name, modinfo)

This method adds a single payload to the set and adds it to the singles hash.

add_stage(p, full_name, stage_name, handler_type, modinfo)

This method adds a stage payload to the set and adds it to the stages hash using the supplied handler type.

check_blob_cache(key)

Checks to see if a payload has a blob cache entry. If it does, the blob is returned to the caller.

each_module_filter(opts, name, mod)

Performs custom filtering during each_module enumeration. This allows us to filter out certain stagers as necessary.

find_payload(platform, arch, handler, session, payload_type)

Looks for a payload that matches the specified requirements and returns an instance of that payload.

flush_blob_cache()

Flushes all entries from the blob cache

instance(name)

Returns a single read-only instance of the supplied payload name such that specific attributes, like compatibility, can be evaluated. The payload instance returned should NOT be used for anything other than reading.

on_module_reload(mod)

When a payload module is reloaded, the blob cache entry associated with it must be removed (if one exists)

recalculate()

This method builds the hash of alias names based on all the permutations of singles, stagers, and stages.

stagers()

Returns the hash of payload stagers that have been loaded.