:py:mod:`dissect.target.plugins.apps.shell.powershell`
======================================================

.. py:module:: dissect.target.plugins.apps.shell.powershell


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.apps.shell.powershell.PowerShellHistoryPlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.apps.shell.powershell.ConsoleHostHistoryRecord


.. py:data:: ConsoleHostHistoryRecord

   

.. py:class:: PowerShellHistoryPlugin(target)


   Bases: :py:obj:`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 :func:`register`:

   - ``__plugin__``
   - ``__functions__``
   - ``__exports__``

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

   The :func:`export` decorator adds the following private attributes

   - ``__exported__``
   - ``__output__``: Set with the :func:`export` decorator.
   - ``__record__``: Set with the :func:`export` decorator.

   The :func:`internal` decorator and :class:`InternalPlugin` set the ``__internal__`` attribute.
   Finally. :func:`args` decorator sets the ``__args__`` attribute.

   :param target: The :class:`~dissect.target.target.Target` object to load the plugin for.

   .. py:attribute:: PATHS
      :value: ['AppData/Roaming/Microsoft/Windows/PowerShell/psreadline', '.local/share/powershell/PSReadLine']

      

   .. 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 ``UnsupportedPluginError``.

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


   .. py:method:: powershell_history()

      Return PowerShell command history for all users.

      The PowerShell ConsoleHost_history.txt file contains information about the commands executed with PowerShell in
      a terminal. No data is recorded from terminal-less PowerShell sessions. Commands are saved to disk after the process has completed.
      PSReadLine does not save commands containing 'password', 'asplaintext', 'token', 'apikey' or 'secret'.

      .. rubric:: References

      - https://0xdf.gitlab.io/2018/11/08/powershell-history-file.html
      - https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_history?view=powershell-7.3#order-of-commands-in-the-history
      - https://learn.microsoft.com/en-us/powershell/module/psreadline/about/about_psreadline?view=powershell-7.3#command-history