mirror of
https://github.com/volatilityfoundation/volatility3.git
synced 2026-08-20 21:52:21 +02:00
Mike Auty
ea629591ef
This highlights that the FileHandler class can also be seen as a method similar to open, and it removes unnecessary context managers, allowing plugins to close files as they wish (they must, however, remember to close the file for it to be committed).
55 lines
2.5 KiB
Python
55 lines
2.5 KiB
Python
# This file is Copyright 2019 Volatility Foundation and licensed under the Volatility Software License 1.0
|
|
# which is available at https://www.volatilityfoundation.org/license/vsl-v1.0
|
|
#
|
|
"""All core generic plugins.
|
|
|
|
These modules should only be imported from volatility.plugins NOT
|
|
volatility.framework.plugins
|
|
"""
|
|
|
|
import logging
|
|
from typing import List, Type
|
|
|
|
from volatility.framework import interfaces, automagic, exceptions, constants
|
|
|
|
vollog = logging.getLogger(__name__)
|
|
|
|
|
|
def construct_plugin(context: interfaces.context.ContextInterface,
|
|
automagics: List[interfaces.automagic.AutomagicInterface],
|
|
plugin: Type[interfaces.plugins.PluginInterface], base_config_path: str,
|
|
progress_callback: constants.ProgressCallback,
|
|
open_method: Type[interfaces.plugins.FileHandlerInterface]) -> interfaces.plugins.PluginInterface:
|
|
"""Constructs a plugin object based on the parameters.
|
|
|
|
Clever magic figures out how to fulfill each requirement that might not be fulfilled
|
|
|
|
Args:
|
|
context: The volatility context to operate on
|
|
automagics: A list of automagic modules to run to augment the context
|
|
plugin: The plugin to run
|
|
base_config_path: The path within the context's config containing the plugin's configuration
|
|
progress_callback: Callback function to provide feedback for ongoing processes
|
|
open_method: class to provide context manager for opening the file
|
|
|
|
Returns:
|
|
The constructed plugin object
|
|
"""
|
|
errors = automagic.run(automagics, context, plugin, base_config_path, progress_callback = progress_callback)
|
|
# Plugins always get their configuration stored under their plugin name
|
|
plugin_config_path = interfaces.configuration.path_join(base_config_path, plugin.__name__)
|
|
|
|
# Check all the requirements and/or go back to the automagic step
|
|
unsatisfied = plugin.unsatisfied(context, plugin_config_path)
|
|
if unsatisfied:
|
|
for error in errors:
|
|
error_string = [x for x in error.format_exception_only()][-1]
|
|
vollog.warning("Automagic exception occurred: {}".format(error_string[:-1]))
|
|
vollog.log(constants.LOGLEVEL_V, "".join(error.format(chain = True)))
|
|
raise exceptions.UnsatisfiedException(unsatisfied)
|
|
|
|
constructed = plugin(context, plugin_config_path, progress_callback = progress_callback)
|
|
if open_method:
|
|
constructed.set_open_method(open_method)
|
|
return constructed
|