# 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
#
"""A list of potential exceptions that volatility can throw.
These include exceptions that can be thrown on errors by the symbol
space or symbol tables, and by layers when an address is invalid. The
:class:`PagedInvalidAddressException` contains information about the
size of the invalid page.
"""
from typing import Callable, Dict, Optional, Tuple
from volatility3.framework import interfaces
[docs]
class VolatilityException(Exception):
"""Class to allow filtering of all VolatilityExceptions."""
[docs]
class PluginVersionException(VolatilityException):
"""Class to allow determining that a required plugin has an invalid
version."""
[docs]
class PluginRequirementException(VolatilityException):
"""Class to allow plugins to indicate that a requirement has not been
fulfilled."""
[docs]
class SymbolError(VolatilityException):
"""Thrown when a symbol lookup has failed."""
def __init__(
self, symbol_name: Optional[str], table_name: Optional[str], *args
) -> None:
super().__init__(*args)
self.symbol_name = symbol_name
self.table_name = table_name
[docs]
class LayerException(VolatilityException):
"""Thrown when an error occurs dealing with memory and layers."""
def __init__(self, layer_name: str, *args) -> None:
super().__init__(*args)
self.layer_name = layer_name
[docs]
class InvalidAddressException(LayerException):
"""Thrown when an address is not valid in the layer it was requested."""
def __init__(self, layer_name: str, invalid_address: int, *args) -> None:
super().__init__(layer_name, *args)
self.invalid_address = invalid_address
[docs]
class PagedInvalidAddressException(InvalidAddressException):
"""Thrown when an address is not valid in the paged space in which it was
request. This is a subclass of InvalidAddressException and is only
thrown from a paged layer. In most circumstances :class:`InvalidAddressException`
is the correct exception to throw, since this will catch all invalid
mappings (including paged ones).
Includes the invalid address and the number of bits of the address
that are invalid
"""
def __init__(
self,
layer_name: str,
invalid_address: int,
invalid_bits: int,
entry: int,
*args,
) -> None:
super().__init__(layer_name, invalid_address, *args)
self.invalid_bits = invalid_bits
self.entry = entry
[docs]
class SwappedInvalidAddressException(PagedInvalidAddressException):
"""Thrown when an address is not valid in the paged layer in which it was
requested, but expected to be in an associated swap layer.
Includes the swap lookup, as well as the invalid address and the bits of
the lookup that were invalid.
"""
def __init__(
self,
layer_name: str,
invalid_address: int,
invalid_bits: int,
entry: int,
swap_offset: int,
*args,
) -> None:
super().__init__(layer_name, invalid_address, invalid_bits, entry, *args)
self.swap_offset = swap_offset
[docs]
class SymbolSpaceError(VolatilityException):
"""Thrown when an error occurs dealing with Symbolspaces and SymbolTables."""
[docs]
class UnsatisfiedException(VolatilityException):
def __init__(
self, unsatisfied: Dict[str, interfaces.configuration.RequirementInterface]
) -> None:
super().__init__()
self.unsatisfied = unsatisfied
[docs]
class MissingModuleException(VolatilityException):
def __init__(self, module: str, *args) -> None:
super().__init__(*args)
self.module = module
[docs]
class OfflineException(VolatilityException):
"""Throw when a remote resource is requested but Volatility is in offline mode"""
def __init__(self, url: str, *args) -> None:
super().__init__(*args)
self._url = url
def __str__(self):
return f"Volatility 3 is offline: unable to access {self._url}"
[docs]
class RenderException(VolatilityException):
"""Thrown if there is an error during rendering"""
[docs]
class LinuxPageCacheException(VolatilityException):
"""Thrown if there is an error during Linux Page Cache processing"""
[docs]
class VersionMismatchException(VolatilityException):
"""Thrown if a version mismatch has been encountered between two components."""
def __init__(
self,
source_component: Callable,
target_component: interfaces.configuration.VersionableInterface,
target_version: Tuple[int, int, int],
failure_reason: str = None,
*args,
):
"""
Args:
source_component: The component that required the target component
target_component: The component that is required. Must inherit from interfaces.configuration.VersionableInterface
target_version: The version of the target component that was required, and ultimately was not satisfied
failure_reason: A detailed failure reason to enhance debugging and bug tracking
"""
super().__init__(*args)
self.source_component = source_component
self.target_component = target_component
self.target_version = target_version
self.failure_reason = failure_reason
def __str__(self):
return f"{self.source_component.__module__ + '.' + self.source_component.__qualname__}: Version {self.target_version} dependency on {self.target_component.__module__ + '.' + self.target_component.__name__} {self.target_component.version} unmet."