.. _config_main:

Main
====

The main configuration is defined in the ``[Dementor]`` section. This section is
responsible for enabling protocol servers and configuring additional protocols.
Each server can be enabled or disabled **within the configuration file** using
values that can be interpreted as booleans, such as ``true``, ``false``, ``1``,
``"on"``, or ``"off"``. for more information on the Python side of this
configuration, refer to :class:`~dementor.config.SessionConfig`.


Section ``[Dementor]``
----------------------

.. py:currentmodule:: Dementor

.. py:attribute:: Workspace
    :type: str
    :value: "~/.dementor/"

    *Maps to* :attr:`config.SessionConfig.workspace_path`

    Specifies the directory where the database is stored and where additional modules
    can be placed. By default, this path points to ``~/.dementor`` in the user's home
    directory. For guidance on how to include custom protocols, refer to
    `Array Tables <https://toml.io/en/v1.0.0#array-of-tables>`_.


.. py:attribute:: ExtraModules
    :type: list[str]

    *Maps to* :attr:`config.SessionConfig.extra_modules`

    A list of directories containing custom protocol modules. For instructions on
    including additional protocols, see :ref:`howto_custom_protocol`. The loading
    mechanism and its priorities are described in :class:`~dementor.loader.ProtocolLoader`.

Poisoners
^^^^^^^^^

The following options control servers that perform poisoning in the local network:

.. py:attribute:: LLMNR
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.llmnr_enbled`

    Enables or disables LLMNR multicast poisoning. Valid values must be convertible
    to boolean types as described above. Protocol-specific configuration is available
    in :ref:`config_llmnr_sectioncfg`.

.. py:attribute:: mDNS
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.mdns_enbled`

    Enables or disables mDNS multicast poisoning. For mDNS protocol configuration
    details, see :ref:`config_mdns_sectioncfg`.

.. py:attribute:: NBTNS
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.nbtns_enbled`

    Enables or disables NetBIOS Name Service (NBT-NS) poisoning. For further
    configuration options, see :ref:`config_netbios_sectioncfg`.

.. py:attribute:: SSRP
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.ssrp_enabled`

    .. versionadded:: 1.0.0.dev4

    Enables or disables the SSRP (MSSQL Browser) poisoner. For more details, refer to :ref:`config_ssrp`.


Services
^^^^^^^^

The following settings apply to protocol-specific servers that do not perform active
attacks, but instead passively capture credentials:

.. py:attribute:: SMTP
                  SMB
                  NBTDS
                  FTP
                  KDC
                  LDAP
                  QUIC
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.XXX_enbled` *(lowercase)*

    Enables or disables the specified protocol service. For details on each protocol,
    refer to the respective documentation section. (Note: ``KDC`` corresponds to the
    Kerberos service).


.. py:attribute:: HTTP
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.http_enbled`

    .. versionadded:: 1.0.0.dev1

    Enables or disables configured HTTP servers. For more details, refer to :ref:`config_http`.


.. py:attribute:: RPC
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.rpc_enabled`

    .. versionadded:: 1.0.0.dev2

    .. versionchanged:: 1.0.0.dev10
        Modified naming scheme from ``msrpc`` to ``rcp`` (Python side only)

    Enables or disables the DCE/RPC service. For more details, refer to :ref:`config_dcerpc`.


.. py:attribute:: WinRM
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.winrm_enabled`

    .. versionadded:: 1.0.0.dev3

    Enables or disables the WinRM service. For more details, refer to :ref:`config_winrm`.
    Configuration is the same as described in :ref:`config_http`.


.. py:attribute:: MSSQL
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.mssql_enabled`

    .. versionadded:: 1.0.0.dev4

    Enables or disables the MSSQL service. For more details, refer to :ref:`config_mssql`.


.. py:attribute:: POP3
                  IMAP
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.xxx_enabled`

    .. versionadded:: 1.0.0.dev5

    Enables or disables the OPO3/IMAP service. For more details, refer to :ref:`config_pop3`
    or :ref:`config_imap`.


.. py:attribute:: MySQL
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.mysql_enabled`

    .. versionadded:: 1.0.0.dev7

    Enables or disables the MSSQL service. For more details, refer to :ref:`config_mysql`.


.. py:attribute:: X11
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.x11_enabled`

    .. versionadded:: 1.0.0.dev9

    Enables or disables X11 servers based on the configured port range. For more details,
    refer to :ref:`config_x11`.


.. py:attribute:: IPP
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.ipp_enabled`

    .. versionadded:: 1.0.0.dev10

    Enables or disables the IPP service. For more details, refer to :ref:`config_ipp`.


.. py:attribute:: SSDP
                  UPnP
    :type: bool
    :value: true

    *Maps to* :attr:`config.SessionConfig.xxx_enabled`

    .. versionadded:: 1.0.0.dev11

    Enables or disables the SSDP poisoning with a UPnP web service. For more details, refer
    to :ref:`config_ssdp` and :ref:`config_upnp`.