From f5cfaeedab633498274bbc05e34679dea19fec7a Mon Sep 17 00:00:00 2001
From: Archer Bowen <Archer.Bowen@t-s.qinetiq.com>
Date: Fri, 21 Feb 2025 14:57:48 +0000
Subject: [PATCH] #3075 Cleaned up yaml snippets that were rendering as a
 strings. It seems that adding '...' to yaml snippets seems to end up causing
 the snippets to render as strings rather than actual yaml.

---
 ...ommand-and-Control-E2E-Demonstration.ipynb | 66 ++++++++-----------
 1 file changed, 28 insertions(+), 38 deletions(-)

diff --git a/src/primaite/notebooks/Command-and-Control-E2E-Demonstration.ipynb b/src/primaite/notebooks/Command-and-Control-E2E-Demonstration.ipynb
index 6dc8e077..f187c8d5 100644
--- a/src/primaite/notebooks/Command-and-Control-E2E-Demonstration.ipynb
+++ b/src/primaite/notebooks/Command-and-Control-E2E-Demonstration.ipynb
@@ -120,6 +120,9 @@
     "          options:\n",
     "            node_name: web_server\n",
     "            c2_server_ip_address: 192.168.10.21\n",
+    "            keep_alive_frequency: 10\n",
+    "            masquerade_protocol: tcp\n",
+    "            masquerade_port: dns\n",
     "        9:\n",
     "          action: configure-c2-beacon\n",
     "          options:\n",
@@ -235,23 +238,18 @@
     "The yaml snippet below shows all the relevant agent options for this action:\n",
     "\n",
     "```yaml\n",
+    "\n",
     "    action_space:\n",
-    "      options:\n",
-    "        nodes: # Node List\n",
-    "          - node_name: web_server\n",
-    "        ...\n",
-    "    ...\n",
     "      action_map:\n",
-    "        ...\n",
     "        2:\n",
     "          action: configure-c2-beacon\n",
     "          options:\n",
-    "            node_id: 0 # Node Index\n",
-    "            config: # Further information about these config options can be found at the bottom of this notebook.\n",
-    "              c2_server_ip_address: 192.168.10.21\n",
-    "              keep_alive_frequency:\n",
-    "              masquerade_protocol:\n",
-    "              masquerade_port:\n",
+    "            node_name: web_server\n",
+    "            c2_server_ip_address: 192.168.10.21 # Further information about these config options can be found at the bottom of this notebook.\n",
+    "            keep_alive_frequency:\n",
+    "            masquerade_protocol:\n",
+    "            masquerade_port:\n",
+    "\n",
     "```"
    ]
   },
@@ -279,20 +277,12 @@
     "\n",
     "```yaml\n",
     "    action_space:\n",
-    "      options:\n",
-    "        nodes: # Node List\n",
-    "          - node_name: web_server\n",
-    "              applications: \n",
-    "              - application_name: c2-beacon\n",
-    "        ...\n",
-    "    ...\n",
     "      action_map:\n",
-    "        ...\n",
     "        3:\n",
     "          action: node-application-execute\n",
     "          options:\n",
-    "            node_id: 0\n",
-    "            application_id: 0\n",
+    "            node_name: web_server\n",
+    "            application_name: c2-beacon\n",
     "```"
    ]
   },
@@ -346,7 +336,6 @@
     "``` yaml\n",
     "    action_space:\n",
     "        action_map:\n",
-    "          ...\n",
     "           4:\n",
     "            action: c2-server-terminal-command\n",
     "            options:\n",
@@ -396,14 +385,12 @@
     "``` yaml\n",
     "    action_space:\n",
     "        action_map:\n",
-    "          ...\n",
     "           5:\n",
     "            action: c2-server-ransomware-configure\n",
     "            options:\n",
-    "              node_id: 1\n",
-    "              config:\n",
-    "                server_ip_address: 192.168.1.14\n",
-    "                payload: ENCRYPT\n",
+    "              node_name: client_1\n",
+    "              server_ip_address: 192.168.1.14\n",
+    "              payload: ENCRYPT\n",
     "```\n"
    ]
   },
@@ -442,7 +429,6 @@
     "``` yaml\n",
     "    action_space:\n",
     "        action_map:\n",
-    "          ...\n",
     "           6:\n",
     "            action: c2-server-data-exfiltrate\n",
     "            options:\n",
@@ -451,7 +437,7 @@
     "              target_folder_name: \"database\"\n",
     "              exfiltration_folder_name: \"spoils\"\n",
     "              target_ip_address: \"192.168.1.14\"\n",
-    "              username: \"admin\",\n",
+    "              username: \"admin\"\n",
     "              password: \"admin\"\n",
     "\n",
     "```"
@@ -500,7 +486,6 @@
     "\n",
     "``` yaml\n",
     "    action_space:\n",
-    "        ...\n",
     "        action_map:\n",
     "           7:\n",
     "            action: c2-server-ransomware-launch\n",
@@ -1313,13 +1298,18 @@
    "source": [
     "As demonstrated earlier, red agents can use the ``configure-c2-beacon`` action to configure these settings mid episode through the configuration options:\n",
     "\n",
-    "``` YAML\n",
-    "...\n",
-    "    action: configure-c2-beacon\n",
-    "        options:\n",
-    "        node_name: web_server\n",
-    "        config:\n",
+    "```YAML\n",
+    "\n",
+    "    action_space:\n",
+    "      action_map:\n",
+    "        8:\n",
+    "          action: configure-c2-beacon\n",
+    "          options:\n",
+    "            node_name: web_server\n",
     "            c2_server_ip_address: 192.168.10.21\n",
+    "            keep_alive_frequency: 10\n",
+    "            masquerade_protocol: tcp\n",
+    "            masquerade_port: dns\n",
     "```"
    ]
   },
@@ -1684,7 +1674,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": ".venv",
    "language": "python",
    "name": "python3"
   },