dissect.target.plugins.apps.webservers.caddy#

Module Contents#

Classes#

CaddyPlugin

Base class for plugins.

Attributes#

LOG_FILE_REGEX

LOG_REGEX

dissect.target.plugins.apps.webservers.caddy.LOG_FILE_REGEX#
dissect.target.plugins.apps.webservers.caddy.LOG_REGEX#
class dissect.target.plugins.apps.webservers.caddy.CaddyPlugin(target: dissect.target.target.Target)#

Bases: 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 register():

  • __plugin__

  • __functions__

  • __exports__

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

The export() decorator adds the following private attributes

  • __exported__

  • __output__: Set with the export() decorator.

  • __record__: Set with the export() decorator.

The internal() decorator and InternalPlugin set the __internal__ attribute. Finally. args() decorator sets the __args__ attribute.

Parameters:

target – The Target object to load the plugin for.

__namespace__ = 'caddy'#
check_compatible() → bool#

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.

get_log_paths() → list[pathlib.Path]#
access() → Iterator[dissect.target.plugins.apps.webservers.webservers.WebserverAccessLogRecord]#

Parses Caddy V1 CRF and Caddy V2 JSON access logs.

References