Feature pause

docs/source/basic.rst

@@ -7,7 +7,7 @@ AttackMate ships with a executable stub called "attackmate" that can be called l
 ::
 
    attackmate -h
-   usage: attackmate [-h] --config CONFIG [--debug] [--version]
+   usage: attackmate [-h] --config CONFIG [--debug] [--version] [--json] [--append_logs]
 
    AttackMate is an attack orchestration tool that executes full attack-chains based on playbooks.
 
@@ -17,6 +17,7 @@ AttackMate ships with a executable stub called "attackmate" that can be called l
      --debug          Enable verbose output
      --version        show program's version number and exit
      --json           log commands to attackmate.json
+     --append_logs    append logs to attackmate.log, output.log and attackmate.json instead of overwriting
 
    (Austrian Institute of Technology) https://aecid.ait.ac.at Version: 0.2.0
 

docs/source/playbook/commands/debug.rst

@@ -39,4 +39,12 @@ purposes only.
    that this is an exceptional break.
 
    :type: bool
-   :default: ``True``
+   :default: ``False``
+
+.. confval:: wait_for_key
+
+   This setting causes the programm to pause until the user
+   hits the enter key.
+
+   :type: bool
+   :default: ``False``

docs/source/playbook/commands/index.rst

@@ -215,6 +215,7 @@ The next pages will describe all possible commands in detail.
    father
    httpclient
    include
+   json
    loop
    mktemp
    msf-module

docs/source/playbook/commands/json.rst

@@ -0,0 +1,118 @@
+====
+json
+====
+
+Parse variables from a JSON file or from a variable (for example, ``RESULT_STDOUT``) that contains a valid JSON string.
+If the "local_path" option is used, the JSON is read directly from the specified file. The "cmd" option is optional. If "local_path" is defined, the "cmd" option will be ignored.
+If no "local_path" is set, the JSON is read from the "cmd" option. The variables are recursively parsed from the JSON input and saved in the variable store.
+The variables are recursively parsed from the json input and are saved as single variables in the variable store.
+Variable names are generated by concatenating keys at each level using an underscore (_) as a separator.
+If the lowest-level value is a list of primitives (e.g., strings, integers), the list is preserved as-is without further flattening.
+
+Example
+-------
+
+Given the following JSON input:
+
+.. code-block:: json
+
+    {
+      "first_list": [1, 2, 3],
+      "user": {
+        "name": "John Doe",
+        "age": 30,
+        "address": {
+          "street": "123 Main St",
+          "city": "New York",
+          "postal_codes": [10001, 10002]
+        },
+        "friends": [
+          {
+            "name": "Jane Smith",
+            "age": 28,
+            "address": {
+              "street": "456 Oak Rd",
+              "city": "Los Angeles",
+              "postal_codes": [90001, 90002]
+            }
+          },
+          {
+            "name": "Emily Davis",
+            "age": 35,
+            "address": {
+              "street": "789 Pine Ln",
+              "city": "Chicago",
+              "postal_codes": [60007, 60008]
+            }
+          }
+        ]
+      }
+    }
+
+The variables would be saved in the variable store as follows:
+
+.. code-block:: yaml
+
+    first_list: [1, 2, 3]
+    user_name: "John Doe"
+    user_age: 30
+    user_address_street: "123 Main St"
+    user_address_city: "New York"
+    user_address_postal_codes: [10001, 10002, 10003]
+    user_friends_0_name: "Jane Smith"
+    user_friends_0_age: 28
+    user_friends_0_address_street: "456 Oak Rd"
+    user_friends_0_address_city: "Los Angeles"
+    user_friends_0_address_postal_codes: [90001, 90002]
+    user_friends_1_name: "Emily Davis"
+    user_friends_1_age: 35
+    user_friends_1_address_street: "789 Pine Ln"
+    user_friends_1_address_city: "Chicago"
+    user_friends_1_address_postal_codes: [60007, 60008]
+
+Configuration
+-------------
+
+.. confval:: local_path
+
+   The JSON input to parse from. Valid input is a path to a JSON file. If "local_path" is set, the "cmd" option will be ignored.
+
+   :type: str
+   :required: False
+
+.. confval:: cmd
+
+   The JSON input to parse from. Valid input is a variable name from the variable store (without the leading ``$``) that contains a valid JSON string.
+
+   :type: str
+   :required: False
+
+   Either ``local_path`` OR ``cmd`` is required.
+
+.. confval:: varstore
+
+   If set to ``True``, logs the variable store before and after adding variables using the JSON command.
+
+   :type: bool
+   :required: False
+
+Examples
+--------
+
+.. code-block:: yaml
+
+    commands:
+      - type: json
+        local_path: "/path/to/samplefile.json"
+        varstore: True
+      - type: shell
+        cmd: |
+          cat <<EOF
+          {
+            "name": "Whiskers",
+            "favorite_toys": ["ball", "feather", "laser pointer"]
+          }
+          EOF
+      - type: json
+        cmd: RESULT_STDOUT
+        use_var: True

