volatility3.framework.interfaces package

The interfaces module contains the API interface for the core volatility framework.

These interfaces should help developers attempting to write components for the main framework and help them understand how to use the internal components of volatility to write plugins.

Submodules

• volatility3.framework.interfaces.automagic module
  • AutomagicInterface
    • AutomagicInterface.build_configuration()
    • AutomagicInterface.config
    • AutomagicInterface.config_path
    • AutomagicInterface.context
    • AutomagicInterface.exclusion_list
    • AutomagicInterface.find_requirements()
    • AutomagicInterface.get_requirements()
    • AutomagicInterface.make_subconfig()
    • AutomagicInterface.priority
    • AutomagicInterface.unsatisfied()
  • StackerLayerInterface
    • StackerLayerInterface.exclusion_list
    • StackerLayerInterface.stack()
    • StackerLayerInterface.stack_order
    • StackerLayerInterface.stacker_slow_warning()
• volatility3.framework.interfaces.configuration module
  • CONFIG_SEPARATOR
  • ClassRequirement
    • ClassRequirement.add_requirement()
    • ClassRequirement.cls
    • ClassRequirement.config_value()
    • ClassRequirement.default
    • ClassRequirement.description
    • ClassRequirement.name
    • ClassRequirement.optional
    • ClassRequirement.remove_requirement()
    • ClassRequirement.requirements
    • ClassRequirement.unsatisfied()
    • ClassRequirement.unsatisfied_children()
  • ConfigurableInterface
    • ConfigurableInterface.build_configuration()
    • ConfigurableInterface.config
    • ConfigurableInterface.config_path
    • ConfigurableInterface.context
    • ConfigurableInterface.get_requirements()
    • ConfigurableInterface.make_subconfig()
    • ConfigurableInterface.unsatisfied()
  • ConfigurableRequirementInterface
    • ConfigurableRequirementInterface.add_requirement()
    • ConfigurableRequirementInterface.build_configuration()
    • ConfigurableRequirementInterface.config_value()
    • ConfigurableRequirementInterface.default
    • ConfigurableRequirementInterface.description
    • ConfigurableRequirementInterface.name
    • ConfigurableRequirementInterface.optional
    • ConfigurableRequirementInterface.remove_requirement()
    • ConfigurableRequirementInterface.requirements
    • ConfigurableRequirementInterface.unsatisfied()
    • ConfigurableRequirementInterface.unsatisfied_children()
  • ConstructableRequirementInterface
    • ConstructableRequirementInterface.add_requirement()
    • ConstructableRequirementInterface.config_value()
    • ConstructableRequirementInterface.construct()
    • ConstructableRequirementInterface.default
    • ConstructableRequirementInterface.description
    • ConstructableRequirementInterface.name
    • ConstructableRequirementInterface.optional
    • ConstructableRequirementInterface.remove_requirement()
    • ConstructableRequirementInterface.requirements
    • ConstructableRequirementInterface.unsatisfied()
    • ConstructableRequirementInterface.unsatisfied_children()
  • HierarchicalDict
    • HierarchicalDict.branch()
    • HierarchicalDict.clone()
    • HierarchicalDict.data
    • HierarchicalDict.generator()
    • HierarchicalDict.get()
    • HierarchicalDict.items()
    • HierarchicalDict.keys()
    • HierarchicalDict.merge()
    • HierarchicalDict.separator
    • HierarchicalDict.splice()
    • HierarchicalDict.values()
  • RequirementInterface
    • RequirementInterface.add_requirement()
    • RequirementInterface.config_value()
    • RequirementInterface.default
    • RequirementInterface.description
    • RequirementInterface.name
    • RequirementInterface.optional
    • RequirementInterface.remove_requirement()
    • RequirementInterface.requirements
    • RequirementInterface.unsatisfied()
    • RequirementInterface.unsatisfied_children()
  • SimpleTypeRequirement
    • SimpleTypeRequirement.add_requirement()
    • SimpleTypeRequirement.config_value()
    • SimpleTypeRequirement.default
    • SimpleTypeRequirement.description
    • SimpleTypeRequirement.instance_type
    • SimpleTypeRequirement.name
    • SimpleTypeRequirement.optional
    • SimpleTypeRequirement.remove_requirement()
    • SimpleTypeRequirement.requirements
    • SimpleTypeRequirement.unsatisfied()
    • SimpleTypeRequirement.unsatisfied_children()
  • VersionableInterface
    • VersionableInterface.version
  • parent_path()
  • path_depth()
  • path_head()
  • path_join()
