Module Contents#



Base class for plugins.


dissect.target.plugins.os.unix.log.messages.DEFAULT_TS_LOG_FORMAT = '%b %d %H:%M:%S'#
class dissect.target.plugins.os.unix.log.messages.MessagesPlugin(target: dissect.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.


target – The Target object to load the plugin for.

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.


UnsupportedPluginError – If the plugin could not be loaded.

syslog() Iterator[MessagesRecord]#

Return contents of /var/log/messages* and /var/log/syslog*.

See messages for more information.

messages() Iterator[MessagesRecord]#

Return contents of /var/log/messages* and /var/log/syslog*.

Note: due to year rollover detection, the contents of the files are returned in reverse.

The messages log file holds information about a variety of events such as the system error messages, system startups and shutdowns, change in the network configuration, etc. Aims to store valuable, non-debug and non-critical messages. This log should be considered the “general system activity” log.