volatility3/volatility/framework/interfaces/layers.py

"""
Created on 4 May 2013

@author: mike
"""
import collections
from abc import ABCMeta, abstractmethod, abstractproperty

from volatility.framework import exceptions, validity
from volatility.framework.interfaces import configuration, context


class ScannerInterface(validity.ValidityRoutines, metaclass = ABCMeta):
    """Class for layer scanners that return locations of particular values from within the data

    These are designed to be given a chunk of data and return a generator which yields
    any found items.  They should NOT perform complex/time-consuming tasks, these should
    be carried out by the consumer of the generator on the items returned.

    They will be provided all *available* data (therefore not necessarily contiguous)
    in ascending offset order, in chunks no larger than chunk_size + overlap where
    overlap is the amount of data read twice once at the end of an earlier chunk and
    once at the start of the next chunk.

    It should be noted that the scanner can maintain state if necessary.
    Scanners should balance the size of chunk based on the amount of time
    scanning the chunk will take (ie, do not set an excessively large chunksize
    and try not to take a significant amount of time in the __call__ method).
    """

    def __init__(self):
        self.chunk_size = 0x1000000  # Default to 16Mb chunks
        self.overlap = 0x1000  # A page of overlap by default
        self._context = None
        self._layer_name = None

    @property
    def context(self):
        return self._context

    @context.setter
    def context(self, ctx):
        """Stores the context locally in case the scanner needs to access the layer"""
        self._context = self._check_type(ctx, context.ContextInterface)

    @property
    def layer_name(self):
        return self._layer_name

    @layer_name.setter
    def layer_name(self, layer_name):
        """Stores the layer_name being scanned locally in case the scanner needs to access the layer"""
        self._layer_name = self._check_type(layer_name, str)

    @abstractmethod
    def __call__(self, data, data_offset):
        """Searches through a chunk of data for a particular value/pattern/etc
           Always returns an iterator of the same type of object (need not be a volatility object)

           data is the chunk of data to search through
           data_offset is the offset within the layer that the data being searched starts at
        """


class DataLayerInterface(configuration.ConfigurableInterface, validity.ValidityRoutines, metaclass = ABCMeta):
    """A Layer that directly holds data (and does not translate it"""

    provides = {"type": "interface"}

    def __init__(self, context, config_path, name):
        super().__init__(context, config_path)
        self._check_type(name, str)
        self._name = name

    @property
    def name(self):
        """Returns the layer name"""
        return self._name

    @abstractproperty
    def maximum_address(self):
        """Returns the maximum valid address of the space"""

    @abstractproperty
    def minimum_address(self):
        """Returns the minimum valid address of the space"""

    @abstractmethod
    def is_valid(self, offset, length = 1):
        """Returns a boolean based on whether the offset is valid or not"""

    @abstractmethod
    def read(self, offset, length, pad = False):
        """Reads an offset for length bytes and returns 'bytes' (not 'str') of length size

           If there is a fault of any kind (such as a page fault), an exception will be thrown
           unless pad is set, in which case the read errors will be replaced by null characters.
        """

    @abstractmethod
    def write(self, offset, data):
        """Writes a chunk of data at offset.

           Any unavailable sections in the underlying bases will cause an exception to be thrown.
           Note: Writes are not atomic, therefore some data can be written, even if an exception is thrown.
        """

    def destroy(self):
        """Allows DataLayers to close any open handles, etc.

           Systems that make use of Data Layers should called destroy when they are done with them.
           This will close all handles, and make the object unreadable
           (exceptions will be thrown using a DataLayer after destruction)"""
        pass

    @classmethod
    def get_requirements(cls):
        """Returns a list of Requirement objects for this type of layer"""
        return []

    def _pre_scan(self, context, min_address, max_address, progress_callback, scanner):
        """Prepares the scanner based on standard procedures shared between TranslationLayers and DataLayers"""
        if progress_callback is not None:
            self._check_type(progress_callback, collections.Callable)

        scanner = self._check_type(scanner, ScannerInterface)
        scanner.context = context
        scanner.layer_name = self.name

        if min_address is None:
            min_address = self.minimum_address
        if max_address is None:
            max_address = self.maximum_address

        min_address = min(self.minimum_address, min_address)
        max_address = max(self.maximum_address, max_address)
        total_size = (max_address - min_address)
        return min_address, max_address, scanner, total_size

    def scan(self, context, scanner, progress_callback = None, min_address = None, max_address = None):
        """Scans the layer using scanner, between min_address and max_address calling progress_callback at internvals to report percentage progress"""
        min_address, max_address, scanner, total_size = self._pre_scan(context, min_address, max_address,
                                                                       progress_callback, scanner)

        for offset in range(min_address, max_address, scanner.chunk_size):
            length = min(scanner.chunk_size + scanner.overlap, max_address - offset)
            chunk = self.read(offset, length)
            if progress_callback:
                progress_callback((offset * 100) / total_size)
            for x in scanner(chunk, offset):
                yield x