• volatility3.framework.interfaces.context module
  • ContextInterface
    • ContextInterface.add_layer()
    • ContextInterface.add_module()
    • ContextInterface.clone()
    • ContextInterface.config
    • ContextInterface.layers
    • ContextInterface.module()
    • ContextInterface.modules
    • ContextInterface.object()
    • ContextInterface.symbol_space
  • ModuleContainer
    • ModuleContainer.add_module()
    • ModuleContainer.free_module_name()
    • ModuleContainer.get()
    • ModuleContainer.get_modules_by_symbol_tables()
    • ModuleContainer.items()
    • ModuleContainer.keys()
    • ModuleContainer.values()
  • ModuleInterface
    • ModuleInterface.build_configuration()
    • ModuleInterface.config
    • ModuleInterface.config_path
    • ModuleInterface.context
    • ModuleInterface.get_absolute_symbol_address()
    • ModuleInterface.get_enumeration()
    • ModuleInterface.get_requirements()
    • ModuleInterface.get_symbol()
    • ModuleInterface.get_symbols_by_absolute_location()
    • ModuleInterface.get_type()
    • ModuleInterface.has_enumeration()
    • ModuleInterface.has_symbol()
    • ModuleInterface.has_type()
    • ModuleInterface.layer_name
    • ModuleInterface.make_subconfig()
    • ModuleInterface.name
    • ModuleInterface.object()
    • ModuleInterface.object_from_symbol()
    • ModuleInterface.offset
    • ModuleInterface.symbol_table_name
    • ModuleInterface.symbols
    • ModuleInterface.unsatisfied()
• volatility3.framework.interfaces.layers module
  • DataLayerInterface
    • DataLayerInterface.address_mask
    • DataLayerInterface.build_configuration()
    • DataLayerInterface.config
    • DataLayerInterface.config_path
    • DataLayerInterface.context
    • DataLayerInterface.dependencies
    • DataLayerInterface.destroy()
    • DataLayerInterface.get_requirements()
    • DataLayerInterface.is_valid()
    • DataLayerInterface.make_subconfig()
    • DataLayerInterface.maximum_address
    • DataLayerInterface.metadata
    • DataLayerInterface.minimum_address
    • DataLayerInterface.name
    • DataLayerInterface.read()
    • DataLayerInterface.scan()
    • DataLayerInterface.unsatisfied()
    • DataLayerInterface.write()
  • DummyProgress
  • LayerContainer
    • LayerContainer.add_layer()
    • LayerContainer.check_cycles()
    • LayerContainer.del_layer()
    • LayerContainer.free_layer_name()
    • LayerContainer.get()
    • LayerContainer.items()
    • LayerContainer.keys()
    • LayerContainer.read()
    • LayerContainer.values()
    • LayerContainer.write()
  • ScannerInterface
    • ScannerInterface.context
    • ScannerInterface.layer_name
    • ScannerInterface.thread_safe
    • ScannerInterface.version
  • TranslationLayerInterface
    • TranslationLayerInterface.address_mask
    • TranslationLayerInterface.build_configuration()
    • TranslationLayerInterface.config
    • TranslationLayerInterface.config_path
    • TranslationLayerInterface.context
    • TranslationLayerInterface.dependencies
    • TranslationLayerInterface.destroy()
    • TranslationLayerInterface.get_requirements()
    • TranslationLayerInterface.is_valid()
    • TranslationLayerInterface.make_subconfig()
    • TranslationLayerInterface.mapping()
    • TranslationLayerInterface.maximum_address
    • TranslationLayerInterface.metadata
    • TranslationLayerInterface.minimum_address
    • TranslationLayerInterface.name
    • TranslationLayerInterface.read()
    • TranslationLayerInterface.scan()
    • TranslationLayerInterface.unsatisfied()
    • TranslationLayerInterface.write()
