:py:mod:`dissect.target.plugins.os.unix.linux.environ`
======================================================

.. py:module:: dissect.target.plugins.os.unix.linux.environ




Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.linux.environ.EnvironPlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.linux.environ.EnvironmentVariableRecord


.. py:data:: EnvironmentVariableRecord

.. py:class:: EnvironPlugin(target: dissect.target.target.Target)

   Bases: :py:obj:`dissect.target.plugin.Plugin`


   Linux volatile proc environment plugin.


   .. py:method:: 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
      :class:`UnsupportedPluginError`.

      :raises UnsupportedPluginError: If the plugin could not be loaded.



   .. py:method:: environ() -> collections.abc.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:

      .. code-block:: text

          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.