feat: allow specifying access_token as an env var (#179)

* feat: allow specifying access_token as an env var

* Allow specifying URL via envvar update token envvar name

* Show error if instance URL not configured

* update upload-artifact version

---------

Co-authored-by: Kevin Chung <[email protected]>

Author: VaiTon

.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

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/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