#1816 - Updated the DataManipulationBot to subclass DatabaseClient. Extended logging. Dropped the Link loading logging as it was clogging up the terminal output.

docs/index.rst

@@ -98,6 +98,7 @@ Head over to the :ref:`getting-started` page to install and setup PrimAITE!
    source/getting_started
    source/about
    source/config
+   source/simulation
    source/primaite_session
    source/custom_agent
    PrimAITE API <source/_autosummary/primaite>

docs/source/simulation.rst

@@ -21,4 +21,5 @@ Contents
    simulation_components/network/router
    simulation_components/network/switch
    simulation_components/network/network
-   simulation_components/internal_frame_processing
+   simulation_components/system/internal_frame_processing
+   simulation_components/system/software

docs/source/simulation_components/network/network.rst

@@ -2,7 +2,7 @@
 
     © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
 
-.. _about:
+.. _network:
 
 Network
 =======

docs/source/simulation_components/network/router.rst

@@ -2,7 +2,7 @@
 
     © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
 
-.. _about:
+.. _router:
 
 Router Module
 =============

docs/source/simulation_components/system/data_manipulation_bot.rst

@@ -0,0 +1,58 @@
+.. only:: comment
+
+    © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+
+
+DataManipulationBot
+===================
+
+The ``DataManipulationBot`` class provides functionality to connect to a ``DatabaseService`` and execute malicious SQL statements.
+
+Overview
+--------
+
+The bot is intended to simulate a malicious actor carrying out attacks like:
+
+- Dropping tables
+- Deleting records
+- Modifying data
+On a database server by abusing an application's trusted database connectivity.
+
+Usage
+-----
+
+- Create an instance and call ``configure`` to set:
+  - Target database server IP
+  - Database password (if needed)
+  - SQL statement payload
+- Call ``run`` to connect and execute the statement.
+
+The bot handles connecting, executing the statement, and disconnecting.
+
+Example
+-------
+
+.. code-block:: python
+
+    client_1 = Computer(
+        hostname="client_1", ip_address="192.168.10.21", subnet_mask="255.255.255.0", default_gateway="192.168.10.1"
+    )
+    client_1.power_on()
+    network.connect(endpoint_b=client_1.ethernet_port[1], endpoint_a=switch_2.switch_ports[1])
+    client_1.software_manager.install(DataManipulationBot)
+    data_manipulation_bot: DataManipulationBot = client_1.software_manager.software["DataManipulationBot"]
+    data_manipulation_bot.configure(server_ip_address=IPv4Address("192.168.1.14"), payload="DROP TABLE IF EXISTS user;")
+    data_manipulation_bot.run()
+
+This would connect to the database service at 192.168.1.14, authenticate, and execute the SQL statement to drop the 'users' table.
+
+Implementation
+--------------
+
+The bot extends ``DatabaseClient`` and leverages its connectivity.
+
+- Uses the Application base class for lifecycle management.
+- Credentials and target IP set via ``configure``.
+- ``run`` handles connecting, executing statement, and disconnecting.
+- SQL payload executed via ``query`` method.
+- Results in malicious SQL being executed on remote database server.

docs/source/simulation_components/system/internal_frame_processing.rst

@@ -2,7 +2,7 @@
 
     © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
 
-.. _about:
+.. _internal_frame_processing:
 
 Internal Frame Processing
 =========================

docs/source/simulation_components/system/software.rst

@@ -16,3 +16,4 @@ Contents
    :maxdepth: 8
 
    database_client_server
+   data_manipulation_bot