• volatility3.framework.interfaces.objects module
  • ObjectInformation
    • ObjectInformation.layer_name
    • ObjectInformation.member_name
    • ObjectInformation.native_layer_name
    • ObjectInformation.offset
    • ObjectInformation.parent
    • ObjectInformation.size
  • ObjectInterface
    • ObjectInterface.VolTemplateProxy
      • ObjectInterface.VolTemplateProxy.child_template()
      • ObjectInterface.VolTemplateProxy.children()
      • ObjectInterface.VolTemplateProxy.has_member()
      • ObjectInterface.VolTemplateProxy.relative_child_offset()
      • ObjectInterface.VolTemplateProxy.replace_child()
      • ObjectInterface.VolTemplateProxy.size()
    • ObjectInterface.cast()
    • ObjectInterface.get_symbol_table_name()
    • ObjectInterface.has_member()
    • ObjectInterface.has_valid_member()
    • ObjectInterface.has_valid_members()
    • ObjectInterface.vol
    • ObjectInterface.write()
  • ReadOnlyMapping
    • ReadOnlyMapping.get()
    • ReadOnlyMapping.items()
    • ReadOnlyMapping.keys()
    • ReadOnlyMapping.values()
  • Template
    • Template.child_template()
    • Template.children
    • Template.clone()
    • Template.has_member()
    • Template.relative_child_offset()
    • Template.replace_child()
    • Template.size
    • Template.update_vol()
    • Template.vol
• volatility3.framework.interfaces.plugins module
  • FileHandlerInterface
    • FileHandlerInterface.close()
    • FileHandlerInterface.closed
    • FileHandlerInterface.fileno()
    • FileHandlerInterface.flush()
    • FileHandlerInterface.isatty()
    • FileHandlerInterface.preferred_filename
    • FileHandlerInterface.read()
    • FileHandlerInterface.readable()
    • FileHandlerInterface.readall()
    • FileHandlerInterface.readinto()
    • FileHandlerInterface.readline()
    • FileHandlerInterface.readlines()
    • FileHandlerInterface.sanitize_filename()
    • FileHandlerInterface.seek()
    • FileHandlerInterface.seekable()
    • FileHandlerInterface.tell()
    • FileHandlerInterface.truncate()
    • FileHandlerInterface.writable()
    • FileHandlerInterface.write()
    • FileHandlerInterface.writelines()
  • PluginInterface
    • PluginInterface.build_configuration()
    • PluginInterface.config
    • PluginInterface.config_path
    • PluginInterface.context
    • PluginInterface.get_requirements()
    • PluginInterface.make_subconfig()
    • PluginInterface.open
    • PluginInterface.run()
    • PluginInterface.set_open_method()
    • PluginInterface.unsatisfied()
    • PluginInterface.version
• volatility3.framework.interfaces.renderers module
  • BaseAbsentValue
  • BasicType
  • Column
    • Column.count()
    • Column.index()
    • Column.name
    • Column.type
  • ColumnSortKey
    • ColumnSortKey.ascending
  • Disassembly
    • Disassembly.possible_architectures
  • Renderer
    • Renderer.get_render_options()
    • Renderer.render()
  • TreeGrid
    • TreeGrid.base_types
    • TreeGrid.children()
    • TreeGrid.columns
    • TreeGrid.context
    • TreeGrid.is_ancestor()
    • TreeGrid.max_depth()
    • TreeGrid.path_depth()
    • TreeGrid.populate()
    • TreeGrid.populated
    • TreeGrid.sanitize_name()
    • TreeGrid.values()
    • TreeGrid.visit()
  • TreeNode
    • TreeNode.count()
    • TreeNode.index()
    • TreeNode.parent
    • TreeNode.path
    • TreeNode.path_changed()
    • TreeNode.path_depth
    • TreeNode.values
  • TypeRendererInterface
    • TypeRendererInterface.options
    • TypeRendererInterface.render()
    • TypeRendererInterface.type
