|
| 1 | +# 3.0.0 / 2020-07-27 |
| 2 | + |
| 3 | +## Changelog Summary |
| 4 | + |
| 5 | +The CTFd v3 Changelog represents the changes from v2.5.0 to v3. It is a summarized version of the changes that occured in all CTFd v3 beta/alpha releases. |
| 6 | + |
| 7 | +CTFd v3 contains some breaking changes but many plugins remain compatible. Themes will need some minor changes to be compatible with v3. |
| 8 | + |
| 9 | +These changes are made with great consideration to existing installations and for the health of the overall CTFd project. If you rely on specific behavior, you can always download the last CTFd v2 release on Github. Official plugin/theme updates will be sent to the email addresses on file. |
| 10 | + |
| 11 | +The major changes in CTFd v3 are as follows with the detailed changelog beneath: |
| 12 | + |
| 13 | +- ### Server Side HTML/Markdown Rendering |
| 14 | + |
| 15 | +HTML rendering in some cases (challenge description rendering, hint content rendering) has been moved to the server side. Previously it was rendered by the browser but this led to a lot of duplicated behavior and complexity in some plugins. Rendering that HTML content on the server allows CTFd to take more advantage of theme content and reduce duplicated code across themes. |
| 16 | + |
| 17 | +In addition, HTML sanitization can be enabled on the CTFd installation to prevent the injection of malicious scripts in HTML content. |
| 18 | + |
| 19 | +- ### CommonMark |
| 20 | + |
| 21 | +CTFd now uses [CommonMark](https://commonmark.org/) for HTML/Markdown rendering. This leads to much more consistent rendering of HTML/Markdown content. |
| 22 | + |
| 23 | +In some cases, this can break your HTML output. You can use our [development testing script](https://gist.github.com/ColdHeat/085c47359ab86c18864135a198cbe505) to check if your HTML output will change and correct it accordingly. |
| 24 | + |
| 25 | +- ### Forms, Nonces, Sessions |
| 26 | + |
| 27 | +CTFd no longer directly injects values into the global session object for a theme. You may have used this as `{{ nonce }}` or `{{ id }}`. Instead these values should be accessed via the `Session` global as so: `{{ Session.nonce }}`. |
| 28 | + |
| 29 | +All of the public facing forms in CTFd have been converted to form globals with WTForms. You can access them via the `Form` global in Jinja. For example, `{{ Forms.auth.LoginForm() }}`. A `{{ form.nonce() }}` function is available on all forms for easier access to the CSRF nonce as well. |
| 30 | + |
| 31 | +Old forms will still work if the nonce used in the form is updated to `{{ Session.nonce }}`. |
| 32 | + |
| 33 | +Values provided by configuration and plugins can now be accessed via the `Configs` and `Plugins` globals. For example `{{ Configs.ctf_name }}` and `{{ Plugins.scripts }}`. See the `base.html` file of the core theme to get an idea of how to use these values. |
| 34 | + |
| 35 | +- ### Challenge Type Plugin Enhancements |
| 36 | + |
| 37 | +Challenge type plugins now have better re-useability with the rest of CTFd. Plugin code no longer needs to copy unchanged methods over from the base challenge plugin classes. |
| 38 | + |
| 39 | +In addition, challenge HTML is now rendered on the server side using a new `challenge.html` file provided by the current theme. This means that the theme effectively controls how a challenge should look overall, but the challenge plugin controls the overall content. |
| 40 | + |
| 41 | +- ### Python 3 |
| 42 | + |
| 43 | +CTFd v3 is Python 3 only. |
| 44 | + |
| 45 | +- ### Docker image based on Debian |
| 46 | + |
| 47 | +The Docker image used in CTFd is now based on Debian. |
| 48 | + |
| 49 | +- ### config.ini |
| 50 | + |
| 51 | +Instead of editting `config.py` directly, it's now a better idea to edit `config.ini` or provide your configuration via environment variables |
| 52 | + |
| 53 | +## Detailed Changelog |
| 54 | + |
| 55 | +**General** |
| 56 | + |
| 57 | +- CTFd is now Python 3 only |
| 58 | +- Render markdown with the CommonMark spec provided by `cmarkgfm` |
| 59 | +- HTML/Markdown content is now rendered on the server side in most cases. |
| 60 | + - This includes challenge descriptions, hint content, and page content |
| 61 | +- Ability to render markdown stripped of any malicious JavaScript or HTML. |
| 62 | + - Controlled via the `HTML_SANITIZATION` server side configuration value |
| 63 | +- Inject `Config`, `User`, `Team`, `Session`, and `Plugin` globals into Jinja |
| 64 | +- User sessions no longer store any user-specific attributes. |
| 65 | + - Sessions only store the user's ID, CSRF nonce, and an hmac of the user's password |
| 66 | + - This allows for session invalidation on password changes |
| 67 | +- The user facing side of CTFd now has user and team searching |
| 68 | +- Accept additional profile fields during registration (affiliation, website, country) |
| 69 | + - This does not add additional inputs. Themes or additional JavaScript can add the form inputs. |
| 70 | + |
| 71 | +**Admin Panel** |
| 72 | + |
| 73 | +- Use EasyMDE as an improved description/text editor for Markdown enabled fields. |
| 74 | +- Media Library button now integrated into EasyMDE enabled fields |
| 75 | +- VueJS now used as the underlying implementation for the Media Library |
| 76 | +- Fix setting theme color in Admin Panel |
| 77 | +- Green outline border has been removed from the Admin Panel |
| 78 | +- GeoIP support now available for converting IP addresses to guessed countries |
| 79 | +- Redesign the challenge creation form to use a radio button with challenge type selection instead of a select input |
| 80 | + |
| 81 | +**API** |
| 82 | + |
| 83 | +- Significant overhauls in API documentation provided by Swagger UI and Swagger json |
| 84 | +- Make almost all API endpoints provide filtering and searching capabilities |
| 85 | +- Change `GET /api/v1/config/<config_key>` to return structured data according to ConfigSchema |
| 86 | +- Admins can no longer ban themselves through `PATCH /api/v1/users/[user_id]` |
| 87 | +- Add `html` item for `GET /api/v1/hints/[hint_id]` which contains the rendered HTML of the Hint content |
| 88 | +- Remove `content` from `GET /api/v1/hints` |
| 89 | + |
| 90 | +**Themes** |
| 91 | + |
| 92 | +- Themes now have access to the `Configs` global which provides wrapped access to `get_config`. |
| 93 | + - For example, `{{ Configs.ctf_name }}` instead of `get_ctf_name()` or `get_config('ctf_name')` |
| 94 | +- Themes must now specify a `challenge.html` which control how a challenge should look. |
| 95 | +- The main library for charts has been changed from Plotly to Apache ECharts. |
| 96 | +- Forms have been moved into wtforms for easier form rendering inside of Jinja. |
| 97 | + - From Jinja you can access forms via the Forms global i.e. `{{ Forms }}` |
| 98 | + - This allows theme developers to more easily re-use a form without having to copy-paste HTML. |
| 99 | +- Themes can now provide a theme settings JSON blob which can be injected into the theme with `{{ Configs.theme_settings }}` |
| 100 | +- Core theme now includes the challenge ID in location hash identifiers to always refer the right challenge despite duplicate names |
| 101 | +- Spinner centering has been switched from a hard coded margin in CSS to flexbox CSS classes from Bootstrap |
| 102 | + |
| 103 | +**Plugins** |
| 104 | + |
| 105 | +- Challenge plugins have changed in structure to better allow integration with themes and prevent obtrusive Javascript/XSS. |
| 106 | + - Challenge rendering now uses `challenge.html` from the provided theme. |
| 107 | + - Accessing the challenge view content is now provided by `/api/v1/challenges/<challenge_id>` in the `view` section. This allows for HTML to be properly sanitized and rendered by the server allowing CTFd to remove client side Jinja rendering. |
| 108 | + - `challenge.html` now specifies what's required and what's rendered by the theme. This allows the challenge plugin to avoid having to deal with aspects of the challenge besides the description and input. |
| 109 | + - A more complete migration guide will be provided when CTFd v3 leaves beta |
| 110 | +- Display current attempt count in challenge view when max attempts is enabled |
| 111 | +- `get_standings()`, `get_team_stanadings()`, `get_user_standings()` now has a fields keyword argument that allows for specificying additional fields that SQLAlchemy should return when building the response set. |
| 112 | + - Useful for gathering additional data when building scoreboard pages |
| 113 | +- Flags can now control the message that is shown to the user by raising `FlagException` |
| 114 | +- Fix `override_template()` functionality |
| 115 | + |
| 116 | +**Deployment** |
| 117 | + |
| 118 | +- Enable SQLAlchemy's `pool_pre_ping` by default to reduce the likelihood of database connection issues |
| 119 | +- Mailgun email settings are now deprecated. Admins should move to SMTP email settings instead. |
| 120 | +- Postgres is now considered a second class citizen in CTFd. It is tested against but not a main database backend. If you use Postgres, you are entirely on your own with regards to supporting CTFd. |
| 121 | +- Docker image now uses Debian instead of Alpine. See https://github.com/CTFd/CTFd/issues/1215 for rationale. |
| 122 | +- `docker-compose.yml` now uses a non-root user to connect to MySQL/MariaDB |
| 123 | +- `config.py` should no longer be editting for configuration, instead edit `config.ini` or the environment variables in `docker-compose.yml` |
| 124 | + |
| 125 | +**Miscellaneous** |
| 126 | + |
| 127 | +- Fix an issue where email sending would be broken if the CTF name contained a colon |
| 128 | +- Lint Markdown files with Prettier |
| 129 | +- Lint Dockerfile and docker-compose.yml in Github Actions |
| 130 | +- Lint JavaScript files with eslint |
| 131 | +- Certain static strings have been converted into Enums for better re-useability throughout the code base |
| 132 | +- Switch to using Github Actions for testing and linting |
| 133 | +- Better handling of missing challenge types. Missing challenge types no longer bring down all other challenges. |
| 134 | +- Documentation has been seperated out into a seperate repo (https://github.com/CTFd/docs). |
| 135 | +- Documentation hosting has moved from ReadTheDocs to Netlify |
| 136 | +- Any links in the codebase to help.ctfd.io have been changed to docs.ctfd.io. |
| 137 | + |
1 | 138 | # 3.0.0b3 / 2020-07-22 |
2 | 139 |
|
3 | 140 | **General** |
|
0 commit comments