dissect.target.plugins.os.unix.linux.environ
#
Module Contents#
Classes#
Base class for plugins. |
Attributes#
- dissect.target.plugins.os.unix.linux.environ.EnvironmentVariableRecord#
- class dissect.target.plugins.os.unix.linux.environ.EnvironPlugin(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 specifiedtest
as namespace and a function calledexample
, you must call your plugin withtest.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 theexport()
decorator.__record__
: Set with theexport()
decorator.
The
internal()
decorator andInternalPlugin
set the__internal__
attribute. Finally.args()
decorator sets the__args__
attribute.- Parameters:
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 anUnsupportedPluginError
.- Raises:
UnsupportedPluginError – If the plugin could not be loaded.
- environ() Iterator[EnvironmentVariableRecord] #
Return the initial environment for all processes when they were started via execve(2).
If the process modified its environment (e.g., by calling functions such as putenv(3) or modifying the environ(7) variable directly), this plugin will not reflect those changes.
- Yields EnvironmentVariableRecord with the following fields:
hostname (string): The target hostname. domain (string): The target domain. ts (datetime): The modification timestamp of the processes’ environ file. name (string): The name associated to the pid. pid (varint): The process id (pid) of the process. variable (string): The name of the environment variable. content (string): The contents of the environment variable.