volatility3.framework package

Volatility 3 framework.

class Deprecation[source]

Bases: object

Deprecation related methods.

static deprecated_method(replacement, replacement_version=None, additional_information='')[source]

A decorator for marking functions as deprecated.

Parameters:

  • replacement (Callable) – The replacement function overriding the deprecated API, in the form of a Callable (typically a method)

  • replacement_version (Tuple[int, int, int]) – The “replacement” base class version that the deprecated method expects before proxying to it. This implies that “replacement” is a method from a class that inherits from VersionableInterface.

  • additional_information (str) – Information appended at the end of the deprecation message

class NonInheritable(value, cls)[source]

Bases: object

class_subclasses(cls)[source]

Returns all the (recursive) subclasses of a given class.

Return type:

Generator[Type[TypeVar(T)], None, None]

clear_cache(complete=True)[source]
hide_from_subclasses(cls)[source]
Return type:

Type

import_file(module, path, ignore_errors=False)[source]

Imports a python file based on an existing module, a submodule and a filepath for error messages

Return type:

List[str]

Args

module: Module name to be imported path: File to be imported from (used for error messages)

Returns

List of modules that may have failed to import

import_files(base_module, ignore_errors=False)[source]

Imports all plugins present under plugins module namespace.

Return type:

List[str]

interface_version()[source]

Provides the so version number of the library.

Return type:

Tuple[int, int, int]

list_plugins()[source]
Return type:

Dict[str, Type[PluginInterface]]

require_interface_version(*args)[source]

Checks the required version of a plugin.

Return type:

None

Subpackages

Submodules