:py:mod:`dissect.target.plugins.general.scrape`
===============================================

.. py:module:: dissect.target.plugins.general.scrape


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.plugins.general.scrape.ScrapePlugin



Functions
~~~~~~~~~

.. autoapisummary::
   :nosignatures:

   dissect.target.plugins.general.scrape.read_plain_chunk



.. py:class:: ScrapePlugin(target: dissect.target.Target)


   Bases: :py:obj:`dissect.target.plugin.Plugin`

   Base class for plugins.

   Plugins can optionally be namespaced by specifying the ``__namespace__``
   class attribute. Namespacing results in your plugin needing to be prefixed
   with this namespace when being called. For example, if your plugin has
   specified ``test`` as namespace and a function called ``example``, you must
   call your plugin with ``test.example``::

   A ``Plugin`` class has the following private class attributes:

   - ``__namespace__``
   - ``__record_descriptors__``

   With the following three being assigned in :func:`register`:

   - ``__plugin__``
   - ``__functions__``
   - ``__exports__``

   Additionally, the methods and attributes of :class:`Plugin` receive more private attributes
   by using decorators.

   The :func:`export` decorator adds the following private attributes

   - ``__exported__``
   - ``__output__``: Set with the :func:`export` decorator.
   - ``__record__``: Set with the :func:`export` decorator.

   The :func:`internal` decorator and :class:`InternalPlugin` set the ``__internal__`` attribute.
   Finally. :func:`args` decorator sets the ``__args__`` attribute.

   :param target: The :class:`~dissect.target.target.Target` object to load the plugin for.

   .. py:attribute:: __namespace__
      :value: 'scrape'

      

   .. py:method:: check_compatible() -> None

      Perform a compatibility check with the target.

      This function should return ``None`` if the plugin is compatible with
      the current target (``self.target``). For example, check if a certain
      file exists.
      Otherwise it should raise an ``UnsupportedPluginError``.

      :raises UnsupportedPluginError: If the plugin could not be loaded.


   .. py:method:: find_needles(fh: BinaryIO, needles: List[bytes], block_size: int = io.DEFAULT_BUFFER_SIZE) -> Generator[Tuple[bytes, int], None, None]

      Yields needles and their offsets found in provided byte stream


   .. py:method:: find_needle_chunks(fh: BinaryIO, needle_chunk_size_map: Dict[bytes, int], block_size: int = io.DEFAULT_BUFFER_SIZE, chunk_reader: Callable[[BinaryIO, bytes, int, int], bytes] = None) -> Generator[Tuple[bytes, int, bytes], None, None]

      Yields tuples with an offset, a needle and a byte chunk found in provided byte stream.


   .. py:method:: scrape_chunks(fh: BinaryIO, needle_chunk_size_map: Dict[bytes, int], chunk_parser: Callable[[bytes, bytes], Generator], chunk_reader: Callable[[BinaryIO, bytes, int, int], bytes] = None, block_size: int = io.DEFAULT_BUFFER_SIZE) -> Generator[dissect.target.helpers.record.TargetRecordDescriptor, None, None]

      Yields records scraped from chunks found in a provided byte stream


   .. py:method:: scrape_chunks_from_disks(chunk_parser: Callable[[bytes, bytes], Generator], needle_chunk_size_map: Dict[bytes, int] = None, needle: bytes = None, chunk_size: int = None, chunk_reader: Callable[[BinaryIO, bytes, int, int], bytes] = None, block_size: int = io.DEFAULT_BUFFER_SIZE) -> Generator[dissect.target.helpers.record.TargetRecordDescriptor, None, None]

      Yields records scraped from chunks found in target.disks


   .. py:method:: scrape_needles_from_disks(needles: List[bytes] = None, needle: bytes = None, block_size: int = io.DEFAULT_BUFFER_SIZE) -> Generator[Tuple[BinaryIO, bytes, int], None, None]

      Yields bytestream / needle / offset tuples, scraped from target.disks



.. py:function:: read_plain_chunk(fh: BinaryIO, needle: bytes, offset: int, chunk_size: int) -> bytes

   Read chunk from a byte stream for provided needle, offset and chunk size