Module Contents#



Base class for plugins.


class dissect.target.plugins.os.unix.linux.processes.ProcProcesses(target: dissect.target.Target)#

Bases: dissect.target.plugin.Plugin

Base class for plugins.

Plugins can optionally be namespaced by specifying the __namespace__ class attribute. Namespacing results in your plugin needing to be prefixed with this namespace when being called. For example, if your plugin has specified test as namespace and a function called example, you must call your plugin with test.example:

A Plugin class has the following private class attributes:

  • __namespace__

  • __record_descriptors__

With the following three being assigned in register():

  • __plugin__

  • __functions__

  • __exports__

Additionally, the methods and attributes of Plugin receive more private attributes by using decorators.

The export() decorator adds the following private attributes

  • __exported__

  • __output__: Set with the export() decorator.

  • __record__: Set with the export() decorator.

The internal() decorator and InternalPlugin set the __internal__ attribute. Finally. args() decorator sets the __args__ attribute.


target – The Target object to load the plugin for.

check_compatible() None#

Perform a compatibility check with the target.

This function should return None if the plugin is compatible with the current target (self.target). For example, check if a certain file exists. Otherwise it should raise an UnsupportedPluginError.


UnsupportedPluginError – If the plugin could not be loaded.

processes() Iterator[ProcProcessRecord]#

Return the processes available in /proc and the stats associated with them.

There is a numerical subdirectory for each running process; the subdirectory is named by the process ID. Each /proc/[pid] subdirectory contains various pseudo-files.

Yields ProcProcessRecord with the following fields:

hostname (string): The target hostname. domain (string): The target domain. ts (datetime): The start time of the process. name (string): The name of the process. state (string): The state of the process. pid (int): The process ID of the process. runtime (datetime): The amount of time the process is running until moment of acquisition. ppid (int): The parent process ID of the process. parent (string): The name of the parent process ID.