Skip to content

Mark 0.1.0 #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 3, 2023
Merged

Mark 0.1.0 #133

merged 3 commits into from
Oct 3, 2023

Conversation

ColdHeat
Copy link
Member

@ColdHeat ColdHeat commented Oct 2, 2023

0.1.0 / 2023-10-03

Added

  • ctfcli has been separated into two main modules cli and core. The core module now packages logic previously found inside utils, wrapped into classes.
  • The classes in the core module will only print out warnings instead of interrupting the whole process. Everything else will throw exceptions which can be caught and handled however desired
  • cli and core internal modules have type hints
  • Improved error messages
  • Unit tests have been added for the entire core module
  • ctfcli will now ask to initialize a new project if one does not exist
  • Added --hidden to ctf challenge install which will deploy the challenge / challenges in a hidden state regardless of their challenge.yml value.
  • Added ctf challenge edit <name> and ctf challenge edit <name> --dockerfile to open challenge.yml or Dockerfile for that challenge
  • Added aliases under ctf templates and ctf plugins for dir (path) and for view (show)
  • Progress bars for ctf challenge deploy / ctf challenge install / ctf challenge sync
  • ctf challenge deploy will now deploy ALL deployable challenges if a specific challenge is not specified
    • For the SSH and Registry deployments, to facilitate this behaviour the challenge name will be automatically appended. So the host should be for example: registry://registry.example.com/example-project and the challenge name will be appended for a full location.
  • ctf challenge deploy will now also automatically login to the registry with Cloud and Registry deployments.
    • For cloud deployments the instance url must be ctfd assigned (e.g. example.ctfd.io) - this is because to log-in to the registry we require a username like [email protected]. The deployment will use the access token as the password.
    • For registry deployment it will look for the username and password keys inside a [registry] section in the project config file.
  • ctfcli will read a LOGLEVEL environment variable to enable DEBUG logging has been added

Fixed

  • When syncing a challenge to a remote instance, state specified in challenge.yml will now be ignored to prevent accidental challenge leaking
  • The CLI will now exit with a 0 if everything went right, and 1 if something went wrong.
    • With install/sync/deploy - exit code will be 1 if ANY of the challenges failed to install/sync/deploy.

Changed

  • Built using poetry and pyproject.toml
  • python-fire has been updated to 0.5.0

Removed

  • Removed the ctf challenge finalize command

@ColdHeat ColdHeat merged commit d00925d into master Oct 3, 2023
@ColdHeat ColdHeat deleted the mark-0.1.0 branch October 3, 2023 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant