Merge branch 'master' of github.com:CTFd/ctfcli

Author: ColdHeat

.github/workflows/release.yml

@@ -33,7 +33,7 @@ jobs:
       - name: Build package
         run: poetry build
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           path: |
            ./dist/*.tar.gz

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
 
     name: Testing
     steps:

ctfcli/__main__.py

@@ -16,7 +16,11 @@
 from ctfcli.cli.pages import PagesCommand
 from ctfcli.cli.plugins import PluginsCommand
 from ctfcli.cli.templates import TemplatesCommand
-from ctfcli.core.exceptions import ProjectNotInitialized
+from ctfcli.core.exceptions import (
+    MissingAPIKey,
+    MissingInstanceURL,
+    ProjectNotInitialized,
+)
 from ctfcli.core.plugins import load_plugins
 from ctfcli.utils.git import check_if_dir_is_inside_git_repo
 
@@ -148,6 +152,14 @@ def main():
         if isinstance(ret, int):
             sys.exit(ret)
 
+    except MissingInstanceURL as e:
+        click.secho(e, fg="red")
+        sys.exit(1)
+
+    except MissingAPIKey as e:
+        click.secho(e, fg="red")
+        sys.exit(1)
+
     except ProjectNotInitialized:
         if click.confirm(
             "Outside of a ctfcli project, would you like to start a new project in this directory?",

ctfcli/core/api.py

@@ -3,15 +3,23 @@
 from requests import Session
 
 from ctfcli.core.config import Config
+from ctfcli.core.exceptions import MissingAPIKey, MissingInstanceURL
 
 
 class API(Session):
     def __init__(self):
         config = Config()
 
         # Load required configuration values
-        self.url = config["config"]["url"]
-        self.access_token = config["config"]["access_token"]
+        try:
+            self.url = config["config"]["url"]
+        except KeyError:
+            raise MissingInstanceURL()
+
+        try:
+            self.access_token = config["config"]["access_token"]
+        except KeyError:
+            raise MissingAPIKey()
 
         # Handle SSL verification disabling
         try:

ctfcli/core/config.py

@@ -10,6 +10,11 @@
 
 
 class Config:
+    _env_vars = {
+        "CTFCLI_ACCESS_TOKEN": "access_token",
+        "CTFCLI_URL": "url",
+    }
+
     def __init__(self):
         self.base_path = self.get_base_path()
         self.project_path = self.get_project_path()
@@ -26,6 +31,24 @@ def __init__(self):
         self.config = parser
         self.challenges = dict(self.config["challenges"])
 
+        # Load environment variables
+        self._env_overrides()
+
+    def _env_overrides(self):
+        """
+        For each environment variable specified in _env_vars, check if it exists
+        and if so, add it to the config under the "config" section.
+        """
+        for env_var, config_key in self._env_vars.items():
+            env_value = os.getenv(env_var)
+            if not env_value:
+                continue
+
+            if not self.config.has_section("config"):
+                self.config.add_section("config")
+
+            self.config["config"][config_key] = env_value
+
     def __getitem__(self, key):
         return self.config[key]
 

ctfcli/core/deployment/cloud.py

@@ -5,6 +5,7 @@
 from urllib.parse import urlparse
 
 import click
+from slugify import slugify
 
 from ctfcli.core.api import API
 from ctfcli.core.config import Config
@@ -118,7 +119,8 @@ def _get_or_create_service(self, image_location: str):
                 return self.api.get(f"/api/v1/services/{service_data['id']}").json()["data"]
 
         # Create the service if it doesn't exist
-        return self.api.post("/api/v1/services", json={"name": self.image_name, "image": image_location}).json()["data"]
+        image_name_slug = slugify(self.image_name)
+        return self.api.post("/api/v1/services", json={"name": image_name_slug, "image": image_location}).json()["data"]
 
     def _await_service_deployment(self, service_data, interval=10, timeout=180) -> Optional[Dict]:
         service_id = service_data["id"]

ctfcli/core/exceptions.py

@@ -3,6 +3,22 @@
 import click
 
 
+class MissingAPIKey(Exception):
+    def __str__(self):
+        return (
+            "Missing API key. "
+            "Please set the API key in your configuration file or set the CTFCLI_ACCESS_TOKEN environment variable."
+        )
+
+
+class MissingInstanceURL(Exception):
+    def __str__(self):
+        return (
+            "Missing CTFd instance URL. "
+            "Please set the instance URL in your configuration file or set the CTFCLI_URL environment variable."
+        )
+
+
 class ProjectNotInitialized(Exception):
     pass
 

poetry.lock

@@ -2,7 +2,7 @@
 
 
 def replace_symlinks():
-    os.system("""find . -type l -exec sh -c 'target=$(readlink -f "$0"); rm "$0" && cp "$target" "$0"' {} \;""")
+    os.system("""find . -type l -exec sh -c 'target=$(readlink -f "$0"); rm "$0" && cp "$target" "$0"' {} \\;""")
 
 
 if __name__ == "__main__":

preprocess.py

@@ -22,8 +22,9 @@ click = "^8.1.7"
 cookiecutter = "^2.3.0"
 appdirs = "^1.4.4"
 colorama = "^0.4.6"
-fire = "^0.5.0"
+fire = "^0.7.0"
 typing-extensions = "^4.7.1"
+python-slugify = "^8.0.4"
 
 [tool.poetry.group.dev.dependencies]
 black = "^23.7.0"