Files
volatility3/volatility/framework/interfaces/plugins.py
T
Mike Auty 14c0cc262c Significantly rework the configuration system.
So this is where I ripped out the guts of the dependency tree
and made it a little better defined in some ways, and delayed
populating it in others.  The validate function signature has
changed and I'm still up in the air whether to validate with
True/False or throw/catch exceptions.

So now, configurables have a list of requirements, these are
then bundled into a single requirement and can be passed to
automagic.  Automagic runs a set of things over the deptree
to help build/manage it.  These run in order of priority.

The tree is still built from the top down, but now automagic
can build branch from the bottom up and try and splice them
into the tree where appropriate.  Hopefully this will make it
easier to see follow.
2016-07-29 03:24:52 +01:00

68 lines
2.3 KiB
Python

"""
Created on 6 May 2013
@author: mike
"""
from abc import ABCMeta, abstractmethod
from volatility.framework import validity
from volatility.framework.interfaces import configuration as configuration_interface, context as context_interface
#
# Plugins
# - Take in relevant number of TranslationLayers (of specified type)
# - Outputs TreeGrid
#
# Should the plugin handle constructing the translation layers from the filenames or should the library have routines for it?
# Outwardly, the user specifies an OS, version, architecture triple and images.
# The UI checks the plugin against the OS/Version/Arch triple
# The UI constructs the TranslationLayers and names them according to the plugin's input layer names
# The UI constructs the appropriate default symbol spaces
# The plugin accepts the context and modifies as necessary
# The plugin runs and produces a TreeGrid output
class PluginInterface(configuration_interface.ConfigurableInterface, validity.ValidityRoutines, metaclass = ABCMeta):
"""Class that defines the interface all Plugins must maintain"""
def __init__(self, context, config_path):
validity.ValidityRoutines.__init__(self)
configuration_interface.ConfigurableInterface.__init__(self, config_path)
self._context = self._check_type(context, context_interface.ContextInterface)
# self.validate()
@property
def context(self):
return self._context
@property
def config(self):
return self._context.config.branch(self._config_path)
@classmethod
def get_requirements(cls):
"""Returns a list of Requirement objects for this plugin"""
return []
@classmethod
def validate(self, context, config_path):
print(config_path)
result_set = [requirement.validate(context, config_path) for requirement in self.get_requirements() if
not requirement.optional]
print(result_set)
return all(result_set)
@abstractmethod
def run(self):
"""Executes the functionality of the code
@:param
:return: a TreeGrid object that can then be passed to a Renderer.
:rtype: TreeGrid
"""
# TODO: Needs to say what it can/can't handle (validate context)
# TODO: Needs to offer available options'
# TODO: Figure out how to handle global config options