class TranslationLayerInterface(DataLayerInterface, metaclass = ABCMeta):
    # Unfortunately class attributes can't easily be inheritted from parent classes
    provides = {"type": "interface"}

    @abstractmethod
    def mapping(self, offset, length, ignore_errors = False):
        """Returns a sorted iterable of (offset, mapped_offset, length, layer) mappings

           ignore_errors will provide all available maps with gaps, but their total length may not add up to the requested length
           This allows translation layers to provide maps of contiguous regions in one layer
        """
        return []

    @property
    @abstractmethod
    def dependencies(self):
        """Returns a list of layer names that this layer translates onto"""
        return []

    # ## Read/Write functions for mapped pages

    def read(self, offset, length, pad = False):
        """Reads an offset for length bytes and returns 'bytes' (not 'str') of length size"""
        current_offset = offset
        output = []
        for (offset, mapped_offset, length, layer) in self.mapping(offset, length, ignore_errors = pad):
            if not pad and offset > current_offset:
                raise exceptions.InvalidAddressException(self.name, current_offset,
                                                         "Layer " + self.name + " cannot map offset " +
                                                         str(current_offset))
            elif offset > current_offset:
                output += [b"\x00" * (current_offset - offset)]
                current_offset = offset
            elif offset < current_offset:
                raise exceptions.LayerException("Mapping returned an overlapping element")
            output += [self._context.memory.read(layer, mapped_offset, length, pad)]
            current_offset += length
        recovered_data = b"".join(output)
        return recovered_data + b"\x00" * (length - len(recovered_data))

    def write(self, offset, value):
        """Writes a value at offset, distributing the writing across any underlying mapping"""
        current_offset = offset
        length = len(value)
        for (offset, mapped_offset, length, layer) in self.mapping(offset, length):
            if offset > current_offset:
                raise exceptions.InvalidAddressException(self.name, current_offset,
                                                         "Layer " + self.name + " cannot map offset " +
                                                         str(current_offset))
            elif offset < current_offset:
                raise exceptions.LayerException("Mapping returned an overlapping element")
            self._context.memory.write(layer, mapped_offset, length)
            current_offset += length

    def scan(self, context, scanner, progress_callback = None, min_address = None, max_address = None):
        """Scans a Translation layer by chunk

           Note: this will skip missing/unmappable chunks of memory
        """
        min_address, max_address, scanner, total_size = self._pre_scan(context, min_address, max_address,
                                                                       progress_callback, scanner)

        progress = 0
        for block in range(min_address, total_size, scanner.chunk_size):
            for map in self.mapping(block, scanner.chunk_size + scanner.overlap, ignore_errors = True):
                offset, mapped_offset, length, layer = map
                chunk = self._context.memory.read(layer, mapped_offset, length)
                if progress_callback:
                    progress += length
                    progress_callback(progress / total_size)
                for x in scanner(chunk, offset):
                    yield x