dissect.target.plugins.filesystem.resolver

Module Contents

Classes

ResolverPlugin

Base class for plugins.

Attributes

re_quoted

REPLACEMENTS

FALLBACK_SEARCH_PATHS

dissect.target.plugins.filesystem.resolver.re_quoted
dissect.target.plugins.filesystem.resolver.REPLACEMENTS = [('/systemroot/', '/%systemroot%/')]
dissect.target.plugins.filesystem.resolver.FALLBACK_SEARCH_PATHS = ['sysvol/windows/system32', 'sysvol/windows/syswow64', 'sysvol/windows']
class dissect.target.plugins.filesystem.resolver.ResolverPlugin(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 two being assigned in register():

  • __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.

The alias() decorator populates the __aliases__ private attribute of Plugin methods. Resulting clones of the Plugin are populated with the boolean __alias__ attribute set to True.

Parameters:

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.

Raises:

UnsupportedPluginError – If the plugin could not be loaded.

resolve(path: str, user: str | None = None) → str

Resolve a partial path string to a file or directory present in the target.

For Windows known file locations are searched, e.g. paths from the %path% variable and common path extentions tried. If a user SID is provided that user’s %path% variable is used.

resolve_windows(path: str, user_sid: str | None = None) → str
resolve_default(path: str, user_id: str | None = None) → str