:py:mod:`dissect.target.plugins.apps.webserver.caddy`
=====================================================

.. py:module:: dissect.target.plugins.apps.webserver.caddy




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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.apps.webserver.caddy.CaddyPlugin




Attributes
~~~~~~~~~~

.. autoapisummary::

   dissect.target.plugins.apps.webserver.caddy.LOG_FILE_REGEX
   dissect.target.plugins.apps.webserver.caddy.LOG_REGEX


.. py:data:: LOG_FILE_REGEX

.. py:data:: LOG_REGEX

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

   Bases: :py:obj:`dissect.target.plugins.apps.webserver.webserver.WebserverPlugin`


   Caddy webserver plugin.


   .. py:attribute:: __namespace__
      :value: 'caddy'


      Defines the plugin namespace.


   .. py:attribute:: DEFAULT_CONFIG_PATH
      :value: '/etc/caddy/Caddyfile'



   .. py:attribute:: log_paths
      :value: []



   .. 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:: get_log_paths() -> list[pathlib.Path]


   .. py:method:: access() -> collections.abc.Iterator[dissect.target.plugins.apps.webserver.webserver.WebserverAccessLogRecord]

      Parses Caddy V1 CRF and Caddy V2 JSON access logs.

      .. rubric:: References

      - https://caddyserver.com/docs/caddyfile/directives/log#format-modules