volatility3.cli.volshell package

class VolShell[source]

Bases: CommandLine

Program to allow interactive interaction with a memory image.

This allows a memory image to be examined through an interactive python terminal with all the volatility support calls available.

CLI_NAME = '__main__.py'
file_handler_class_factory(direct=True)
load_system_defaults(filename)

Modify the main configuration based on the default configuration override

Return type:

Tuple[List[Tuple[int, str]], Dict[str, Any]]

classmethod location_from_file(filename)

Returns the URL location from a file parameter (which may be a URL)

Parameters:

filename (str) – The path to the file (either an absolute, relative, or URL path)

Return type:

str

Returns:

The URL for the location of the file

order_extra_verbose_levels()
populate_config(context, configurables_list, args, plugin_config_path)

Populate the context config based on the returned args.

We have already determined these elements must be descended from ConfigurableInterface

Parameters:

  • context (ContextInterface) – The volatility3 context to operate on

  • configurables_list (Dict[str, Type[ConfigurableInterface]]) – A dictionary of configurable items that can be configured on the plugin

  • args (Namespace) – An object containing the arguments necessary

  • plugin_config_path (str) – The path within the context’s config containing the plugin’s configuration

Return type:

None

populate_requirements_argparse(parser, configurable)

Adds the plugin’s simple requirements to the provided parser.

Parameters:

  • parser (Union[ArgumentParser, _ArgumentGroup]) – The parser to add the plugin’s (simple) requirements to

  • configurable (Type[ConfigurableInterface]) – The plugin object to pull the requirements from

process_exceptions(excp)

Provide useful feedback if an exception occurs during a run of a plugin.

process_unsatisfied_exceptions(excp)

Provide useful feedback if an exception occurs during requirement fulfillment.

run()[source]

Executes the command line module, taking the system arguments, determining the plugin to run and then running it.

classmethod setup_logging()
main()[source]

A convenience function for constructing and running the CommandLine’s run method.

Submodules