Module Contents#



locate file parser


Base class for plugins.


dissect.target.plugins.os.unix.locate.gnulocate.gnulocate_def = Multiline-String#
Show Value
#define MAGIC 0x004c4f43415445303200             /* b'/x00LOCATE02/x00' */

struct entry {
    int8 offset;
    char path[];
class dissect.target.plugins.os.unix.locate.gnulocate.GNULocateFile(fh: BinaryIO)#

locate file parser

Multiple formats exist for the locatedb file. This class only supports the most recent version LOCATE02.

The file is encoded with front compression (incremental encoding). This is a form of compression which takes a number of characters of the previous encoded entries. Entries are separated with a null byte.

__iter__() Iterable[GNULocateFile]#
class dissect.target.plugins.os.unix.locate.gnulocate.GNULocatePlugin(target: dissect.target.Target)#

Bases: dissect.target.plugins.os.unix.locate.locate.BaseLocatePlugin

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.

__namespace__ = 'gnulocate'#
path = '/var/cache/locate/locatedb'#
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.

locate() GNULocateRecord#

Yield file and directory names from GNU findutils’ locatedb file.