:py:mod:`dissect.target.loaders.profile`
========================================

.. py:module:: dissect.target.loaders.profile


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

Classes
~~~~~~~

.. autoapisummary::

   dissect.target.loaders.profile.ProfileLoader
   dissect.target.loaders.profile.ProfileOSPlugin




.. py:class:: ProfileLoader(path, **kwargs)


   Bases: :py:obj:`dissect.target.loader.Loader`

   Load NTUSER.DAT files.

   .. py:method:: detect(path)
      :staticmethod:

      Detects wether this ``Loader`` class can load this specific ``path``.

      :param path: The target path to check.

      :returns: ``True`` if the ``path`` can be loaded by a ``Loader`` instance. ``False`` otherwise.


   .. py:method:: map(target)

      Maps the loaded path into a ``Target``.

      :param target: The target that we're mapping into.



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


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

   Base class for OS plugins.

   This provides a base class for certain common functions of OS's, which each OS plugin has to implement separately.

   For example, it provides an interface for retrieving the hostname and users of a target.

   All derived classes MUST implement ALL the classmethods and exported
   methods with the same ``@classmethod`` or ``@export(...)`` annotation.

   .. py:method:: detect(target)
      :classmethod:

      Provide detection of this OSPlugin on a given filesystem.

      :param fs: :class:`~dissect.target.filesystem.Filesystem` to detect the OS on.

      :returns: The root filesystem / sysvol when found.


   .. py:method:: create(target, sysvol)
      :classmethod:

      Initiate this OSPlugin with the given target and detected filesystem.

      :param target: The :class:`~dissect.target.target.Target` object.
      :param sysvol: The filesystem that was detected in the ``detect()`` function.

      :returns: An instantiated version of the OSPlugin.


   .. py:method:: hostname()

      Return the target's hostname.

      :returns: The hostname as string.


   .. py:method:: ips()

      Return the IP addresses configured in the target.

      :returns: The IPs as list.


   .. py:method:: version()

      Return the target's OS version.

      :returns: The OS version as string.


   .. py:method:: users()

      Return the users available in the target.

      :returns: A list of user records.


   .. py:method:: os()

      Return a slug of the target's OS name.

      :returns: A slug of the OS name, e.g. 'windows' or 'linux'.