Set up CTFd to track score about nord-juice-shop HOT 1 CLOSED

Notes

• If we decide to go for the hosted versions (as a service, e.g. MySQL and Redis as a service in Azure), we should define Bicep templates to facilitate for automated deployments.

Resources

• CTFd docs
• CTFd Github
• Guide on CTFd deployment in K8S (Google Cloud)
• Equinor CTFd deployment YAML
• CTFd docker-compose.yml

Tasks (WIP):

1. Determine approach:
   1. Helm chart:
      1. Use bman46/CTFd-Helm
      2. Override values.yml
         1. Identify values to override (e.g. passwords, etc.)
         2. Create ctfd.yml containing the values to override
         3. Define secret values to override using --set, such as --set redis.auth.password=$REDIS_PASS
   2. Manual in kubernetes:
      1. Configure a database: Set up a SQLAlchemy compatible database (MySQL preferred)

         • CTFd makes use of SQLAlchemy and as such supports a number of SQL databases. The recommended database type is MySQL. CTFd is tested with and has been installed against SQLite, Postgres, and MariaDB.

         • Can be deployed as a service (Azure), or as a pod in the K8s cluster (if we configure persistent storage).
      2. Configure a cache: Set up a Redis server

         • CTFd makes heavy use of caching servers to store configuration values, user sessions, and page content. It is important to deploy CTFd with a caching server. The preferred caching server option is Redis.

         • Can be deployed as a service (Azure), or as a pod in the K8S cluster.
      3. Configure CTFd k8s deployment:
         • Either use an existing Helm chart for CTFd, or
         • Define the required components as YAML, e.g. based on
           • Equinor CTFd
           • RD-CTF
           • GoJek CTFd
   3. Manual in e.g. Azure Container Instances
      • See CTFd Docs: Deployment
2. Implement spin-up/tear-down functionality in the deployment script:
   • Deploy & Destroy:
     • Spin-up: deploy_ctfd() (see here for an example)
     • Tear-down: destroy_ctfd() (see here for an example)
   • Configure INGRESS & TLS:
     • TLS: Add a host (see here for an example)
     • Ingress: Add a rule (see here for an example)
   • DNS:
     • Add record (see here for an example)
     • Remove record (see here for an example)

Requirements

• NGINX Ingress => CTFd => DB & Cache
• DNS name & TLS

from nord-juice-shop.