From fcbde31dad1722bd98ba0a8f49f9239c4f649200 Mon Sep 17 00:00:00 2001 From: Charlie Crane Date: Thu, 5 Sep 2024 11:23:52 +0100 Subject: [PATCH] #2837 - Actioning review comments and fixing a bug with links to the common attributes within software documents --- .../system/applications/c2_suite.rst | 16 ++++++++-------- .../applications/data_manipulation_bot.rst | 2 +- .../system/applications/database_client.rst | 2 +- .../system/applications/dos_bot.rst | 2 +- .../system/applications/ransomware_script.rst | 2 +- .../system/applications/web_browser.rst | 2 +- .../system/common/common_configuration.rst | 2 +- .../system/services/database_service.rst | 2 +- .../system/services/dns_client.rst | 2 +- .../system/services/dns_server.rst | 2 +- .../system/services/ftp_client.rst | 2 +- .../system/services/ftp_server.rst | 2 +- .../system/services/ntp_client.rst | 2 +- .../system/services/ntp_server.rst | 2 +- .../system/services/terminal.rst | 4 ++-- .../system/services/web_server.rst | 2 +- 16 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/source/simulation_components/system/applications/c2_suite.rst b/docs/source/simulation_components/system/applications/c2_suite.rst index 3e2b669c..fd9ee546 100644 --- a/docs/source/simulation_components/system/applications/c2_suite.rst +++ b/docs/source/simulation_components/system/applications/c2_suite.rst @@ -59,7 +59,7 @@ Once installed and configured; the C2 beacon can establish connection with the C This will send an initial ``keep alive`` to the given C2 Server (The C2 Server IPv4Address must be given upon C2 Beacon configuration). Which is then resolved and responded by another ``Keep Alive`` by the C2 server back to the C2 beacon to confirm connection. -The C2 Beacon will send out periodic keep alive based on it's configuration parameters to configure it's active connection with the C2 server. +The C2 Beacon will send out periodic keep alive based on its configuration parameters to configure it's active connection with the C2 server. It's recommended that a C2 Beacon is installed and configured mid episode by a Red Agent for a more cyber realistic simulation. @@ -254,12 +254,6 @@ Via Configuration C2 Beacon Configuration ======================= -``Common Attributes`` -""""""""""""""""""""" - -See :ref:`Common Configuration` - - ``c2_server_ip_address`` """""""""""""""""""""""" @@ -308,12 +302,18 @@ This must be a string i.e ``DNS``. Defaults to ``HTTP``. *Please refer to the ``IPProtocol`` class for further reference.* +``Common Attributes`` +^^^^^^^^^^^^^^^^^^^^^ + +See :ref:`Common Configuration` + + C2 Server Configuration ======================= *The C2 Server does not currently offer any unique configuration options and will configure itself to match the C2 beacon's network behaviour.* ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/applications/data_manipulation_bot.rst b/docs/source/simulation_components/system/applications/data_manipulation_bot.rst index ade46d3a..1a387514 100644 --- a/docs/source/simulation_components/system/applications/data_manipulation_bot.rst +++ b/docs/source/simulation_components/system/applications/data_manipulation_bot.rst @@ -201,6 +201,6 @@ The chance of the ``DataManipulationBot`` to succeed with a data manipulation at This must be a float value between ``0`` and ``1``. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/applications/database_client.rst b/docs/source/simulation_components/system/applications/database_client.rst index 4a5e17c2..1fea78ab 100644 --- a/docs/source/simulation_components/system/applications/database_client.rst +++ b/docs/source/simulation_components/system/applications/database_client.rst @@ -106,6 +106,6 @@ Optional. Default value is ``None``. The password that the ``DatabaseClient`` will use to access the :ref:`DatabaseService`. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/applications/dos_bot.rst b/docs/source/simulation_components/system/applications/dos_bot.rst index bf7b1037..6ad45424 100644 --- a/docs/source/simulation_components/system/applications/dos_bot.rst +++ b/docs/source/simulation_components/system/applications/dos_bot.rst @@ -158,6 +158,6 @@ The maximum number of sessions the ``DoSBot`` is able to make. This must be an integer value equal to or greater than ``0``. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/applications/ransomware_script.rst b/docs/source/simulation_components/system/applications/ransomware_script.rst index db5be2ed..5bff6991 100644 --- a/docs/source/simulation_components/system/applications/ransomware_script.rst +++ b/docs/source/simulation_components/system/applications/ransomware_script.rst @@ -81,6 +81,6 @@ IP address of the :ref:`DatabaseService` which the ``RansomwareScript`` will enc This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/applications/web_browser.rst b/docs/source/simulation_components/system/applications/web_browser.rst index b0466ad1..c56c450d 100644 --- a/docs/source/simulation_components/system/applications/web_browser.rst +++ b/docs/source/simulation_components/system/applications/web_browser.rst @@ -108,6 +108,6 @@ The domain ``arcd.com`` can be matched by ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/common/common_configuration.rst b/docs/source/simulation_components/system/common/common_configuration.rst index 73971b37..7b32a463 100644 --- a/docs/source/simulation_components/system/common/common_configuration.rst +++ b/docs/source/simulation_components/system/common/common_configuration.rst @@ -5,7 +5,7 @@ .. _Common Configuration: Common Configuration --------------------- +"""""""""""""""""""" ref """ diff --git a/docs/source/simulation_components/system/services/database_service.rst b/docs/source/simulation_components/system/services/database_service.rst index f1b617e6..f3e800cd 100644 --- a/docs/source/simulation_components/system/services/database_service.rst +++ b/docs/source/simulation_components/system/services/database_service.rst @@ -111,6 +111,6 @@ Optional. Default value is ``None``. The password that needs to be provided by connecting clients in order to create a successful connection. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/dns_client.rst b/docs/source/simulation_components/system/services/dns_client.rst index 17fe0219..eca152f0 100644 --- a/docs/source/simulation_components/system/services/dns_client.rst +++ b/docs/source/simulation_components/system/services/dns_client.rst @@ -95,6 +95,6 @@ The IP Address of the :ref:`DNSServer`. This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/dns_server.rst b/docs/source/simulation_components/system/services/dns_server.rst index 0b6acb01..1e30b9bd 100644 --- a/docs/source/simulation_components/system/services/dns_server.rst +++ b/docs/source/simulation_components/system/services/dns_server.rst @@ -94,6 +94,6 @@ If the domain is "arcd.com" and the IP Address attributed to the domain is 192.1 The key must be a string and the IP Address must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/ftp_client.rst b/docs/source/simulation_components/system/services/ftp_client.rst index 265a03ea..c8a21743 100644 --- a/docs/source/simulation_components/system/services/ftp_client.rst +++ b/docs/source/simulation_components/system/services/ftp_client.rst @@ -84,6 +84,6 @@ Configuration ============= ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/ftp_server.rst b/docs/source/simulation_components/system/services/ftp_server.rst index 9b068d68..f52fa043 100644 --- a/docs/source/simulation_components/system/services/ftp_server.rst +++ b/docs/source/simulation_components/system/services/ftp_server.rst @@ -89,6 +89,6 @@ Optional. Default value is ``None``. The password that needs to be provided by a connecting :ref:`FTPClient` in order to create a successful connection. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/ntp_client.rst b/docs/source/simulation_components/system/services/ntp_client.rst index 8096a4fe..7af831bf 100644 --- a/docs/source/simulation_components/system/services/ntp_client.rst +++ b/docs/source/simulation_components/system/services/ntp_client.rst @@ -90,6 +90,6 @@ The IP address of an NTP Server which provides a time that the ``NTPClient`` can This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``. ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/ntp_server.rst b/docs/source/simulation_components/system/services/ntp_server.rst index f2bb6684..a09c8bdd 100644 --- a/docs/source/simulation_components/system/services/ntp_server.rst +++ b/docs/source/simulation_components/system/services/ntp_server.rst @@ -77,6 +77,6 @@ Via Configuration ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/terminal.rst b/docs/source/simulation_components/system/services/terminal.rst index c319d264..6909786e 100644 --- a/docs/source/simulation_components/system/services/terminal.rst +++ b/docs/source/simulation_components/system/services/terminal.rst @@ -36,7 +36,7 @@ Implementation Usage """"" - - Pre-Installs on all ``Node`` (with the exception of ``Switch``). + - Pre-Installs on all ``Nodes`` (with the exception of ``Switches``). - Terminal Clients connect, execute commands and disconnect from remote nodes. - Ensures that users are logged in to the component before executing any commands. - Service runs on SSH port 22 by default. @@ -176,6 +176,6 @@ Disconnect from Remote Node ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration` diff --git a/docs/source/simulation_components/system/services/web_server.rst b/docs/source/simulation_components/system/services/web_server.rst index 04b9b16a..cec20a60 100644 --- a/docs/source/simulation_components/system/services/web_server.rst +++ b/docs/source/simulation_components/system/services/web_server.rst @@ -77,6 +77,6 @@ Via Configuration ``Common Attributes`` -""""""""""""""""""""" +^^^^^^^^^^^^^^^^^^^^^ See :ref:`Common Configuration`