volatility3.plugins.linux.sockstat module

class SockHandlers(vmlinux, task)[source]

Bases: VersionableInterface

Handles several socket families extracting the sockets information.


Takes a kernel generic sock object and processes it with its respective socket family


sock (StructType) – Kernel generic sock object

Return type:

Tuple[StructType, Tuple[str, str, str], Dict]

Returns a tuple with:

sock: The respective kernel’s *_sock object for that socket family sock_stat: A tuple with the source and destination (address and port) along with its state string socket_filter: A dictionary with information about the socket filter

version = (1, 0, 0)
class Sockstat(context, config_path, progress_callback=None)[source]

Bases: PluginInterface

Lists all network connections for all processes.

  • context (ContextInterface) – The context that the plugin will operate within

  • config_path (str) – The path to configuration data within the context configuration data

  • progress_callback (Optional[Callable[[float, str], None]]) – A callable that can provide feedback at progress points


Constructs a HierarchicalDictionary of all the options required to build this component in the current context.

Ensures that if the class has been created, it can be recreated using the configuration built Inheriting classes must override this to ensure any dependent classes update their configurations too

Return type:


property config: HierarchicalDict

The Hierarchical configuration Dictionary for this Configurable object.

property config_path: str

The configuration path on which this configurable lives.

property context: ContextInterface

The context object that this configurable belongs to/configuration is stored in.

classmethod get_requirements()[source]

Returns a list of Requirement objects for this plugin.

classmethod list_sockets(context, symbol_table, filter_func=<function Sockstat.<lambda>>)[source]

Returns every single socket descriptor

  • context (ContextInterface) – The context to retrieve required elements (layers, symbol tables) from

  • symbol_table (str) – The name of the kernel module on which to operate

  • filter_func (Callable[[int], bool]) – A function which takes a task object and returns True if the task should be ignored/filtered


task – Kernel’s task object netns_id: Network namespace ID fd_num: File descriptor number family: Socket family string (AF_UNIX, AF_INET, etc) sock_type: Socket type string (STREAM, DGRAM, etc) protocol: Protocol string (UDP, TCP, etc) sock_fields: A tuple with the *_sock object, the sock stats and the extended info dictionary

classmethod make_subconfig(context, base_config_path, **kwargs)

Convenience function to allow constructing a new randomly generated sub-configuration path, containing each element from kwargs.

  • context (ContextInterface) – The context in which to store the new configuration

  • base_config_path (str) – The base configuration path on which to build the new configuration

  • kwargs – Keyword arguments that are used to populate the new configuration path


The newly generated full configuration path

Return type:


property open

Returns a context manager and thus can be called like open


Executes the functionality of the code.


This method expects self.validate to have been called to ensure all necessary options have been provided


A TreeGrid object that can then be passed to a Renderer.


Sets the file handler to be used by this plugin.

Return type:


classmethod unsatisfied(context, config_path)

Returns a list of the names of all unsatisfied requirements.

Since a satisfied set of requirements will return [], it can be used in tests as follows:

unmet = configurable.unsatisfied(context, config_path)
if unmet:
    raise RuntimeError("Unsatisfied requirements: {}".format(unmet)
Return type:

Dict[str, RequirementInterface]

version = (1, 0, 0)