mirror of
https://github.com/volatilityfoundation/volatility3.git
synced 2026-08-17 20:35:40 +02:00
57 lines
1.7 KiB
Python
57 lines
1.7 KiB
Python
"""
|
|
Created on 6 May 2013
|
|
|
|
@author: mike
|
|
"""
|
|
from abc import abstractmethod, ABCMeta
|
|
|
|
from volatility.framework import validity
|
|
from volatility.framework.interfaces import context as context_module
|
|
|
|
#
|
|
# 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(validity.ValidityRoutines, metaclass = ABCMeta):
|
|
"""Class that defines the interface all Plugins must maintain"""
|
|
|
|
def __init__(self, context):
|
|
self._type_check(context, context_module.ContextInterface)
|
|
self._context = context
|
|
|
|
@property
|
|
def context(self):
|
|
return self._context
|
|
|
|
@abstractmethod
|
|
def requirements(self):
|
|
"""Returns a ConfigGroup object to contain the required options"""
|
|
pass
|
|
|
|
def check_requirements(self):
|
|
pass
|
|
|
|
@abstractmethod
|
|
def __call__(self, context):
|
|
"""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
|