Add healthcheck command and configuration (#77)

* Add `healthcheck` key in `challenge.yml` to specify a healthcheck script
* Add `ctf challenge healthcheck [challenge_name]`
* Closes #75

Author: ColdHeat

ctfcli/cli/challenges.py

@@ -1,5 +1,6 @@
 import os
 import subprocess
+import sys
 from pathlib import Path
 from urllib.parse import urlparse
 
@@ -11,6 +12,7 @@
     create_challenge,
     lint_challenge,
     load_challenge,
+    load_installed_challenge,
     load_installed_challenges,
     sync_challenge,
 )
@@ -353,3 +355,56 @@ def push(self, challenge=None):
             click.echo(
                 "Couldn't process that challenge path. Please check that the challenge is added to .ctf/config and that your path matches."
             )
+
+    def healthcheck(self, challenge):
+        config = load_config()
+        challenges = config["challenges"]
+
+        # challenge_path = challenges[challenge]
+        path = Path(challenge)
+        if path.name.endswith(".yml") is False:
+            path = path / "challenge.yml"
+
+        challenge = load_challenge(path)
+        click.secho(f'Loaded {challenge["name"]}', fg="yellow")
+        try:
+            healthcheck = challenge["healthcheck"]
+        except KeyError:
+            click.secho(f'{challenge["name"]} missing healthcheck parameter', fg="red")
+            return
+
+        # Get challenges installed from CTFd and try to find our challenge
+        installed_challenges = load_installed_challenges()
+        target = None
+        for c in installed_challenges:
+            if c["name"] == challenge["name"]:
+                target = c
+                break
+        else:
+            click.secho(
+                f'Couldn\'t find challenge {c["name"]} on CTFd', fg="red",
+            )
+            return
+
+        # Get the actual challenge data
+        installed_challenge = load_installed_challenge(target["id"])
+        connection_info = installed_challenge["connection_info"]
+
+        # Run healthcheck
+        if connection_info:
+            rcode = subprocess.call(
+                [healthcheck, "--connection-info", connection_info], cwd=path.parent
+            )
+        else:
+            rcode = subprocess.call([healthcheck], cwd=path.parent)
+
+        if rcode != 0:
+            click.secho(
+                f"Healcheck failed", fg="red",
+            )
+            sys.exit(1)
+        else:
+            click.secho(
+                f"Success", fg="green",
+            )
+            sys.exit(0)

ctfcli/spec/challenge-example.yml

@@ -36,6 +36,11 @@ host: null
 # connection_info is used to provide a link, hostname, or instructions on how to connect to a challenge
 connection_info: nc hostname 12345
 
+# healthcheck is a tool/script used to check a challenge
+# If connection_info was provided to CTFd when the challenge was installed, it will be passed to the healthcheck script:
+# ./writeup/exploit.sh --connection-info "nc hostname 12345"
+healthcheck: writeup/exploit.sh
+
 # Can be removed if unused
 attempts: 5
 

ctfcli/utils/challenge.py

@@ -23,6 +23,11 @@ def load_challenge(path):
         return
 
 
+def load_installed_challenge(challenge_id):
+    s = generate_session()
+    return s.get(f"/api/v1/challenges/{challenge_id}", json=True).json()["data"]
+
+
 def load_installed_challenges():
     s = generate_session()
     return s.get("/api/v1/challenges?view=admin", json=True).json()["data"]