exploitfarm 1.7.9__tar.gz → 2.1.0__tar.gz

{exploitfarm-1.7.9/exploitfarm.egg-info → exploitfarm-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: exploitfarm
-Version: 1.7.9
+Version: 2.1.0
 Summary: Exploit Farm client
 Home-page: https://github.com/pwnzer0tt1/exploitfarm
 Author: Pwnzer0tt1
@@ -12,18 +12,18 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Requires-Dist: requests>=2.32.5
 Requires-Dist: urllib3>=2.5.0
-Requires-Dist: python-dateutil==2.9.0.post0
+Requires-Dist: python-dateutil>=2.9.0.post0
 Requires-Dist: pydantic>=2
 Requires-Dist: typing-extensions>=4.7.1
-Requires-Dist: fasteners==0.20
-Requires-Dist: toml==0.10.2
-Requires-Dist: psutil==7.2.1
-Requires-Dist: dirhash==0.5.0
-Requires-Dist: requests-toolbelt==1.0.0
-Requires-Dist: python-socketio[client]>=5.14.1
+Requires-Dist: fasteners>=0.20
+Requires-Dist: toml>=0.10.2
+Requires-Dist: psutil>=7.2.2
+Requires-Dist: dirhash>=0.5.0
+Requires-Dist: requests-toolbelt>=1.0.0
+Requires-Dist: python-socketio[asyncio_client]>=5.14.1
+Requires-Dist: aiohttp>=3.9.0
 Requires-Dist: textual>=3.0.0
 Requires-Dist: typer>=0.16
-Requires-Dist: xfarm
 Requires-Dist: platformdirs>=4.0
 Dynamic: author
 Dynamic: author-email
@@ -203,6 +203,14 @@ xfarm start [OPTIONS] PATH
 xfarm start ./my_exploit --pool-size 20 --test
 ```
 
+### Exploit Execution Environment
+
+To protect your exploit source code and maintain a clean workspace, exploits are never executed directly in their project directory. Instead, `xfarm` starts the execution by copying your exploit files into a temporary `__xfarm_run__` folder and runs the exploit from there. This guarantees:
+- **Clean Execution**: Your original directory isn't polluted by runtime artifacts, logs, or temporary files generated by the exploit.
+- **Isolation**: Changes made by the exploit script (e.g., dropping files, compiling binaries) remain isolated.
+
+A Git-like ignores system is available: You can use a `.ignore` (only in the root of the exploit folder) to specify files/directories that shouldn't be copied into the `__xfarm_run__` directory and when using `xfarm push`.
+
 ---
 
 ### **Configuration Commands**
@@ -273,7 +281,6 @@ xfarm init [OPTIONS]
 
 **Options**:
 
-- `--edit, -e`: Edit the configuration interactively.
 - `--name`: Exploit name.
 - `--service`: Associated service UUID.
 - `--language`: Programming language.
@@ -320,13 +327,55 @@ xfarm pull [OPTIONS]
 Download the exploit source:
 
 ```bash
-xfarm clone [OPTIONS]
+xfarm clone [OPTIONS] [exploit_id] [commit_uuid]
 ```
 
+**Arguments**:
+
+- `exploit_id`: The exploit ID to download.
+- `commit_uuid`: The commit UUID to take the source from (default: latest).
+
 **Options**:
 
 - `--folder, -f`: Specify target folder.
-- `--commit-uuid`: Commit ID (default: latest).
+
+#### **Edit Exploit Configuration**
+
+Edit the exploit configuration (e.g. language, service):
+
+```bash
+xfarm edit [OPTIONS]
+```
+
+**Options**:
+
+- `--name`: The name of the exploit.
+- `--service`: The service UUID of the exploit.
+- `--language`: The programming language of the exploit.
+
+#### **Checkout Exploit Commit**
+
+Download the specified exploit commit and switch to it:
+
+```bash
+xfarm checkout [OPTIONS] {commit_uuid}
+```
+
+**Options**:
+
+- `--force, -f`: Force the move even if the current commit is not pushed.
+
+#### **Flush Flag Queue**
+
+Flush the local flag queue to the backend (used if manual submissions were queued locally due to network failure):
+
+```bash
+xfarm flush [OPTIONS] [path]
+```
+
+**Options**:
+
+- `path`: Optional path to a specific directory or `.flag_queue.json` file.
 
 ---
 
@@ -343,6 +392,7 @@ xfarm group create [OPTIONS]
 **Options**:
 
 - `--name`: Group name.
+- `--submit-pool-timeout`: The timeout for the submit pool to wait for new attack results and send flags (default: 3).
 
 
 #### **Join Attack Group**
@@ -374,6 +424,55 @@ Shows a table with all existing groups, their IDs, and if there is a worker runn
 
 ---
 
+### **Template Commands**
+
+Manage exploit templates for quickly starting new exploits:
+
+#### **List Templates**
+
+```bash
+xfarm template list
+```
+
+#### **Add Template**
+
+Add a new template from an existing folder:
+
+```bash
+xfarm template add [path]
+```
+
+#### **Edit Template**
+
+Edit an existing template interactively:
+
+```bash
+xfarm template edit
+```
+
+---
+
+### **Submitter Commands**
+
+#### **Test Submitter**
+
+Test your submitter python script against the backend's flag extraction:
+
+```bash
+xfarm submitter-test [OPTIONS] {path} {output}
+```
+
+**Arguments**:
+
+- `path`: Submitter python script.
+- `output`: Text containing flags according to server REGEX.
+
+**Options**:
+
+- `--kwargs`: Submitter key-words args (json) (default: {}).
+
+---
+
 ## **Environment Variables**
 
 Environment variables can simplify configuration:

exploitfarm-1.7.9/PKG-INFO → exploitfarm-2.1.0/README.md

@@ -1,40 +1,3 @@
-Metadata-Version: 2.4
-Name: exploitfarm
-Version: 1.7.9
-Summary: Exploit Farm client
-Home-page: https://github.com/pwnzer0tt1/exploitfarm
-Author: Pwnzer0tt1
-Author-email: pwnzer0tt1@poliba.it
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-Requires-Dist: requests>=2.32.5
-Requires-Dist: urllib3>=2.5.0
-Requires-Dist: python-dateutil==2.9.0.post0
-Requires-Dist: pydantic>=2
-Requires-Dist: typing-extensions>=4.7.1
-Requires-Dist: fasteners==0.20
-Requires-Dist: toml==0.10.2
-Requires-Dist: psutil==7.2.1
-Requires-Dist: dirhash==0.5.0
-Requires-Dist: requests-toolbelt==1.0.0
-Requires-Dist: python-socketio[client]>=5.14.1
-Requires-Dist: textual>=3.0.0
-Requires-Dist: typer>=0.16
-Requires-Dist: xfarm
-Requires-Dist: platformdirs>=4.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
 # ExploitFarm Python Library and CLI
 
 **ExploitFarm** is an advanced tool designed to manage exploits and flag submissions in Attack-Defense CTF competitions. It combines a Python library with a command-line interface (CLI), providing flexibility and efficiency for managing CTF tasks. This documentation provides a comprehensive overview of its features, installation, and usage.
@@ -203,6 +166,14 @@ xfarm start [OPTIONS] PATH
 xfarm start ./my_exploit --pool-size 20 --test
 ```
 
+### Exploit Execution Environment
+
+To protect your exploit source code and maintain a clean workspace, exploits are never executed directly in their project directory. Instead, `xfarm` starts the execution by copying your exploit files into a temporary `__xfarm_run__` folder and runs the exploit from there. This guarantees:
+- **Clean Execution**: Your original directory isn't polluted by runtime artifacts, logs, or temporary files generated by the exploit.
+- **Isolation**: Changes made by the exploit script (e.g., dropping files, compiling binaries) remain isolated.
+
+A Git-like ignores system is available: You can use a `.ignore` (only in the root of the exploit folder) to specify files/directories that shouldn't be copied into the `__xfarm_run__` directory and when using `xfarm push`.
+
 ---
 
 ### **Configuration Commands**
@@ -273,7 +244,6 @@ xfarm init [OPTIONS]
 
 **Options**:
 
-- `--edit, -e`: Edit the configuration interactively.
 - `--name`: Exploit name.
 - `--service`: Associated service UUID.
 - `--language`: Programming language.
@@ -320,13 +290,55 @@ xfarm pull [OPTIONS]
 Download the exploit source:
 
 ```bash
-xfarm clone [OPTIONS]
+xfarm clone [OPTIONS] [exploit_id] [commit_uuid]
 ```
 
+**Arguments**:
+
+- `exploit_id`: The exploit ID to download.
+- `commit_uuid`: The commit UUID to take the source from (default: latest).
+
 **Options**:
 
 - `--folder, -f`: Specify target folder.
-- `--commit-uuid`: Commit ID (default: latest).
+
+#### **Edit Exploit Configuration**
+
+Edit the exploit configuration (e.g. language, service):
+
+```bash
+xfarm edit [OPTIONS]
+```
+
+**Options**:
+
+- `--name`: The name of the exploit.
+- `--service`: The service UUID of the exploit.
+- `--language`: The programming language of the exploit.
+
+#### **Checkout Exploit Commit**
+
+Download the specified exploit commit and switch to it:
+
+```bash
+xfarm checkout [OPTIONS] {commit_uuid}
+```
+
+**Options**:
+
+- `--force, -f`: Force the move even if the current commit is not pushed.
+
+#### **Flush Flag Queue**
+
+Flush the local flag queue to the backend (used if manual submissions were queued locally due to network failure):
+
+```bash
+xfarm flush [OPTIONS] [path]
+```
+
+**Options**:
+
+- `path`: Optional path to a specific directory or `.flag_queue.json` file.
 
 ---
 
@@ -343,6 +355,7 @@ xfarm group create [OPTIONS]
 **Options**:
 
 - `--name`: Group name.
+- `--submit-pool-timeout`: The timeout for the submit pool to wait for new attack results and send flags (default: 3).
 
 
 #### **Join Attack Group**
@@ -374,6 +387,55 @@ Shows a table with all existing groups, their IDs, and if there is a worker runn
 
 ---
 
+### **Template Commands**
+
+Manage exploit templates for quickly starting new exploits:
+
+#### **List Templates**
+
+```bash
+xfarm template list
+```
+
+#### **Add Template**
+
+Add a new template from an existing folder:
+
+```bash
+xfarm template add [path]
+```
+
+#### **Edit Template**
+
+Edit an existing template interactively:
+
+```bash
+xfarm template edit
+```
+
+---
+
+### **Submitter Commands**
+
+#### **Test Submitter**
+
+Test your submitter python script against the backend's flag extraction:
+
+```bash
+xfarm submitter-test [OPTIONS] {path} {output}
+```
+
+**Arguments**:
+
+- `path`: Submitter python script.
+- `output`: Text containing flags according to server REGEX.
+
+**Options**:
+
+- `--kwargs`: Submitter key-words args (json) (default: {}).
+
+---
+
 ## **Environment Variables**
 
 Environment variables can simplify configuration:

{exploitfarm-1.7.9 → exploitfarm-2.1.0}/exploitfarm/__init__.py

@@ -1,5 +1,5 @@
 def _get_version():
-    v = "1.7.9" if "{" not in "1.7.9" else "0.0.0"
+    v = "2.1.0" if "{" not in "2.1.0" else "0.0.0"
     if v == "0.0.0":
         import os
         env_v = os.getenv("EXPLOITFARM_VERSION")

{exploitfarm-1.7.9 → exploitfarm-2.1.0}/exploitfarm/_init_exposed.py

@@ -1,24 +1,18 @@
-import requests
+from __future__ import annotations
+
 import functools
 import random
 import os
-from exploitfarm.utils.config import ClientConfig
-from exploitfarm.tui.config import inital_config_setup
-from exploitfarm.tui.login import login_required
 from enum import Enum
-import psutil
 import traceback
 import pickle
-from exploitfarm.utils import DEV_MODE
 from posixpath import join as urljoin
-from exploitfarm.utils.reqs import (
-    requests_check_json,
-    HTTP_TIMEOUT,
-    check_req,
-    get_session,
-)
-from requests import Session
 import re
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    import requests
+    from requests import Session
 
 os_windows = os.name == "nt"
 os_unix = os.name == "posix"
@@ -39,6 +33,7 @@ class Prio(Enum):
 
 def nicenessify(priority: Prio = Prio.low, pid: int | None = None):
     try:
+        import psutil
         pid = os.getpid() if pid is None else pid
         ps = psutil.Process(pid)
         if not isinstance(priority, Prio):
@@ -67,12 +62,16 @@ def nicenessify(priority: Prio = Prio.low, pid: int | None = None):
                     nice_value = psutil.BELOW_NORMAL_PRIORITY_CLASS
         ps.nice(nice_value)
     except Exception as e:
+        from exploitfarm.utils import DEV_MODE
         error = traceback.format_exc() if DEV_MODE else ""
         print(f"Error setting priority: {e} {error}")
         pass
 
 
 def get_config():
+    from exploitfarm.utils.config import ClientConfig
+    from exploitfarm.tui.config import inital_config_setup
+    from exploitfarm.tui.login import login_required
     config = ClientConfig.read()
     if not inital_config_setup(config):
         raise ValueError("It's required to setup the client first")
@@ -137,6 +136,7 @@ def session(
         "Accept-Language": "en-GB,en;q=0.8,it;q=0.7,en-US;q=0.6",
         **additional_headers,
     }
+    import requests
     s = requests.Session()
     s.headers.update(headers)
     return s
@@ -155,7 +155,9 @@ class Store:
         if not self.exploit_id:
             raise ValueError("this exploit has to be run with xfarm")
         self.login_token = os.getenv("XFARM_LOGIN_TOKEN", None)
-        self.session: Session = get_session(self.login_token)
+        self.default_context_id = default_context_id
+        from exploitfarm.utils.reqs import get_session
+        self.session = get_session(self.login_token)
         if default_context_id is not None:
             self._keycheck(default_context_id, "default_context_id")
         self.default_context_id = default_context_id
@@ -168,6 +170,14 @@ class Store:
             return self.default_context_id
         return None
 
+    def _requests_check_json(self, *args, **kwargs):
+        from exploitfarm.utils.reqs import requests_check_json
+        return requests_check_json(*args, **kwargs)
+
+    def _check_req(self, *args, **kwargs):
+        from exploitfarm.utils.reqs import check_req
+        return check_req(*args, **kwargs)
+
     def _keycheck(self, key: str, what: str = "key"):
         if not isinstance(key, str):
             raise ValueError(f"{what} must be a string")
@@ -176,7 +186,7 @@ class Store:
         if not re.match(r"^[A-Za-z0-9\-\._~()'!*:@,;]+$", key):
             raise ValueError(rf"{what} must match this regex: ^[A-Za-z0-9\-\._~()'!*:@,;$]+$")
 
-    def get_bytes(self, key: str, default=None, context_id: str | None = None, timeout: int = HTTP_TIMEOUT) -> bytes:
+    def get_bytes(self, key: str, default=None, context_id: str | None = None, timeout: int = 30) -> bytes:
         context_id = self._get_context_id(context_id)
         self._keycheck(key)
         r = self.session.get(
@@ -186,9 +196,9 @@ class Store:
         )
         if r.status_code == 404:
             return default
-        return check_req(r).content
+        return self._check_req(r).content
 
-    def get(self, key: str, default=None, context_id: str | None = None, timeout: int = HTTP_TIMEOUT) -> bytes:
+    def get(self, key: str, default=None, context_id: str | None = None, timeout: int = 30) -> bytes:
         class TmpNotFound:
             pass
         data = self.get_bytes(key, context_id=context_id, default=TmpNotFound, timeout=timeout)
@@ -196,10 +206,10 @@ class Store:
             return default
         return pickle.loads(data)
 
-    def set_bytes(self, key: str, value: bytes, context_id: str | None = None, timeout: int = HTTP_TIMEOUT):
+    def set_bytes(self, key: str, value: bytes, context_id: str | None = None, timeout: int = 30):
         self._keycheck(key)
         context_id = self._get_context_id(context_id)
-        return requests_check_json(
+        return self._requests_check_json(
             self.session.put(
                 urljoin(self.base_url, f"exploits/{self.exploit_id}/store/key/{key}"),
                 data=value,
@@ -209,14 +219,14 @@ class Store:
             )
         )
 
-    def set(self, key: str, value, context_id: str | None = None, timeout: int = HTTP_TIMEOUT):
+    def set(self, key: str, value, context_id: str | None = None, timeout: int = 30):
         value = pickle.dumps(value)
         return self.set_bytes(key, value, context_id=context_id, timeout=timeout)
 
-    def delete(self, key: str, context_id: str | None = None, timeout: int = HTTP_TIMEOUT):
+    def delete(self, key: str, context_id: str | None = None, timeout: int = 30):
         self._keycheck(key)
         context_id = self._get_context_id(context_id)
-        return requests_check_json(
+        return self._requests_check_json(
             self.session.delete(
                 urljoin(self.base_url, f"exploits/{self.exploit_id}/store/key/{key}"),
                 params={"context_id": context_id} if context_id else None,
@@ -224,9 +234,9 @@ class Store:
             )
         )
 
-    def keys(self, timeout: int = HTTP_TIMEOUT, context_id: str | None = None) -> list[str]:
+    def keys(self, timeout: int = 30, context_id: str | None = None) -> list[str]:
         context_id = self._get_context_id(context_id)
-        return requests_check_json(
+        return self._requests_check_json(
             self.session.get(
                 urljoin(self.base_url, f"exploits/{self.exploit_id}/store/keys"),
                 params={ "context_id": context_id } if context_id else None,
@@ -234,20 +244,20 @@ class Store:
             )
         )
 
-    def contexts(self, timeout: int = HTTP_TIMEOUT) -> list[str]:
-        return requests_check_json(
+    def contexts(self, timeout: int = 30) -> list[str]:
+        return self._requests_check_json(
             self.session.get(
                 urljoin(self.base_url, f"exploits/{self.exploit_id}/store/contexts"),
                 timeout=timeout,
             )
         )
 
-    def delete_context(self, context_id: str | None = None, timeout: int = HTTP_TIMEOUT):
+    def delete_context(self, context_id: str | None = None, timeout: int = 30):
         context_id = self._get_context_id(context_id)
         if not context_id:
             raise ValueError("context_id must be provided to delete it")
         self._keycheck(context_id, "context_id")
-        return requests_check_json(
+        return self._requests_check_json(
             self.session.delete(
                 urljoin(self.base_url, f"exploits/{self.exploit_id}/store/context/{context_id}"),
                 timeout=timeout,