#2689 Added C2 Sequence diagram to docs and added additional ftp_client request tests.

src/primaite/simulator/system/applications/red_applications/c2/abstract_c2.py

@@ -75,7 +75,7 @@ class AbstractC2(Application, identifier="AbstractC2"):
     keep_alive_inactivity: int = 0
     """Indicates how many timesteps since the last time the c2 application received a keep alive."""
 
-    class C2_Opts(BaseModel):
+    class _C2Opts(BaseModel):
         """A Pydantic Schema for the different C2 configuration options."""
 
         keep_alive_frequency: int = Field(default=5, ge=1)
@@ -87,7 +87,7 @@ class AbstractC2(Application, identifier="AbstractC2"):
         masquerade_port: Port = Field(default=Port.HTTP)
         """The currently chosen port that the C2 traffic is masquerading as. Defaults at HTTP."""
 
-    c2_config: C2_Opts = C2_Opts()
+    c2_config: _C2Opts = _C2Opts()
     """
     Holds the current configuration settings of the C2 Suite.
 

src/primaite/simulator/system/applications/red_applications/c2/c2_server.py

@@ -208,7 +208,7 @@ class C2Server(AbstractC2, identifier="C2Server"):
         grants more opportunity to the blue agent to prevent attacks.
 
         Additionally, future editions of primAITE may expand the C2 repertoire to allow for
-        more complex red agent behaviour such as file extraction, establishing further fall back channels
+        more complex red agent behaviour such as establishing further fall back channels
         or introduce red applications that are only installable via C2 Servers. (T1105)
 
         For more information on the impact of these commands please refer to the terminal

src/primaite/simulator/system/services/ftp/ftp_client.py

@@ -52,7 +52,7 @@ class FTPClient(FTPServiceABC):
             dest_ip = request[-1].get("dest_ip_address")
             dest_ip = None if dest_ip is None else IPv4Address(dest_ip)
 
-            # TODO: Confirm that the default values lead to a safe failure.
+            # Missing FTP Options results is an automatic failure.
             src_folder = request[-1].get("src_folder_name", None)
             src_file_name = request[-1].get("src_file_name", None)
             dest_folder = request[-1].get("dest_folder_name", None)
@@ -63,7 +63,10 @@ class FTPClient(FTPServiceABC):
                     f"{self.name}: Received a FTP Request to transfer file: {src_file_name} to Remote IP: {dest_ip}."
                 )
                 return RequestResponse(
-                    status="failure", data={"reason": "Unable to locate requested file on local file system."}
+                    status="failure",
+                    data={
+                        "reason": "Unable to locate given file on local file system. Perhaps given options are invalid?"
+                    },
                 )
 
             return RequestResponse.from_bool(