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

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


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.linux.services.ServicesPlugin



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.plugins.os.unix.linux.services.should_ignore_file



Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.os.unix.linux.services.RECORD_NAME
   dissect.target.plugins.os.unix.linux.services.DEFAULT_ELEMENTS
   dissect.target.plugins.os.unix.linux.services.LinuxServiceRecord


.. py:data:: RECORD_NAME
   :value: 'linux/service'

   

.. py:data:: DEFAULT_ELEMENTS
   :value: [('datetime', 'ts'), ('string', 'type'), ('string', 'name'), ('path', 'source')]

   

.. py:data:: LinuxServiceRecord

   

.. py:class:: ServicesPlugin(target: dissect.target.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:: SYSTEMD_PATHS
      :value: ['/etc/systemd/system', '/lib/systemd/system', '/usr/lib/systemd/system']

      

   .. py:attribute:: INITD_PATHS
      :value: ['/etc/rc.d/init.d', '/etc/init.d']

      

   .. 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:: services() -> Iterator[LinuxServiceRecord]

      Return information about all installed systemd and init.d services.

      References:
      - https://geeksforgeeks.org/what-is-init-d-in-linux-service-management
      - http://0pointer.de/blog/projects/systemd-for-admins-3.html
      - https://www.freedesktop.org/software/systemd/man/systemd.syntax.html


   .. py:method:: systemd() -> Iterator[LinuxServiceRecord]


   .. py:method:: initd() -> Iterator[LinuxServiceRecord]



.. py:function:: should_ignore_file(needle: str, haystack: list) -> bool