docs/source/playbook/commands/loop.rst

@@ -41,22 +41,40 @@ The current item is accessible as the `$LOOP_ITEM` variable.
 **Loop with range**:
 This mode iterates over a range of integers. The current index is accessible as the `$LOOP_INDEX` variable.
 
+**Loop until condition is fulfilled**
+This mode iterates indefinitely until the condition is fulfilled. (Checked before every command within the loop)
+Variables in cmd settings of an until loop command until($VAR1 == $VAR2) will be substituted from the variable store on every iteration of the loop.
+The current index/iteration of the loop is also accessible as the `$LOOP_INDEX` variable for the until() condition.
+
 .. confval:: cmd
 
-   The loop condition. This defines how the loop should iterate, either over a list or a range of values.
+   The loop condition. This defines how the loop should iterate, either over a list or a range of values, or idefinitely until the
+   condition defined in until() is rached.
 
    :type: str
+   :required: ``True``
 
    Examples:
 
    - **items(LISTA)**: Iterate over the elements of a list named `LISTA`.
    - **range(0, 10)**: Iterate over a range from 0 to 9.
+   - **until($PORT == 7)
+
+.. confval:: break_if
+
+   If defined, this condition is checked before every command in the loop.
+   If the condition evaluates to `True`, break out of the loop.
+   Supports the same operators as :confval:`only_if`.
+
+   :type: str
+   :required: ``False``
 
 .. confval:: commands
 
    The list of commands to execute during each iteration of the loop. These commands are executed once per iteration, with loop-specific variables (`$LOOP_ITEM` or `$LOOP_INDEX`) available for substitution.
 
    :type: list[Command]
+   :required: ``True``
 
    .. code-block:: yaml
 

docs/source/playbook/session/index.rst

@@ -4,8 +4,8 @@
 Sessions, Interactive
 =====================
 
-Many commands of AttackMate support the setting "session" or "interactive. 
-This chapter is about these important concepts of AttackMate. 
+Many commands of AttackMate support the setting "session" or "interactive.
+This chapter is about these important concepts of AttackMate.
 
 Session
 -------
@@ -65,4 +65,3 @@ Many commands work in such a way that they first execute something and then coll
 .. warning::
 
       Please note that you **MUST** send a newline when you execute interactive commands!
-

docs/source/playbook/vars.rst

@@ -31,6 +31,11 @@ $ATTACKMATE_FOO.
 
    For more information about using the variables see `string.Template <https://docs.python.org/3/library/string.html#string.Template>`_
 
+
+.. note::
+
+   variables in cmd settings of a loop command will be substituted on every iteration of the loop, see :ref:`loop`
+
 Builtin Variables
 =================
 

examples/includes/gather_commands.yml

@@ -23,4 +23,3 @@ commands:
     cmd: post/linux/gather/enum_protections
     options:
       SESSION: $GATHER_SESSION
-