mirror of
https://github.com/volatilityfoundation/volatility3.git
synced 2026-08-23 06:42:21 +02:00
Mike Auty
64c139095f
This allows the CLI to expose options that the renderers can offer. These options are limited (string, int, bool and bytes), so no lists or choices, etc. Each renderer's options are also global options, meaning they're always present (although grouped). There's two ways of handling this: a) Prefix each option with the renderer's name, duplicate options are unique b) Deduplicate options with duplicate names and prefix 'renderer' The current choice is a) because b) might confuse people that an option which only applied to one renderer would be available for all, but comes with the inconvenience that users must adapt the option name for those that are duplicated with the same meaning. This is at least functional and extendable in the future but still a bit clunky. We could have brought the entire configuration mechanism into play, but each renderer would require a context and a config_path and so on, meaning massive overkill and a non-addition-only API change.
95 lines
3.6 KiB
Python
95 lines
3.6 KiB
Python
# This file is Copyright 2019 Volatility Foundation and licensed under the Volatility Software License 1.0
|
|
# which is available at https://www.volatilityfoundation.org/license/vsl-v1.0
|
|
#
|
|
"""Volatility 3 Constants.
|
|
|
|
Stores all the constant values that are generally fixed throughout
|
|
volatility This includes default scanning block sizes, etc.
|
|
"""
|
|
import enum
|
|
import os.path
|
|
import sys
|
|
from typing import Optional, Callable
|
|
|
|
import volatility.framework.constants.linux
|
|
import volatility.framework.constants.windows
|
|
|
|
PLUGINS_PATH = [
|
|
os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "plugins")),
|
|
os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "plugins"))
|
|
]
|
|
"""Default list of paths to load plugins from (volatility/plugins and volatility/framework/plugins)"""
|
|
|
|
SYMBOL_BASEPATHS = [
|
|
os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..", "symbols")),
|
|
os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "symbols"))
|
|
]
|
|
"""Default list of paths to load symbols from (volatility/symbols and volatility/framework/symbols)"""
|
|
|
|
ISF_EXTENSIONS = ['.json', '.json.xz', '.json.gz', '.json.bz2']
|
|
"""List of accepted extensions for ISF files"""
|
|
|
|
if hasattr(sys, 'frozen') and sys.frozen:
|
|
# Ensure we include the executable's directory as the base for plugins and symbols
|
|
PLUGINS_PATH = [os.path.abspath(os.path.join(os.path.dirname(sys.executable), 'plugins'))] + PLUGINS_PATH
|
|
SYMBOL_BASEPATHS = [os.path.abspath(os.path.join(os.path.dirname(sys.executable), 'symbols'))] + SYMBOL_BASEPATHS
|
|
|
|
BANG = "!"
|
|
"""Constant used to delimit table names from type names when referring to a symbol"""
|
|
|
|
# We use the SemVer 2.0.0 versioning scheme
|
|
VERSION_MAJOR = 2 # Number of releases of the library with a breaking change
|
|
VERSION_MINOR = 1 # Number of changes that only add to the interface
|
|
VERSION_PATCH = 0 # Number of changes that do not change the interface
|
|
VERSION_SUFFIX = "-beta.1"
|
|
|
|
PACKAGE_VERSION = ".".join([str(x) for x in [VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH]]) + VERSION_SUFFIX
|
|
"""The canonical version of the volatility package"""
|
|
|
|
AUTOMAGIC_CONFIG_PATH = 'automagic'
|
|
"""The root section within the context configuration for automagic values"""
|
|
|
|
LOGLEVEL_V = 9
|
|
"""Logging level for a single -v"""
|
|
LOGLEVEL_VV = 8
|
|
"""Logging level for -vv"""
|
|
LOGLEVEL_VVV = 7
|
|
"""Logging level for -vvv"""
|
|
LOGLEVEL_VVVV = 6
|
|
"""Logging level for -vvvv"""
|
|
|
|
CACHE_PATH = os.path.join(os.path.expanduser("~"), ".cache", "volatility3")
|
|
"""Default path to store cached data"""
|
|
|
|
if sys.platform == 'windows':
|
|
CACHE_PATH = os.path.join(os.environ.get("APPDATA", os.path.expanduser("~")), "volatility3")
|
|
os.makedirs(CACHE_PATH, exist_ok = True)
|
|
|
|
LINUX_BANNERS_PATH = os.path.join(CACHE_PATH, "linux_banners.cache")
|
|
""""Default location to record information about available linux banners"""
|
|
|
|
MAC_BANNERS_PATH = os.path.join(CACHE_PATH, "mac_banners.cache")
|
|
""""Default location to record information about available mac banners"""
|
|
|
|
BUG_URL = "https://github.com/volatilityfoundation/volatility3/issues"
|
|
|
|
ProgressCallback = Optional[Callable[[float, str], None]]
|
|
"""Type information for ProgressCallback objects"""
|
|
|
|
|
|
class Parallelism(enum.IntEnum):
|
|
"""An enumeration listing the different types of parallelism applied to
|
|
volatility."""
|
|
Off = 0
|
|
Threading = 1
|
|
Multiprocessing = 2
|
|
|
|
|
|
PARALLELISM = Parallelism.Off
|
|
"""Default value to the parallelism setting used throughout volatility"""
|
|
|
|
ISF_MINIMUM_SUPPORTED = (2, 0, 0)
|
|
"""The minimum supported version of the Intermediate Symbol Format"""
|
|
ISF_MINIMUM_DEPRECATED = (3, 9, 9)
|
|
"""The highest version of the ISF that's deprecated (usually higher than supported)"""
|