:py:mod:`dissect.target.plugins.apps.webhosting.cpanel`
=======================================================

.. py:module:: dissect.target.plugins.apps.webhosting.cpanel


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.apps.webhosting.cpanel.CPanelPlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.apps.webhosting.cpanel.CPanelLastloginRecord
   dissect.target.plugins.apps.webhosting.cpanel.CPANEL_LASTLOGIN
   dissect.target.plugins.apps.webhosting.cpanel.CPANEL_LOGS_PATH
   dissect.target.plugins.apps.webhosting.cpanel.CPANEL_LASTLOGIN_PATTERN


.. py:data:: CPanelLastloginRecord

   

.. py:data:: CPANEL_LASTLOGIN
   :value: '.lastlogin'

   

.. py:data:: CPANEL_LOGS_PATH
   :value: '/usr/local/cpanel/logs'

   

.. py:data:: CPANEL_LASTLOGIN_PATTERN

   

.. py:class:: CPanelPlugin(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:: __namespace__
      :value: 'cpanel'

      

   .. 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:: lastlogin() -> Iterator[CPanelLastloginRecord]

      Return the content of the cPanel lastlogin file.

      The lastlogin files tracks successful cPanel interface logons. New logon events are only tracked
      if the IP-address of the logon changes.

      .. rubric:: References

      - https://forums.cpanel.net/threads/cpanel-control-panel-last-login-clarification.579221/
      - https://forums.cpanel.net/threads/lastlogin.707557/