mirror of
https://github.com/volatilityfoundation/volatility3.git
synced 2026-08-21 05:52:22 +02:00
49 lines
1.3 KiB
Python
49 lines
1.3 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
|
|
|
|
|
|
class PluginInterface(validity.ValidityRoutines):
|
|
"""Class that defines the interface all Plugins must maintain"""
|
|
__metaclass__ = ABCMeta
|
|
|
|
def __init__(self, context):
|
|
self.type_check(context, context_module.ContextInterface)
|
|
self._context = context
|
|
|
|
@property
|
|
def context(self):
|
|
return self._context
|
|
|
|
@abstractmethod
|
|
def establish_context(self):
|
|
"""Alters the context to ensure the plugin can run.
|
|
|
|
This function constructs the necessary address spaces and symbol spaces that the plugin will need.
|
|
"""
|
|
|
|
@abstractmethod
|
|
def plugin_options(self, config_group = None):
|
|
"""Modifies the passed in ConfigGroup object to contain the required options"""
|
|
|
|
@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
|