• volatility3.framework.interfaces.symbols module
  • BaseSymbolTableInterface
    • BaseSymbolTableInterface.clear_symbol_cache()
    • BaseSymbolTableInterface.del_type_class()
    • BaseSymbolTableInterface.enumerations
    • BaseSymbolTableInterface.get_symbol()
    • BaseSymbolTableInterface.get_symbol_type()
    • BaseSymbolTableInterface.get_symbols_by_location()
    • BaseSymbolTableInterface.get_symbols_by_type()
    • BaseSymbolTableInterface.get_type()
    • BaseSymbolTableInterface.get_type_class()
    • BaseSymbolTableInterface.natives
    • BaseSymbolTableInterface.optional_set_type_class()
    • BaseSymbolTableInterface.set_type_class()
    • BaseSymbolTableInterface.symbols
    • BaseSymbolTableInterface.types
  • MetadataInterface
  • NativeTableInterface
    • NativeTableInterface.clear_symbol_cache()
    • NativeTableInterface.del_type_class()
    • NativeTableInterface.enumerations
    • NativeTableInterface.get_enumeration()
    • NativeTableInterface.get_symbol()
    • NativeTableInterface.get_symbol_type()
    • NativeTableInterface.get_symbols_by_location()
    • NativeTableInterface.get_symbols_by_type()
    • NativeTableInterface.get_type()
    • NativeTableInterface.get_type_class()
    • NativeTableInterface.natives
    • NativeTableInterface.optional_set_type_class()
    • NativeTableInterface.set_type_class()
    • NativeTableInterface.symbols
    • NativeTableInterface.types
  • SymbolInterface
    • SymbolInterface.address
    • SymbolInterface.constant_data
    • SymbolInterface.name
    • SymbolInterface.type
    • SymbolInterface.type_name
  • SymbolSpaceInterface
    • SymbolSpaceInterface.append()
    • SymbolSpaceInterface.clear_symbol_cache()
    • SymbolSpaceInterface.free_table_name()
    • SymbolSpaceInterface.get()
    • SymbolSpaceInterface.get_enumeration()
    • SymbolSpaceInterface.get_symbol()
    • SymbolSpaceInterface.get_symbols_by_location()
    • SymbolSpaceInterface.get_symbols_by_type()
    • SymbolSpaceInterface.get_type()
    • SymbolSpaceInterface.has_enumeration()
    • SymbolSpaceInterface.has_symbol()
    • SymbolSpaceInterface.has_type()
    • SymbolSpaceInterface.items()
    • SymbolSpaceInterface.keys()
    • SymbolSpaceInterface.values()
  • SymbolTableInterface
    • SymbolTableInterface.build_configuration()
    • SymbolTableInterface.clear_symbol_cache()
    • SymbolTableInterface.config
    • SymbolTableInterface.config_path
    • SymbolTableInterface.context
    • SymbolTableInterface.del_type_class()
    • SymbolTableInterface.enumerations
    • SymbolTableInterface.get_requirements()
    • SymbolTableInterface.get_symbol()
    • SymbolTableInterface.get_symbol_type()
    • SymbolTableInterface.get_symbols_by_location()
    • SymbolTableInterface.get_symbols_by_type()
    • SymbolTableInterface.get_type()
    • SymbolTableInterface.get_type_class()
    • SymbolTableInterface.make_subconfig()
    • SymbolTableInterface.natives
    • SymbolTableInterface.optional_set_type_class()
    • SymbolTableInterface.set_type_class()
    • SymbolTableInterface.symbols
    • SymbolTableInterface.types
    • SymbolTableInterface.unsatisfied()