volatility3.plugins.windows.netscan module¶
-
class
NetScan
(context, config_path, progress_callback=None)[source]¶ Bases:
volatility3.framework.interfaces.plugins.PluginInterface
,volatility3.plugins.timeliner.TimeLinerInterface
Scans for network objects present in a particular windows memory image.
- Parameters
-
build_configuration
()¶ Constructs a HierarchicalDictionary of all the options required to build this component in the current context.
Ensures that if the class has been created, it can be recreated using the configuration built Inheriting classes must override this to ensure any dependent classes update their configurations too
- Return type
-
property
config
¶ The Hierarchical configuration Dictionary for this Configurable object.
- Return type
-
property
context
¶ The context object that this configurable belongs to/configuration is stored in.
- Return type
-
static
create_netscan_constraints
(context, symbol_table)[source]¶ Creates a list of Pool Tag Constraints for network objects.
- Parameters
context (
ContextInterface
) – The context to retrieve required elements (layers, symbol tables) fromsymbol_table (
str
) – The name of an existing symbol table containing the symbols / types
- Return type
- Returns
The list containing the built constraints.
-
classmethod
create_netscan_symbol_table
(context, layer_name, nt_symbol_table, config_path)[source]¶ Creates a symbol table for TCP Listeners and TCP/UDP Endpoints.
- Parameters
context (
ContextInterface
) – The context to retrieve required elements (layers, symbol tables) fromlayer_name (
str
) – The name of the layer on which to operatent_symbol_table (
str
) – The name of the table containing the kernel symbolsconfig_path (
str
) – The config path where to find symbol files
- Return type
- Returns
The name of the constructed symbol table
-
classmethod
determine_tcpip_version
(context, layer_name, nt_symbol_table)[source]¶ Tries to determine which symbol filename to use for the image’s tcpip driver. The logic is partially taken from the info plugin.
- Parameters
context (
ContextInterface
) – The context to retrieve required elements (layers, symbol tables) fromlayer_name (
str
) – The name of the layer on which to operatent_symbol_table (
str
) – The name of the table containing the kernel symbols
- Return type
- Returns
The filename of the symbol table to use.
-
generate_timeline
()[source]¶ Method generates Tuples of (description, timestamp_type, timestamp)
These need not be generated in any particular order, sorting will be done later
-
classmethod
make_subconfig
(context, base_config_path, **kwargs)¶ Convenience function to allow constructing a new randomly generated sub-configuration path, containing each element from kwargs.
- Parameters
context (
ContextInterface
) – The context in which to store the new configurationbase_config_path (
str
) – The base configuration path on which to build the new configurationkwargs – Keyword arguments that are used to populate the new configuration path
- Returns
The newly generated full configuration path
- Return type
-
property
open
¶ Returns a context manager and thus can be called like open
-
run
()[source]¶ Executes the functionality of the code.
Note
This method expects self.validate to have been called to ensure all necessary options have been provided
- Returns
A TreeGrid object that can then be passed to a Renderer.
-
classmethod
scan
(context, layer_name, nt_symbol_table, netscan_symbol_table)[source]¶ Scans for network objects using the poolscanner module and constraints.
- Parameters
context (
ContextInterface
) – The context to retrieve required elements (layers, symbol tables) fromlayer_name (
str
) – The name of the layer on which to operatent_symbol_table (
str
) – The name of the table containing the kernel symbolsnetscan_symbol_table (
str
) – The name of the table containing the network object symbols (_TCP_LISTENER etc.)
- Return type
- Returns
A list of network objects found by scanning the layer_name layer for network pool signatures
-
classmethod
unsatisfied
(context, config_path)¶ Returns a list of the names of all unsatisfied requirements.
Since a satisfied set of requirements will return [], it can be used in tests as follows:
unmet = configurable.unsatisfied(context, config_path) if unmet: raise RuntimeError("Unsatisfied requirements: {}".format(unmet)
- Return type
-
version
= (1, 0, 0)¶